diff --git a/karavan-space/public/metadata/components.json b/karavan-space/public/metadata/components.json index 1e5d4f32653..9b9844a953b 100644 --- a/karavan-space/public/metadata/components.json +++ b/karavan-space/public/metadata/components.json @@ -1,697 +1,697 @@ [ -{"component":{"kind":"component","name":"activemq","title":"ActiveMQ 5.x","description":"Send messages to (or consume from) Apache ActiveMQ 5.x. This component extends the Camel JMS component.","deprecated":false,"firstVersion":"1.0.0","label":"messaging","javaType":"org.apache.camel.component.activemq.ActiveMQComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-activemq","version":"4.8.1","scheme":"activemq","extendsScheme":"jms","syntax":"activemq:destinationType:destinationName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJmsDestination":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION"},"CamelJmsDestinationName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic to use as destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME"},"CamelJMSDestinationProduced":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic the message was sent to.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME_PRODUCED"},"JMSXGroupID":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS group ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_X_GROUP_ID"},"JMSMessageID":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS unique message ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_MESSAGE_ID"},"JMSCorrelationID":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID"},"JMSCorrelationIDAsBytes":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID as bytes.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID_AS_BYTES"},"JMSDeliveryMode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS delivery mode.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DELIVERY_MODE"},"JMSDestination":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DESTINATION"},"JMSExpiration":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS expiration.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_EXPIRATION"},"JMSPriority":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS priority (with 0 as the lowest priority and 9 as the highest).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_PRIORITY"},"JMSRedelivered":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is the JMS message redelivered.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REDELIVERED"},"JMSTimestamp":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS timestamp.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TIMESTAMP"},"JMSReplyTo":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS reply-to destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REPLY_TO"},"JMSType":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TYPE"},"JMSXUserID":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XUser id.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_XUSER_ID"},"CamelJmsMessageType":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text","Blob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_MESSAGE_TYPE"},"CamelJmsRequestTimeout":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"20_000","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_REQUEST_TIMEOUT"}},"properties":{"destinationType":{"index":0,"kind":"path","displayName":"Destination Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["queue","topic","temp-queue","temp-topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"queue","description":"The kind of destination to use"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the queue or topic to use as destination"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions with JMS 1.1."},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"","required":false,"type":"object","javaType":"jakarta.jms.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"disableReplyTo":{"index":4,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."},"durableSubscriptionName":{"index":5,"kind":"parameter","displayName":"Durable Subscription Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."},"jmsMessageType":{"index":6,"kind":"parameter","displayName":"Jms Message Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to force the use of a specific jakarta.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it."},"replyTo":{"index":7,"kind":"parameter","displayName":"Reply To","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)."},"testConnectionOnStartup":{"index":8,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"acknowledgementModeName":{"index":9,"kind":"parameter","displayName":"Acknowledgement Mode Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["SESSION_TRANSACTED","CLIENT_ACKNOWLEDGE","AUTO_ACKNOWLEDGE","DUPS_OK_ACKNOWLEDGE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO_ACKNOWLEDGE","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"},"artemisConsumerPriority":{"index":10,"kind":"parameter","displayName":"Artemis Consumer Priority","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Consumer priorities allow you to ensure that high priority consumers receive messages while they are active. Normally, active consumers connected to a queue receive messages from it in a round-robin fashion. When consumer priorities are in use, messages are delivered round-robin if multiple active consumers exist with the same high priority. Messages will only going to lower priority consumers when the high priority consumers do not have credit available to consume the message, or those high priority consumers have declined to accept the message (for instance because it does not meet the criteria of any selectors associated with the consumer)."},"asyncConsumer":{"index":11,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."},"autoStartup":{"index":12,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer container should auto-startup."},"cacheLevel":{"index":13,"kind":"parameter","displayName":"Cache Level","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details."},"cacheLevelName":{"index":14,"kind":"parameter","displayName":"Cache Level Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CACHE_AUTO","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information."},"concurrentConsumers":{"index":15,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"maxConcurrentConsumers":{"index":16,"kind":"parameter","displayName":"Max Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"replyToDeliveryPersistent":{"index":17,"kind":"parameter","displayName":"Reply To Delivery Persistent","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use persistent delivery by default for replies."},"selector":{"index":18,"kind":"parameter","displayName":"Selector","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS selector to use"},"subscriptionDurable":{"index":19,"kind":"parameter","displayName":"Subscription Durable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well."},"subscriptionName":{"index":20,"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.jms.JmsConfiguration","configurationField":"configuration","description":"Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0)."},"subscriptionShared":{"index":21,"kind":"parameter","displayName":"Subscription Shared","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker."},"acceptMessagesWhileStopping":{"index":22,"kind":"parameter","displayName":"Accept Messages While Stopping","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option, if you start and stop JMS routes at runtime, while there are still messages enqueued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected, and the JMS broker would have to attempt redeliveries, which yet again may be rejected, and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option."},"allowReplyManagerQuickStop":{"index":23,"kind":"parameter","displayName":"Allow Reply Manager Quick Stop","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping is enabled, and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag."},"consumerType":{"index":24,"kind":"parameter","displayName":"Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type to use, which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"defaultTaskExecutorType":{"index":25,"kind":"parameter","displayName":"Default Task Executor Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.DefaultTaskExecutorType","enum":["ThreadPool","SimpleAsync"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer, for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached thread-pool-like). If not set, it defaults to the previous behaviour, which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers."},"destinationOptions":{"index":26,"kind":"parameter","displayName":"Destination Options","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"destination.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Destination Options are a way to provide extended configuration options to a JMS consumer without having to extend the JMS API. The options are encoded using URL query syntax in the destination name that the consumer is created on. See more details at https://activemq.apache.org/destination-options."},"eagerLoadingOfProperties":{"index":27,"kind":"parameter","displayName":"Eager Loading Of Properties","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties. See also the option eagerPoisonBody."},"eagerPoisonBody":{"index":28,"kind":"parameter","displayName":"Eager Poison Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Poison JMS message due to ${exception.message}","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties."},"exceptionHandler":{"index":29,"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":{"index":30,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"exposeListenerSession":{"index":31,"kind":"parameter","displayName":"Expose Listener Session","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the listener session should be exposed when consuming messages."},"replyToConsumerType":{"index":32,"kind":"parameter","displayName":"Reply To Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type of the reply consumer (when doing request/reply), which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"replyToSameDestinationAllowed":{"index":33,"kind":"parameter","displayName":"Reply To Same Destination Allowed","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself."},"taskExecutor":{"index":34,"kind":"parameter","displayName":"Task Executor","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.springframework.core.task.TaskExecutor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to specify a custom task executor for consuming messages."},"deliveryDelay":{"index":35,"kind":"parameter","displayName":"Delivery Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets delivery delay to use for send calls for JMS. This option requires JMS 2.0 compliant broker."},"deliveryMode":{"index":36,"kind":"parameter","displayName":"Delivery Mode","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","enum":["1","2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."},"deliveryPersistent":{"index":37,"kind":"parameter","displayName":"Delivery Persistent","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether persistent delivery is used by default."},"explicitQosEnabled":{"index":38,"kind":"parameter","displayName":"Explicit Qos Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."},"formatDateHeadersToIso8601":{"index":39,"kind":"parameter","displayName":"Format Date Headers To Iso8601","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether JMS date properties should be formatted according to the ISO 8601 standard."},"preserveMessageQos":{"index":40,"kind":"parameter","displayName":"Preserve Message Qos","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."},"priority":{"index":41,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","enum":["1","2","3","4","5","6","7","8","9"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":4,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect."},"replyToConcurrentConsumers":{"index":42,"kind":"parameter","displayName":"Reply To Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToMaxConcurrentConsumers":{"index":43,"kind":"parameter","displayName":"Reply To Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToOnTimeoutMaxConcurrentConsumers":{"index":44,"kind":"parameter","displayName":"Reply To On Timeout Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS."},"replyToOverride":{"index":45,"kind":"parameter","displayName":"Reply To Override","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."},"replyToType":{"index":46,"kind":"parameter","displayName":"Reply To Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ReplyToType","enum":["Temporary","Shared","Exclusive"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary, Shared, or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details, and especially the notes about the implications if running in a clustered environment, and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive."},"requestTimeout":{"index":47,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."},"timeToLive":{"index":48,"kind":"parameter","displayName":"Time To Live","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending messages, specifies the time-to-live of the message (in milliseconds)."},"allowAdditionalHeaders":{"index":49,"kind":"parameter","displayName":"Allow Additional Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"This option is used to allow additional headers which may have values that are invalid according to JMS specification. For example, some message systems, such as WMQ, do this with header names using prefix JMS_IBM_MQMD_ containing values with byte array or other invalid types. You can specify multiple header names separated by comma, and use as suffix for wildcard matching."},"allowNullBody":{"index":50,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."},"alwaysCopyMessage":{"index":51,"kind":"parameter","displayName":"Always Copy Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set)"},"correlationProperty":{"index":52,"kind":"parameter","displayName":"Correlation Property","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages. If set messages will be correlated solely on the value of this property JMSCorrelationID property will be ignored and not set by Camel."},"disableTimeToLive":{"index":53,"kind":"parameter","displayName":"Disable Time To Live","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."},"forceSendOriginalMessage":{"index":54,"kind":"parameter","displayName":"Force Send Original Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received."},"includeSentJMSMessageID":{"index":55,"kind":"parameter","displayName":"Include Sent JMSMessage ID","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination."},"lazyStartProducer":{"index":56,"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."},"replyToCacheLevelName":{"index":57,"kind":"parameter","displayName":"Reply To Cache Level Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed, and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION."},"replyToDestinationSelectorName":{"index":58,"kind":"parameter","displayName":"Reply To Destination Selector Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is, if you are not using a temporary reply queue)."},"streamMessageTypeEnabled":{"index":59,"kind":"parameter","displayName":"Stream Message Type Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data."},"allowSerializedHeaders":{"index":60,"kind":"parameter","displayName":"Allow Serialized Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Controls whether or not to include serialized headers. Applies only when transferExchange is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."},"artemisStreamingEnabled":{"index":61,"kind":"parameter","displayName":"Artemis Streaming Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether optimizing for Apache Artemis streaming mode. This can reduce memory overhead when using Artemis with JMS StreamMessage types. This option must only be enabled if Apache Artemis is being used."},"asyncStartListener":{"index":62,"kind":"parameter","displayName":"Async Start Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to startup the JmsConsumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail-over. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry."},"asyncStopListener":{"index":63,"kind":"parameter","displayName":"Async Stop Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to stop the JmsConsumer message listener asynchronously, when stopping a route."},"destinationResolver":{"index":64,"kind":"parameter","displayName":"Destination Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.destination.DestinationResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example, to lookup the real destination in a JNDI registry)."},"errorHandler":{"index":65,"kind":"parameter","displayName":"Error Handler","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.util.ErrorHandler","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level, if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure, than having to code a custom errorHandler."},"exceptionListener":{"index":66,"kind":"parameter","displayName":"Exception Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.jms.ExceptionListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions."},"headerFilterStrategy":{"index":67,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"idleConsumerLimit":{"index":68,"kind":"parameter","displayName":"Idle Consumer Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specify the limit for the number of consumers that are allowed to be idle at any given time."},"idleTaskExecutionLimit":{"index":69,"kind":"parameter","displayName":"Idle Task Execution Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring."},"includeAllJMSXProperties":{"index":70,"kind":"parameter","displayName":"Include All JMSXProperties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to include all JMSX prefixed properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply."},"jmsKeyFormatStrategy":{"index":71,"kind":"parameter","displayName":"Jms Key Format Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsKeyFormatStrategy","enum":["default","passthrough"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation."},"mapJmsMessage":{"index":72,"kind":"parameter","displayName":"Map Jms Message","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc."},"maxMessagesPerTask":{"index":73,"kind":"parameter","displayName":"Max Messages Per Task","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max), then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required."},"messageConverter":{"index":74,"kind":"parameter","displayName":"Message Converter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.converter.MessageConverter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a jakarta.jms.Message."},"messageCreatedStrategy":{"index":75,"kind":"parameter","displayName":"Message Created Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageCreatedStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message."},"messageIdEnabled":{"index":76,"kind":"parameter","displayName":"Message Id Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending, specifies whether message IDs should be added. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value."},"messageListenerContainerFactory":{"index":77,"kind":"parameter","displayName":"Message Listener Container Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageListenerContainerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom."},"messageTimestampEnabled":{"index":78,"kind":"parameter","displayName":"Message Timestamp Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint the timestamp must be set to its normal value."},"pubSubNoLocal":{"index":79,"kind":"parameter","displayName":"Pub Sub No Local","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to inhibit the delivery of messages published by its own connection."},"receiveTimeout":{"index":80,"kind":"parameter","displayName":"Receive Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for receiving messages (in milliseconds)."},"recoveryInterval":{"index":81,"kind":"parameter","displayName":"Recovery Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds."},"requestTimeoutCheckerInterval":{"index":82,"kind":"parameter","displayName":"Request Timeout Checker Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs, then you can lower this interval, to check more frequently. The timeout is determined by the option requestTimeout."},"synchronous":{"index":83,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used"},"temporaryQueueResolver":{"index":84,"kind":"parameter","displayName":"Temporary Queue Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.TemporaryQueueResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable TemporaryQueueResolver that allows you to use your own resolver for creating temporary queues (some messaging systems has special requirements for creating temporary queues)."},"transferException":{"index":85,"kind":"parameter","displayName":"Transfer Exception","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!"},"transferExchange":{"index":86,"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body, Out body, Fault body, In headers, Out headers, Fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side, so Camel knows the payloads is an Exchange and not a regular payload. Use this with caution as the data is using Java Object serialization and requires the receiver to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumers having to use compatible Camel versions!"},"useMessageIDAsCorrelationID":{"index":87,"kind":"parameter","displayName":"Use Message IDAs Correlation ID","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages."},"waitForProvisionCorrelationToBeUpdatedCounter":{"index":88,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":50,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled."},"waitForProvisionCorrelationToBeUpdatedThreadSleepingTime":{"index":89,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for provisional correlation id to be updated."},"waitForTemporaryReplyToToBeUpdatedCounter":{"index":90,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":200,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for temporary replyTo queue to be created and ready when doing request/reply over JMS."},"waitForTemporaryReplyToToBeUpdatedThreadSleepingTime":{"index":91,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for temporary replyTo queue to be ready."},"errorHandlerLoggingLevel":{"index":92,"kind":"parameter","displayName":"Error Handler Logging Level","group":"logging","label":"consumer,logging","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to configure the default errorHandler logging level for logging uncaught exceptions."},"errorHandlerLogStackTrace":{"index":93,"kind":"parameter","displayName":"Error Handler Log Stack Trace","group":"logging","label":"consumer,logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to control whether stack-traces should be logged or not, by the default errorHandler."},"password":{"index":94,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"username":{"index":95,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"transacted":{"index":96,"kind":"parameter","displayName":"Transacted","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use transacted mode"},"transactedInOut":{"index":97,"kind":"parameter","displayName":"Transacted In Out","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether InOut operations (request reply) default to using transacted mode If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations. Note from Spring JMS: that within a JTA transaction, the parameters passed to createQueue, createTopic methods are not taken into account. Depending on the Java EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since Spring JMS operates on an existing JMS Session in this case. Setting this flag to true will use a short local JMS transaction when running outside of a managed transaction, and a synchronized local JMS transaction in case of a managed transaction (other than an XA transaction) being present. This has the effect of a local JMS transaction being managed alongside the main transaction (which might be a native JDBC transaction), with the JMS transaction committing right after the main transaction."},"lazyCreateTransactionManager":{"index":98,"kind":"parameter","displayName":"Lazy Create Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true."},"transactionManager":{"index":99,"kind":"parameter","displayName":"Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"object","javaType":"org.springframework.transaction.PlatformTransactionManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The Spring transaction manager to use."},"transactionName":{"index":100,"kind":"parameter","displayName":"Transaction Name","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The name of the transaction to use."},"transactionTimeout":{"index":101,"kind":"parameter","displayName":"Transaction Timeout","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout value of the transaction (in seconds), if using transacted mode."}}} +{"component":{"kind":"component","name":"activemq","title":"ActiveMQ 5.x","description":"Send messages to (or consume from) Apache ActiveMQ 5.x. This component extends the Camel JMS component.","deprecated":false,"firstVersion":"1.0.0","label":"messaging","javaType":"org.apache.camel.component.activemq.ActiveMQComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-activemq","version":"4.8.2","scheme":"activemq","extendsScheme":"jms","syntax":"activemq:destinationType:destinationName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJmsDestination":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION"},"CamelJmsDestinationName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic to use as destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME"},"CamelJMSDestinationProduced":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic the message was sent to.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME_PRODUCED"},"JMSXGroupID":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS group ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_X_GROUP_ID"},"JMSMessageID":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS unique message ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_MESSAGE_ID"},"JMSCorrelationID":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID"},"JMSCorrelationIDAsBytes":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID as bytes.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID_AS_BYTES"},"JMSDeliveryMode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS delivery mode.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DELIVERY_MODE"},"JMSDestination":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DESTINATION"},"JMSExpiration":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS expiration.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_EXPIRATION"},"JMSPriority":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS priority (with 0 as the lowest priority and 9 as the highest).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_PRIORITY"},"JMSRedelivered":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is the JMS message redelivered.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REDELIVERED"},"JMSTimestamp":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS timestamp.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TIMESTAMP"},"JMSReplyTo":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS reply-to destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REPLY_TO"},"JMSType":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TYPE"},"JMSXUserID":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XUser id.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_XUSER_ID"},"CamelJmsMessageType":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text","Blob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_MESSAGE_TYPE"},"CamelJmsRequestTimeout":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"20_000","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_REQUEST_TIMEOUT"}},"properties":{"destinationType":{"index":0,"kind":"path","displayName":"Destination Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["queue","topic","temp-queue","temp-topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"queue","description":"The kind of destination to use"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the queue or topic to use as destination"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions with JMS 1.1."},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"","required":false,"type":"object","javaType":"jakarta.jms.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"disableReplyTo":{"index":4,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."},"durableSubscriptionName":{"index":5,"kind":"parameter","displayName":"Durable Subscription Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."},"jmsMessageType":{"index":6,"kind":"parameter","displayName":"Jms Message Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to force the use of a specific jakarta.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it."},"replyTo":{"index":7,"kind":"parameter","displayName":"Reply To","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)."},"testConnectionOnStartup":{"index":8,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"acknowledgementModeName":{"index":9,"kind":"parameter","displayName":"Acknowledgement Mode Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["SESSION_TRANSACTED","CLIENT_ACKNOWLEDGE","AUTO_ACKNOWLEDGE","DUPS_OK_ACKNOWLEDGE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO_ACKNOWLEDGE","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"},"artemisConsumerPriority":{"index":10,"kind":"parameter","displayName":"Artemis Consumer Priority","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Consumer priorities allow you to ensure that high priority consumers receive messages while they are active. Normally, active consumers connected to a queue receive messages from it in a round-robin fashion. When consumer priorities are in use, messages are delivered round-robin if multiple active consumers exist with the same high priority. Messages will only going to lower priority consumers when the high priority consumers do not have credit available to consume the message, or those high priority consumers have declined to accept the message (for instance because it does not meet the criteria of any selectors associated with the consumer)."},"asyncConsumer":{"index":11,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."},"autoStartup":{"index":12,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer container should auto-startup."},"cacheLevel":{"index":13,"kind":"parameter","displayName":"Cache Level","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details."},"cacheLevelName":{"index":14,"kind":"parameter","displayName":"Cache Level Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CACHE_AUTO","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information."},"concurrentConsumers":{"index":15,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"maxConcurrentConsumers":{"index":16,"kind":"parameter","displayName":"Max Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"replyToDeliveryPersistent":{"index":17,"kind":"parameter","displayName":"Reply To Delivery Persistent","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use persistent delivery by default for replies."},"selector":{"index":18,"kind":"parameter","displayName":"Selector","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS selector to use"},"subscriptionDurable":{"index":19,"kind":"parameter","displayName":"Subscription Durable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well."},"subscriptionName":{"index":20,"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.jms.JmsConfiguration","configurationField":"configuration","description":"Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0)."},"subscriptionShared":{"index":21,"kind":"parameter","displayName":"Subscription Shared","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker."},"acceptMessagesWhileStopping":{"index":22,"kind":"parameter","displayName":"Accept Messages While Stopping","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option, if you start and stop JMS routes at runtime, while there are still messages enqueued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected, and the JMS broker would have to attempt redeliveries, which yet again may be rejected, and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option."},"allowReplyManagerQuickStop":{"index":23,"kind":"parameter","displayName":"Allow Reply Manager Quick Stop","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping is enabled, and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag."},"consumerType":{"index":24,"kind":"parameter","displayName":"Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type to use, which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"defaultTaskExecutorType":{"index":25,"kind":"parameter","displayName":"Default Task Executor Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.DefaultTaskExecutorType","enum":["ThreadPool","SimpleAsync"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer, for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached thread-pool-like). If not set, it defaults to the previous behaviour, which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers."},"destinationOptions":{"index":26,"kind":"parameter","displayName":"Destination Options","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"destination.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Destination Options are a way to provide extended configuration options to a JMS consumer without having to extend the JMS API. The options are encoded using URL query syntax in the destination name that the consumer is created on. See more details at https://activemq.apache.org/destination-options."},"eagerLoadingOfProperties":{"index":27,"kind":"parameter","displayName":"Eager Loading Of Properties","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties. See also the option eagerPoisonBody."},"eagerPoisonBody":{"index":28,"kind":"parameter","displayName":"Eager Poison Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Poison JMS message due to ${exception.message}","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties."},"exceptionHandler":{"index":29,"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":{"index":30,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"exposeListenerSession":{"index":31,"kind":"parameter","displayName":"Expose Listener Session","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the listener session should be exposed when consuming messages."},"replyToConsumerType":{"index":32,"kind":"parameter","displayName":"Reply To Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type of the reply consumer (when doing request/reply), which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"replyToSameDestinationAllowed":{"index":33,"kind":"parameter","displayName":"Reply To Same Destination Allowed","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself."},"taskExecutor":{"index":34,"kind":"parameter","displayName":"Task Executor","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.springframework.core.task.TaskExecutor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to specify a custom task executor for consuming messages."},"deliveryDelay":{"index":35,"kind":"parameter","displayName":"Delivery Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets delivery delay to use for send calls for JMS. This option requires JMS 2.0 compliant broker."},"deliveryMode":{"index":36,"kind":"parameter","displayName":"Delivery Mode","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","enum":["1","2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."},"deliveryPersistent":{"index":37,"kind":"parameter","displayName":"Delivery Persistent","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether persistent delivery is used by default."},"explicitQosEnabled":{"index":38,"kind":"parameter","displayName":"Explicit Qos Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."},"formatDateHeadersToIso8601":{"index":39,"kind":"parameter","displayName":"Format Date Headers To Iso8601","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether JMS date properties should be formatted according to the ISO 8601 standard."},"preserveMessageQos":{"index":40,"kind":"parameter","displayName":"Preserve Message Qos","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."},"priority":{"index":41,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","enum":["1","2","3","4","5","6","7","8","9"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":4,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect."},"replyToConcurrentConsumers":{"index":42,"kind":"parameter","displayName":"Reply To Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToMaxConcurrentConsumers":{"index":43,"kind":"parameter","displayName":"Reply To Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToOnTimeoutMaxConcurrentConsumers":{"index":44,"kind":"parameter","displayName":"Reply To On Timeout Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS."},"replyToOverride":{"index":45,"kind":"parameter","displayName":"Reply To Override","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."},"replyToType":{"index":46,"kind":"parameter","displayName":"Reply To Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ReplyToType","enum":["Temporary","Shared","Exclusive"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary, Shared, or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details, and especially the notes about the implications if running in a clustered environment, and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive."},"requestTimeout":{"index":47,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."},"timeToLive":{"index":48,"kind":"parameter","displayName":"Time To Live","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending messages, specifies the time-to-live of the message (in milliseconds)."},"allowAdditionalHeaders":{"index":49,"kind":"parameter","displayName":"Allow Additional Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"This option is used to allow additional headers which may have values that are invalid according to JMS specification. For example, some message systems, such as WMQ, do this with header names using prefix JMS_IBM_MQMD_ containing values with byte array or other invalid types. You can specify multiple header names separated by comma, and use as suffix for wildcard matching."},"allowNullBody":{"index":50,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."},"alwaysCopyMessage":{"index":51,"kind":"parameter","displayName":"Always Copy Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set)"},"correlationProperty":{"index":52,"kind":"parameter","displayName":"Correlation Property","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages. If set messages will be correlated solely on the value of this property JMSCorrelationID property will be ignored and not set by Camel."},"disableTimeToLive":{"index":53,"kind":"parameter","displayName":"Disable Time To Live","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."},"forceSendOriginalMessage":{"index":54,"kind":"parameter","displayName":"Force Send Original Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received."},"includeSentJMSMessageID":{"index":55,"kind":"parameter","displayName":"Include Sent JMSMessage ID","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination."},"lazyStartProducer":{"index":56,"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."},"replyToCacheLevelName":{"index":57,"kind":"parameter","displayName":"Reply To Cache Level Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed, and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION."},"replyToDestinationSelectorName":{"index":58,"kind":"parameter","displayName":"Reply To Destination Selector Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is, if you are not using a temporary reply queue)."},"streamMessageTypeEnabled":{"index":59,"kind":"parameter","displayName":"Stream Message Type Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data."},"allowSerializedHeaders":{"index":60,"kind":"parameter","displayName":"Allow Serialized Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Controls whether or not to include serialized headers. Applies only when transferExchange is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."},"artemisStreamingEnabled":{"index":61,"kind":"parameter","displayName":"Artemis Streaming Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether optimizing for Apache Artemis streaming mode. This can reduce memory overhead when using Artemis with JMS StreamMessage types. This option must only be enabled if Apache Artemis is being used."},"asyncStartListener":{"index":62,"kind":"parameter","displayName":"Async Start Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to startup the JmsConsumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail-over. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry."},"asyncStopListener":{"index":63,"kind":"parameter","displayName":"Async Stop Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to stop the JmsConsumer message listener asynchronously, when stopping a route."},"destinationResolver":{"index":64,"kind":"parameter","displayName":"Destination Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.destination.DestinationResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example, to lookup the real destination in a JNDI registry)."},"errorHandler":{"index":65,"kind":"parameter","displayName":"Error Handler","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.util.ErrorHandler","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level, if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure, than having to code a custom errorHandler."},"exceptionListener":{"index":66,"kind":"parameter","displayName":"Exception Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.jms.ExceptionListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions."},"headerFilterStrategy":{"index":67,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"idleConsumerLimit":{"index":68,"kind":"parameter","displayName":"Idle Consumer Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specify the limit for the number of consumers that are allowed to be idle at any given time."},"idleTaskExecutionLimit":{"index":69,"kind":"parameter","displayName":"Idle Task Execution Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring."},"includeAllJMSXProperties":{"index":70,"kind":"parameter","displayName":"Include All JMSXProperties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to include all JMSX prefixed properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply."},"jmsKeyFormatStrategy":{"index":71,"kind":"parameter","displayName":"Jms Key Format Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsKeyFormatStrategy","enum":["default","passthrough"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation."},"mapJmsMessage":{"index":72,"kind":"parameter","displayName":"Map Jms Message","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc."},"maxMessagesPerTask":{"index":73,"kind":"parameter","displayName":"Max Messages Per Task","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max), then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required."},"messageConverter":{"index":74,"kind":"parameter","displayName":"Message Converter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.converter.MessageConverter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a jakarta.jms.Message."},"messageCreatedStrategy":{"index":75,"kind":"parameter","displayName":"Message Created Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageCreatedStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message."},"messageIdEnabled":{"index":76,"kind":"parameter","displayName":"Message Id Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending, specifies whether message IDs should be added. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value."},"messageListenerContainerFactory":{"index":77,"kind":"parameter","displayName":"Message Listener Container Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageListenerContainerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom."},"messageTimestampEnabled":{"index":78,"kind":"parameter","displayName":"Message Timestamp Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint the timestamp must be set to its normal value."},"pubSubNoLocal":{"index":79,"kind":"parameter","displayName":"Pub Sub No Local","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to inhibit the delivery of messages published by its own connection."},"receiveTimeout":{"index":80,"kind":"parameter","displayName":"Receive Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for receiving messages (in milliseconds)."},"recoveryInterval":{"index":81,"kind":"parameter","displayName":"Recovery Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds."},"requestTimeoutCheckerInterval":{"index":82,"kind":"parameter","displayName":"Request Timeout Checker Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs, then you can lower this interval, to check more frequently. The timeout is determined by the option requestTimeout."},"synchronous":{"index":83,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used"},"temporaryQueueResolver":{"index":84,"kind":"parameter","displayName":"Temporary Queue Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.TemporaryQueueResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable TemporaryQueueResolver that allows you to use your own resolver for creating temporary queues (some messaging systems has special requirements for creating temporary queues)."},"transferException":{"index":85,"kind":"parameter","displayName":"Transfer Exception","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!"},"transferExchange":{"index":86,"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body, Out body, Fault body, In headers, Out headers, Fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side, so Camel knows the payloads is an Exchange and not a regular payload. Use this with caution as the data is using Java Object serialization and requires the receiver to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumers having to use compatible Camel versions!"},"useMessageIDAsCorrelationID":{"index":87,"kind":"parameter","displayName":"Use Message IDAs Correlation ID","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages."},"waitForProvisionCorrelationToBeUpdatedCounter":{"index":88,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":50,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled."},"waitForProvisionCorrelationToBeUpdatedThreadSleepingTime":{"index":89,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for provisional correlation id to be updated."},"waitForTemporaryReplyToToBeUpdatedCounter":{"index":90,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":200,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for temporary replyTo queue to be created and ready when doing request/reply over JMS."},"waitForTemporaryReplyToToBeUpdatedThreadSleepingTime":{"index":91,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for temporary replyTo queue to be ready."},"errorHandlerLoggingLevel":{"index":92,"kind":"parameter","displayName":"Error Handler Logging Level","group":"logging","label":"consumer,logging","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to configure the default errorHandler logging level for logging uncaught exceptions."},"errorHandlerLogStackTrace":{"index":93,"kind":"parameter","displayName":"Error Handler Log Stack Trace","group":"logging","label":"consumer,logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to control whether stack-traces should be logged or not, by the default errorHandler."},"password":{"index":94,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"username":{"index":95,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"transacted":{"index":96,"kind":"parameter","displayName":"Transacted","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use transacted mode"},"transactedInOut":{"index":97,"kind":"parameter","displayName":"Transacted In Out","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether InOut operations (request reply) default to using transacted mode If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations. Note from Spring JMS: that within a JTA transaction, the parameters passed to createQueue, createTopic methods are not taken into account. Depending on the Java EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since Spring JMS operates on an existing JMS Session in this case. Setting this flag to true will use a short local JMS transaction when running outside of a managed transaction, and a synchronized local JMS transaction in case of a managed transaction (other than an XA transaction) being present. This has the effect of a local JMS transaction being managed alongside the main transaction (which might be a native JDBC transaction), with the JMS transaction committing right after the main transaction."},"lazyCreateTransactionManager":{"index":98,"kind":"parameter","displayName":"Lazy Create Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true."},"transactionManager":{"index":99,"kind":"parameter","displayName":"Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"object","javaType":"org.springframework.transaction.PlatformTransactionManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The Spring transaction manager to use."},"transactionName":{"index":100,"kind":"parameter","displayName":"Transaction Name","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The name of the transaction to use."},"transactionTimeout":{"index":101,"kind":"parameter","displayName":"Transaction Timeout","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout value of the transaction (in seconds), if using transacted mode."}}} , -{"component":{"kind":"component","name":"activemq6","title":"ActiveMQ 6.x","description":"Send messages to (or consume from) Apache ActiveMQ 6.x. This component extends the Camel JMS component.","deprecated":false,"firstVersion":"4.7.0","label":"messaging","javaType":"org.apache.camel.component.activemq6.ActiveMQComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-activemq6","version":"4.8.1","scheme":"activemq6","extendsScheme":"jms","syntax":"activemq6:destinationType:destinationName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJmsDestination":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION"},"CamelJmsDestinationName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic to use as destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME"},"CamelJMSDestinationProduced":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic the message was sent to.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME_PRODUCED"},"JMSXGroupID":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS group ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_X_GROUP_ID"},"JMSMessageID":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS unique message ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_MESSAGE_ID"},"JMSCorrelationID":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID"},"JMSCorrelationIDAsBytes":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID as bytes.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID_AS_BYTES"},"JMSDeliveryMode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS delivery mode.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DELIVERY_MODE"},"JMSDestination":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DESTINATION"},"JMSExpiration":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS expiration.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_EXPIRATION"},"JMSPriority":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS priority (with 0 as the lowest priority and 9 as the highest).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_PRIORITY"},"JMSRedelivered":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is the JMS message redelivered.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REDELIVERED"},"JMSTimestamp":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS timestamp.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TIMESTAMP"},"JMSReplyTo":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS reply-to destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REPLY_TO"},"JMSType":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TYPE"},"JMSXUserID":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XUser id.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_XUSER_ID"},"CamelJmsMessageType":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text","Blob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_MESSAGE_TYPE"},"CamelJmsRequestTimeout":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"20_000","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_REQUEST_TIMEOUT"}},"properties":{"destinationType":{"index":0,"kind":"path","displayName":"Destination Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["queue","topic","temp-queue","temp-topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"queue","description":"The kind of destination to use"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the queue or topic to use as destination"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions with JMS 1.1."},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"","required":false,"type":"object","javaType":"jakarta.jms.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"disableReplyTo":{"index":4,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."},"durableSubscriptionName":{"index":5,"kind":"parameter","displayName":"Durable Subscription Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."},"jmsMessageType":{"index":6,"kind":"parameter","displayName":"Jms Message Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to force the use of a specific jakarta.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it."},"replyTo":{"index":7,"kind":"parameter","displayName":"Reply To","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)."},"testConnectionOnStartup":{"index":8,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"acknowledgementModeName":{"index":9,"kind":"parameter","displayName":"Acknowledgement Mode Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["SESSION_TRANSACTED","CLIENT_ACKNOWLEDGE","AUTO_ACKNOWLEDGE","DUPS_OK_ACKNOWLEDGE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO_ACKNOWLEDGE","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"},"artemisConsumerPriority":{"index":10,"kind":"parameter","displayName":"Artemis Consumer Priority","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Consumer priorities allow you to ensure that high priority consumers receive messages while they are active. Normally, active consumers connected to a queue receive messages from it in a round-robin fashion. When consumer priorities are in use, messages are delivered round-robin if multiple active consumers exist with the same high priority. Messages will only going to lower priority consumers when the high priority consumers do not have credit available to consume the message, or those high priority consumers have declined to accept the message (for instance because it does not meet the criteria of any selectors associated with the consumer)."},"asyncConsumer":{"index":11,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."},"autoStartup":{"index":12,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer container should auto-startup."},"cacheLevel":{"index":13,"kind":"parameter","displayName":"Cache Level","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details."},"cacheLevelName":{"index":14,"kind":"parameter","displayName":"Cache Level Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CACHE_AUTO","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information."},"concurrentConsumers":{"index":15,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"maxConcurrentConsumers":{"index":16,"kind":"parameter","displayName":"Max Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"replyToDeliveryPersistent":{"index":17,"kind":"parameter","displayName":"Reply To Delivery Persistent","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use persistent delivery by default for replies."},"selector":{"index":18,"kind":"parameter","displayName":"Selector","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS selector to use"},"subscriptionDurable":{"index":19,"kind":"parameter","displayName":"Subscription Durable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well."},"subscriptionName":{"index":20,"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.jms.JmsConfiguration","configurationField":"configuration","description":"Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0)."},"subscriptionShared":{"index":21,"kind":"parameter","displayName":"Subscription Shared","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker."},"acceptMessagesWhileStopping":{"index":22,"kind":"parameter","displayName":"Accept Messages While Stopping","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option, if you start and stop JMS routes at runtime, while there are still messages enqueued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected, and the JMS broker would have to attempt redeliveries, which yet again may be rejected, and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option."},"allowReplyManagerQuickStop":{"index":23,"kind":"parameter","displayName":"Allow Reply Manager Quick Stop","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping is enabled, and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag."},"consumerType":{"index":24,"kind":"parameter","displayName":"Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type to use, which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"defaultTaskExecutorType":{"index":25,"kind":"parameter","displayName":"Default Task Executor Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.DefaultTaskExecutorType","enum":["ThreadPool","SimpleAsync"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer, for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached thread-pool-like). If not set, it defaults to the previous behaviour, which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers."},"destinationOptions":{"index":26,"kind":"parameter","displayName":"Destination Options","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"destination.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Destination Options are a way to provide extended configuration options to a JMS consumer without having to extend the JMS API. The options are encoded using URL query syntax in the destination name that the consumer is created on. See more details at https://activemq.apache.org/destination-options."},"eagerLoadingOfProperties":{"index":27,"kind":"parameter","displayName":"Eager Loading Of Properties","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties. See also the option eagerPoisonBody."},"eagerPoisonBody":{"index":28,"kind":"parameter","displayName":"Eager Poison Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Poison JMS message due to ${exception.message}","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties."},"exceptionHandler":{"index":29,"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":{"index":30,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"exposeListenerSession":{"index":31,"kind":"parameter","displayName":"Expose Listener Session","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the listener session should be exposed when consuming messages."},"replyToConsumerType":{"index":32,"kind":"parameter","displayName":"Reply To Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type of the reply consumer (when doing request/reply), which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"replyToSameDestinationAllowed":{"index":33,"kind":"parameter","displayName":"Reply To Same Destination Allowed","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself."},"taskExecutor":{"index":34,"kind":"parameter","displayName":"Task Executor","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.springframework.core.task.TaskExecutor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to specify a custom task executor for consuming messages."},"deliveryDelay":{"index":35,"kind":"parameter","displayName":"Delivery Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets delivery delay to use for send calls for JMS. This option requires JMS 2.0 compliant broker."},"deliveryMode":{"index":36,"kind":"parameter","displayName":"Delivery Mode","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","enum":["1","2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."},"deliveryPersistent":{"index":37,"kind":"parameter","displayName":"Delivery Persistent","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether persistent delivery is used by default."},"explicitQosEnabled":{"index":38,"kind":"parameter","displayName":"Explicit Qos Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."},"formatDateHeadersToIso8601":{"index":39,"kind":"parameter","displayName":"Format Date Headers To Iso8601","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether JMS date properties should be formatted according to the ISO 8601 standard."},"preserveMessageQos":{"index":40,"kind":"parameter","displayName":"Preserve Message Qos","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."},"priority":{"index":41,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","enum":["1","2","3","4","5","6","7","8","9"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":4,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect."},"replyToConcurrentConsumers":{"index":42,"kind":"parameter","displayName":"Reply To Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToMaxConcurrentConsumers":{"index":43,"kind":"parameter","displayName":"Reply To Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToOnTimeoutMaxConcurrentConsumers":{"index":44,"kind":"parameter","displayName":"Reply To On Timeout Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS."},"replyToOverride":{"index":45,"kind":"parameter","displayName":"Reply To Override","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."},"replyToType":{"index":46,"kind":"parameter","displayName":"Reply To Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ReplyToType","enum":["Temporary","Shared","Exclusive"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary, Shared, or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details, and especially the notes about the implications if running in a clustered environment, and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive."},"requestTimeout":{"index":47,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."},"timeToLive":{"index":48,"kind":"parameter","displayName":"Time To Live","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending messages, specifies the time-to-live of the message (in milliseconds)."},"allowAdditionalHeaders":{"index":49,"kind":"parameter","displayName":"Allow Additional Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"This option is used to allow additional headers which may have values that are invalid according to JMS specification. For example, some message systems, such as WMQ, do this with header names using prefix JMS_IBM_MQMD_ containing values with byte array or other invalid types. You can specify multiple header names separated by comma, and use as suffix for wildcard matching."},"allowNullBody":{"index":50,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."},"alwaysCopyMessage":{"index":51,"kind":"parameter","displayName":"Always Copy Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set)"},"correlationProperty":{"index":52,"kind":"parameter","displayName":"Correlation Property","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages. If set messages will be correlated solely on the value of this property JMSCorrelationID property will be ignored and not set by Camel."},"disableTimeToLive":{"index":53,"kind":"parameter","displayName":"Disable Time To Live","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."},"forceSendOriginalMessage":{"index":54,"kind":"parameter","displayName":"Force Send Original Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received."},"includeSentJMSMessageID":{"index":55,"kind":"parameter","displayName":"Include Sent JMSMessage ID","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination."},"lazyStartProducer":{"index":56,"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."},"replyToCacheLevelName":{"index":57,"kind":"parameter","displayName":"Reply To Cache Level Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed, and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION."},"replyToDestinationSelectorName":{"index":58,"kind":"parameter","displayName":"Reply To Destination Selector Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is, if you are not using a temporary reply queue)."},"streamMessageTypeEnabled":{"index":59,"kind":"parameter","displayName":"Stream Message Type Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data."},"allowSerializedHeaders":{"index":60,"kind":"parameter","displayName":"Allow Serialized Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Controls whether or not to include serialized headers. Applies only when transferExchange is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."},"artemisStreamingEnabled":{"index":61,"kind":"parameter","displayName":"Artemis Streaming Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether optimizing for Apache Artemis streaming mode. This can reduce memory overhead when using Artemis with JMS StreamMessage types. This option must only be enabled if Apache Artemis is being used."},"asyncStartListener":{"index":62,"kind":"parameter","displayName":"Async Start Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to startup the JmsConsumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail-over. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry."},"asyncStopListener":{"index":63,"kind":"parameter","displayName":"Async Stop Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to stop the JmsConsumer message listener asynchronously, when stopping a route."},"destinationResolver":{"index":64,"kind":"parameter","displayName":"Destination Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.destination.DestinationResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example, to lookup the real destination in a JNDI registry)."},"errorHandler":{"index":65,"kind":"parameter","displayName":"Error Handler","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.util.ErrorHandler","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level, if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure, than having to code a custom errorHandler."},"exceptionListener":{"index":66,"kind":"parameter","displayName":"Exception Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.jms.ExceptionListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions."},"headerFilterStrategy":{"index":67,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"idleConsumerLimit":{"index":68,"kind":"parameter","displayName":"Idle Consumer Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specify the limit for the number of consumers that are allowed to be idle at any given time."},"idleTaskExecutionLimit":{"index":69,"kind":"parameter","displayName":"Idle Task Execution Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring."},"includeAllJMSXProperties":{"index":70,"kind":"parameter","displayName":"Include All JMSXProperties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to include all JMSX prefixed properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply."},"jmsKeyFormatStrategy":{"index":71,"kind":"parameter","displayName":"Jms Key Format Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsKeyFormatStrategy","enum":["default","passthrough"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation."},"mapJmsMessage":{"index":72,"kind":"parameter","displayName":"Map Jms Message","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc."},"maxMessagesPerTask":{"index":73,"kind":"parameter","displayName":"Max Messages Per Task","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max), then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required."},"messageConverter":{"index":74,"kind":"parameter","displayName":"Message Converter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.converter.MessageConverter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a jakarta.jms.Message."},"messageCreatedStrategy":{"index":75,"kind":"parameter","displayName":"Message Created Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageCreatedStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message."},"messageIdEnabled":{"index":76,"kind":"parameter","displayName":"Message Id Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending, specifies whether message IDs should be added. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value."},"messageListenerContainerFactory":{"index":77,"kind":"parameter","displayName":"Message Listener Container Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageListenerContainerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom."},"messageTimestampEnabled":{"index":78,"kind":"parameter","displayName":"Message Timestamp Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint the timestamp must be set to its normal value."},"pubSubNoLocal":{"index":79,"kind":"parameter","displayName":"Pub Sub No Local","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to inhibit the delivery of messages published by its own connection."},"receiveTimeout":{"index":80,"kind":"parameter","displayName":"Receive Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for receiving messages (in milliseconds)."},"recoveryInterval":{"index":81,"kind":"parameter","displayName":"Recovery Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds."},"requestTimeoutCheckerInterval":{"index":82,"kind":"parameter","displayName":"Request Timeout Checker Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs, then you can lower this interval, to check more frequently. The timeout is determined by the option requestTimeout."},"synchronous":{"index":83,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used"},"temporaryQueueResolver":{"index":84,"kind":"parameter","displayName":"Temporary Queue Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.TemporaryQueueResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable TemporaryQueueResolver that allows you to use your own resolver for creating temporary queues (some messaging systems has special requirements for creating temporary queues)."},"transferException":{"index":85,"kind":"parameter","displayName":"Transfer Exception","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!"},"transferExchange":{"index":86,"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body, Out body, Fault body, In headers, Out headers, Fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side, so Camel knows the payloads is an Exchange and not a regular payload. Use this with caution as the data is using Java Object serialization and requires the receiver to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumers having to use compatible Camel versions!"},"useMessageIDAsCorrelationID":{"index":87,"kind":"parameter","displayName":"Use Message IDAs Correlation ID","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages."},"waitForProvisionCorrelationToBeUpdatedCounter":{"index":88,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":50,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled."},"waitForProvisionCorrelationToBeUpdatedThreadSleepingTime":{"index":89,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for provisional correlation id to be updated."},"waitForTemporaryReplyToToBeUpdatedCounter":{"index":90,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":200,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for temporary replyTo queue to be created and ready when doing request/reply over JMS."},"waitForTemporaryReplyToToBeUpdatedThreadSleepingTime":{"index":91,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for temporary replyTo queue to be ready."},"errorHandlerLoggingLevel":{"index":92,"kind":"parameter","displayName":"Error Handler Logging Level","group":"logging","label":"consumer,logging","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to configure the default errorHandler logging level for logging uncaught exceptions."},"errorHandlerLogStackTrace":{"index":93,"kind":"parameter","displayName":"Error Handler Log Stack Trace","group":"logging","label":"consumer,logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to control whether stack-traces should be logged or not, by the default errorHandler."},"password":{"index":94,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"username":{"index":95,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"transacted":{"index":96,"kind":"parameter","displayName":"Transacted","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use transacted mode"},"transactedInOut":{"index":97,"kind":"parameter","displayName":"Transacted In Out","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether InOut operations (request reply) default to using transacted mode If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations. Note from Spring JMS: that within a JTA transaction, the parameters passed to createQueue, createTopic methods are not taken into account. Depending on the Java EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since Spring JMS operates on an existing JMS Session in this case. Setting this flag to true will use a short local JMS transaction when running outside of a managed transaction, and a synchronized local JMS transaction in case of a managed transaction (other than an XA transaction) being present. This has the effect of a local JMS transaction being managed alongside the main transaction (which might be a native JDBC transaction), with the JMS transaction committing right after the main transaction."},"lazyCreateTransactionManager":{"index":98,"kind":"parameter","displayName":"Lazy Create Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true."},"transactionManager":{"index":99,"kind":"parameter","displayName":"Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"object","javaType":"org.springframework.transaction.PlatformTransactionManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The Spring transaction manager to use."},"transactionName":{"index":100,"kind":"parameter","displayName":"Transaction Name","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The name of the transaction to use."},"transactionTimeout":{"index":101,"kind":"parameter","displayName":"Transaction Timeout","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout value of the transaction (in seconds), if using transacted mode."}}} +{"component":{"kind":"component","name":"activemq6","title":"ActiveMQ 6.x","description":"Send messages to (or consume from) Apache ActiveMQ 6.x. This component extends the Camel JMS component.","deprecated":false,"firstVersion":"4.7.0","label":"messaging","javaType":"org.apache.camel.component.activemq6.ActiveMQComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-activemq6","version":"4.8.2","scheme":"activemq6","extendsScheme":"jms","syntax":"activemq6:destinationType:destinationName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJmsDestination":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION"},"CamelJmsDestinationName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic to use as destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME"},"CamelJMSDestinationProduced":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic the message was sent to.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME_PRODUCED"},"JMSXGroupID":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS group ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_X_GROUP_ID"},"JMSMessageID":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS unique message ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_MESSAGE_ID"},"JMSCorrelationID":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID"},"JMSCorrelationIDAsBytes":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID as bytes.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID_AS_BYTES"},"JMSDeliveryMode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS delivery mode.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DELIVERY_MODE"},"JMSDestination":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DESTINATION"},"JMSExpiration":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS expiration.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_EXPIRATION"},"JMSPriority":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS priority (with 0 as the lowest priority and 9 as the highest).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_PRIORITY"},"JMSRedelivered":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is the JMS message redelivered.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REDELIVERED"},"JMSTimestamp":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS timestamp.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TIMESTAMP"},"JMSReplyTo":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS reply-to destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REPLY_TO"},"JMSType":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TYPE"},"JMSXUserID":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XUser id.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_XUSER_ID"},"CamelJmsMessageType":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text","Blob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_MESSAGE_TYPE"},"CamelJmsRequestTimeout":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"20_000","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_REQUEST_TIMEOUT"}},"properties":{"destinationType":{"index":0,"kind":"path","displayName":"Destination Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["queue","topic","temp-queue","temp-topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"queue","description":"The kind of destination to use"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the queue or topic to use as destination"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions with JMS 1.1."},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"","required":false,"type":"object","javaType":"jakarta.jms.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"disableReplyTo":{"index":4,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."},"durableSubscriptionName":{"index":5,"kind":"parameter","displayName":"Durable Subscription Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."},"jmsMessageType":{"index":6,"kind":"parameter","displayName":"Jms Message Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to force the use of a specific jakarta.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it."},"replyTo":{"index":7,"kind":"parameter","displayName":"Reply To","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)."},"testConnectionOnStartup":{"index":8,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"acknowledgementModeName":{"index":9,"kind":"parameter","displayName":"Acknowledgement Mode Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["SESSION_TRANSACTED","CLIENT_ACKNOWLEDGE","AUTO_ACKNOWLEDGE","DUPS_OK_ACKNOWLEDGE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO_ACKNOWLEDGE","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"},"artemisConsumerPriority":{"index":10,"kind":"parameter","displayName":"Artemis Consumer Priority","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Consumer priorities allow you to ensure that high priority consumers receive messages while they are active. Normally, active consumers connected to a queue receive messages from it in a round-robin fashion. When consumer priorities are in use, messages are delivered round-robin if multiple active consumers exist with the same high priority. Messages will only going to lower priority consumers when the high priority consumers do not have credit available to consume the message, or those high priority consumers have declined to accept the message (for instance because it does not meet the criteria of any selectors associated with the consumer)."},"asyncConsumer":{"index":11,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."},"autoStartup":{"index":12,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer container should auto-startup."},"cacheLevel":{"index":13,"kind":"parameter","displayName":"Cache Level","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details."},"cacheLevelName":{"index":14,"kind":"parameter","displayName":"Cache Level Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CACHE_AUTO","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information."},"concurrentConsumers":{"index":15,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"maxConcurrentConsumers":{"index":16,"kind":"parameter","displayName":"Max Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"replyToDeliveryPersistent":{"index":17,"kind":"parameter","displayName":"Reply To Delivery Persistent","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use persistent delivery by default for replies."},"selector":{"index":18,"kind":"parameter","displayName":"Selector","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS selector to use"},"subscriptionDurable":{"index":19,"kind":"parameter","displayName":"Subscription Durable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well."},"subscriptionName":{"index":20,"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.jms.JmsConfiguration","configurationField":"configuration","description":"Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0)."},"subscriptionShared":{"index":21,"kind":"parameter","displayName":"Subscription Shared","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker."},"acceptMessagesWhileStopping":{"index":22,"kind":"parameter","displayName":"Accept Messages While Stopping","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option, if you start and stop JMS routes at runtime, while there are still messages enqueued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected, and the JMS broker would have to attempt redeliveries, which yet again may be rejected, and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option."},"allowReplyManagerQuickStop":{"index":23,"kind":"parameter","displayName":"Allow Reply Manager Quick Stop","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping is enabled, and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag."},"consumerType":{"index":24,"kind":"parameter","displayName":"Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type to use, which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"defaultTaskExecutorType":{"index":25,"kind":"parameter","displayName":"Default Task Executor Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.DefaultTaskExecutorType","enum":["ThreadPool","SimpleAsync"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer, for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached thread-pool-like). If not set, it defaults to the previous behaviour, which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers."},"destinationOptions":{"index":26,"kind":"parameter","displayName":"Destination Options","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"destination.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Destination Options are a way to provide extended configuration options to a JMS consumer without having to extend the JMS API. The options are encoded using URL query syntax in the destination name that the consumer is created on. See more details at https://activemq.apache.org/destination-options."},"eagerLoadingOfProperties":{"index":27,"kind":"parameter","displayName":"Eager Loading Of Properties","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties. See also the option eagerPoisonBody."},"eagerPoisonBody":{"index":28,"kind":"parameter","displayName":"Eager Poison Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Poison JMS message due to ${exception.message}","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties."},"exceptionHandler":{"index":29,"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":{"index":30,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"exposeListenerSession":{"index":31,"kind":"parameter","displayName":"Expose Listener Session","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the listener session should be exposed when consuming messages."},"replyToConsumerType":{"index":32,"kind":"parameter","displayName":"Reply To Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type of the reply consumer (when doing request/reply), which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"replyToSameDestinationAllowed":{"index":33,"kind":"parameter","displayName":"Reply To Same Destination Allowed","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself."},"taskExecutor":{"index":34,"kind":"parameter","displayName":"Task Executor","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.springframework.core.task.TaskExecutor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to specify a custom task executor for consuming messages."},"deliveryDelay":{"index":35,"kind":"parameter","displayName":"Delivery Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets delivery delay to use for send calls for JMS. This option requires JMS 2.0 compliant broker."},"deliveryMode":{"index":36,"kind":"parameter","displayName":"Delivery Mode","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","enum":["1","2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."},"deliveryPersistent":{"index":37,"kind":"parameter","displayName":"Delivery Persistent","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether persistent delivery is used by default."},"explicitQosEnabled":{"index":38,"kind":"parameter","displayName":"Explicit Qos Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."},"formatDateHeadersToIso8601":{"index":39,"kind":"parameter","displayName":"Format Date Headers To Iso8601","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether JMS date properties should be formatted according to the ISO 8601 standard."},"preserveMessageQos":{"index":40,"kind":"parameter","displayName":"Preserve Message Qos","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."},"priority":{"index":41,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","enum":["1","2","3","4","5","6","7","8","9"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":4,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect."},"replyToConcurrentConsumers":{"index":42,"kind":"parameter","displayName":"Reply To Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToMaxConcurrentConsumers":{"index":43,"kind":"parameter","displayName":"Reply To Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToOnTimeoutMaxConcurrentConsumers":{"index":44,"kind":"parameter","displayName":"Reply To On Timeout Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS."},"replyToOverride":{"index":45,"kind":"parameter","displayName":"Reply To Override","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."},"replyToType":{"index":46,"kind":"parameter","displayName":"Reply To Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ReplyToType","enum":["Temporary","Shared","Exclusive"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary, Shared, or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details, and especially the notes about the implications if running in a clustered environment, and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive."},"requestTimeout":{"index":47,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."},"timeToLive":{"index":48,"kind":"parameter","displayName":"Time To Live","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending messages, specifies the time-to-live of the message (in milliseconds)."},"allowAdditionalHeaders":{"index":49,"kind":"parameter","displayName":"Allow Additional Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"This option is used to allow additional headers which may have values that are invalid according to JMS specification. For example, some message systems, such as WMQ, do this with header names using prefix JMS_IBM_MQMD_ containing values with byte array or other invalid types. You can specify multiple header names separated by comma, and use as suffix for wildcard matching."},"allowNullBody":{"index":50,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."},"alwaysCopyMessage":{"index":51,"kind":"parameter","displayName":"Always Copy Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set)"},"correlationProperty":{"index":52,"kind":"parameter","displayName":"Correlation Property","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages. If set messages will be correlated solely on the value of this property JMSCorrelationID property will be ignored and not set by Camel."},"disableTimeToLive":{"index":53,"kind":"parameter","displayName":"Disable Time To Live","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."},"forceSendOriginalMessage":{"index":54,"kind":"parameter","displayName":"Force Send Original Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received."},"includeSentJMSMessageID":{"index":55,"kind":"parameter","displayName":"Include Sent JMSMessage ID","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination."},"lazyStartProducer":{"index":56,"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."},"replyToCacheLevelName":{"index":57,"kind":"parameter","displayName":"Reply To Cache Level Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed, and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION."},"replyToDestinationSelectorName":{"index":58,"kind":"parameter","displayName":"Reply To Destination Selector Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is, if you are not using a temporary reply queue)."},"streamMessageTypeEnabled":{"index":59,"kind":"parameter","displayName":"Stream Message Type Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data."},"allowSerializedHeaders":{"index":60,"kind":"parameter","displayName":"Allow Serialized Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Controls whether or not to include serialized headers. Applies only when transferExchange is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."},"artemisStreamingEnabled":{"index":61,"kind":"parameter","displayName":"Artemis Streaming Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether optimizing for Apache Artemis streaming mode. This can reduce memory overhead when using Artemis with JMS StreamMessage types. This option must only be enabled if Apache Artemis is being used."},"asyncStartListener":{"index":62,"kind":"parameter","displayName":"Async Start Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to startup the JmsConsumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail-over. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry."},"asyncStopListener":{"index":63,"kind":"parameter","displayName":"Async Stop Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to stop the JmsConsumer message listener asynchronously, when stopping a route."},"destinationResolver":{"index":64,"kind":"parameter","displayName":"Destination Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.destination.DestinationResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example, to lookup the real destination in a JNDI registry)."},"errorHandler":{"index":65,"kind":"parameter","displayName":"Error Handler","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.util.ErrorHandler","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level, if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure, than having to code a custom errorHandler."},"exceptionListener":{"index":66,"kind":"parameter","displayName":"Exception Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.jms.ExceptionListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions."},"headerFilterStrategy":{"index":67,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"idleConsumerLimit":{"index":68,"kind":"parameter","displayName":"Idle Consumer Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specify the limit for the number of consumers that are allowed to be idle at any given time."},"idleTaskExecutionLimit":{"index":69,"kind":"parameter","displayName":"Idle Task Execution Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring."},"includeAllJMSXProperties":{"index":70,"kind":"parameter","displayName":"Include All JMSXProperties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to include all JMSX prefixed properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply."},"jmsKeyFormatStrategy":{"index":71,"kind":"parameter","displayName":"Jms Key Format Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsKeyFormatStrategy","enum":["default","passthrough"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation."},"mapJmsMessage":{"index":72,"kind":"parameter","displayName":"Map Jms Message","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc."},"maxMessagesPerTask":{"index":73,"kind":"parameter","displayName":"Max Messages Per Task","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max), then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required."},"messageConverter":{"index":74,"kind":"parameter","displayName":"Message Converter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.converter.MessageConverter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a jakarta.jms.Message."},"messageCreatedStrategy":{"index":75,"kind":"parameter","displayName":"Message Created Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageCreatedStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message."},"messageIdEnabled":{"index":76,"kind":"parameter","displayName":"Message Id Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending, specifies whether message IDs should be added. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value."},"messageListenerContainerFactory":{"index":77,"kind":"parameter","displayName":"Message Listener Container Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageListenerContainerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom."},"messageTimestampEnabled":{"index":78,"kind":"parameter","displayName":"Message Timestamp Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint the timestamp must be set to its normal value."},"pubSubNoLocal":{"index":79,"kind":"parameter","displayName":"Pub Sub No Local","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to inhibit the delivery of messages published by its own connection."},"receiveTimeout":{"index":80,"kind":"parameter","displayName":"Receive Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for receiving messages (in milliseconds)."},"recoveryInterval":{"index":81,"kind":"parameter","displayName":"Recovery Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds."},"requestTimeoutCheckerInterval":{"index":82,"kind":"parameter","displayName":"Request Timeout Checker Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs, then you can lower this interval, to check more frequently. The timeout is determined by the option requestTimeout."},"synchronous":{"index":83,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used"},"temporaryQueueResolver":{"index":84,"kind":"parameter","displayName":"Temporary Queue Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.TemporaryQueueResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable TemporaryQueueResolver that allows you to use your own resolver for creating temporary queues (some messaging systems has special requirements for creating temporary queues)."},"transferException":{"index":85,"kind":"parameter","displayName":"Transfer Exception","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!"},"transferExchange":{"index":86,"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body, Out body, Fault body, In headers, Out headers, Fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side, so Camel knows the payloads is an Exchange and not a regular payload. Use this with caution as the data is using Java Object serialization and requires the receiver to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumers having to use compatible Camel versions!"},"useMessageIDAsCorrelationID":{"index":87,"kind":"parameter","displayName":"Use Message IDAs Correlation ID","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages."},"waitForProvisionCorrelationToBeUpdatedCounter":{"index":88,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":50,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled."},"waitForProvisionCorrelationToBeUpdatedThreadSleepingTime":{"index":89,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for provisional correlation id to be updated."},"waitForTemporaryReplyToToBeUpdatedCounter":{"index":90,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":200,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for temporary replyTo queue to be created and ready when doing request/reply over JMS."},"waitForTemporaryReplyToToBeUpdatedThreadSleepingTime":{"index":91,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for temporary replyTo queue to be ready."},"errorHandlerLoggingLevel":{"index":92,"kind":"parameter","displayName":"Error Handler Logging Level","group":"logging","label":"consumer,logging","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to configure the default errorHandler logging level for logging uncaught exceptions."},"errorHandlerLogStackTrace":{"index":93,"kind":"parameter","displayName":"Error Handler Log Stack Trace","group":"logging","label":"consumer,logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to control whether stack-traces should be logged or not, by the default errorHandler."},"password":{"index":94,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"username":{"index":95,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"transacted":{"index":96,"kind":"parameter","displayName":"Transacted","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use transacted mode"},"transactedInOut":{"index":97,"kind":"parameter","displayName":"Transacted In Out","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether InOut operations (request reply) default to using transacted mode If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations. Note from Spring JMS: that within a JTA transaction, the parameters passed to createQueue, createTopic methods are not taken into account. Depending on the Java EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since Spring JMS operates on an existing JMS Session in this case. Setting this flag to true will use a short local JMS transaction when running outside of a managed transaction, and a synchronized local JMS transaction in case of a managed transaction (other than an XA transaction) being present. This has the effect of a local JMS transaction being managed alongside the main transaction (which might be a native JDBC transaction), with the JMS transaction committing right after the main transaction."},"lazyCreateTransactionManager":{"index":98,"kind":"parameter","displayName":"Lazy Create Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true."},"transactionManager":{"index":99,"kind":"parameter","displayName":"Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"object","javaType":"org.springframework.transaction.PlatformTransactionManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The Spring transaction manager to use."},"transactionName":{"index":100,"kind":"parameter","displayName":"Transaction Name","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The name of the transaction to use."},"transactionTimeout":{"index":101,"kind":"parameter","displayName":"Transaction Timeout","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout value of the transaction (in seconds), if using transacted mode."}}} , -{"component":{"kind":"component","name":"amqp","title":"AMQP","description":"Messaging with AMQP protocol using Apache QPid Client.","deprecated":false,"firstVersion":"1.2.0","label":"messaging","javaType":"org.apache.camel.component.amqp.AMQPComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-amqp","version":"4.8.1","scheme":"amqp","extendsScheme":"jms","syntax":"amqp:destinationType:destinationName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJmsDestination":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION"},"CamelJmsDestinationName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic to use as destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME"},"CamelJMSDestinationProduced":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic the message was sent to.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME_PRODUCED"},"JMSXGroupID":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS group ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_X_GROUP_ID"},"JMSMessageID":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS unique message ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_MESSAGE_ID"},"JMSCorrelationID":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID"},"JMSCorrelationIDAsBytes":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID as bytes.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID_AS_BYTES"},"JMSDeliveryMode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS delivery mode.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DELIVERY_MODE"},"JMSDestination":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DESTINATION"},"JMSExpiration":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS expiration.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_EXPIRATION"},"JMSPriority":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS priority (with 0 as the lowest priority and 9 as the highest).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_PRIORITY"},"JMSRedelivered":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is the JMS message redelivered.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REDELIVERED"},"JMSTimestamp":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS timestamp.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TIMESTAMP"},"JMSReplyTo":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS reply-to destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REPLY_TO"},"JMSType":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TYPE"},"JMSXUserID":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XUser id.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_XUSER_ID"},"CamelJmsMessageType":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text","Blob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_MESSAGE_TYPE"},"CamelJmsRequestTimeout":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"20_000","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_REQUEST_TIMEOUT"}},"properties":{"destinationType":{"index":0,"kind":"path","displayName":"Destination Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["queue","topic","temp-queue","temp-topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"queue","description":"The kind of destination to use"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the queue or topic to use as destination"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions with JMS 1.1."},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"","required":false,"type":"object","javaType":"jakarta.jms.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"disableReplyTo":{"index":4,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."},"durableSubscriptionName":{"index":5,"kind":"parameter","displayName":"Durable Subscription Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."},"jmsMessageType":{"index":6,"kind":"parameter","displayName":"Jms Message Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to force the use of a specific jakarta.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it."},"replyTo":{"index":7,"kind":"parameter","displayName":"Reply To","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)."},"testConnectionOnStartup":{"index":8,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"acknowledgementModeName":{"index":9,"kind":"parameter","displayName":"Acknowledgement Mode Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["SESSION_TRANSACTED","CLIENT_ACKNOWLEDGE","AUTO_ACKNOWLEDGE","DUPS_OK_ACKNOWLEDGE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO_ACKNOWLEDGE","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"},"artemisConsumerPriority":{"index":10,"kind":"parameter","displayName":"Artemis Consumer Priority","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Consumer priorities allow you to ensure that high priority consumers receive messages while they are active. Normally, active consumers connected to a queue receive messages from it in a round-robin fashion. When consumer priorities are in use, messages are delivered round-robin if multiple active consumers exist with the same high priority. Messages will only going to lower priority consumers when the high priority consumers do not have credit available to consume the message, or those high priority consumers have declined to accept the message (for instance because it does not meet the criteria of any selectors associated with the consumer)."},"asyncConsumer":{"index":11,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."},"autoStartup":{"index":12,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer container should auto-startup."},"cacheLevel":{"index":13,"kind":"parameter","displayName":"Cache Level","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details."},"cacheLevelName":{"index":14,"kind":"parameter","displayName":"Cache Level Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CACHE_AUTO","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information."},"concurrentConsumers":{"index":15,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"maxConcurrentConsumers":{"index":16,"kind":"parameter","displayName":"Max Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"replyToDeliveryPersistent":{"index":17,"kind":"parameter","displayName":"Reply To Delivery Persistent","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use persistent delivery by default for replies."},"selector":{"index":18,"kind":"parameter","displayName":"Selector","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS selector to use"},"subscriptionDurable":{"index":19,"kind":"parameter","displayName":"Subscription Durable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well."},"subscriptionName":{"index":20,"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.jms.JmsConfiguration","configurationField":"configuration","description":"Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0)."},"subscriptionShared":{"index":21,"kind":"parameter","displayName":"Subscription Shared","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker."},"acceptMessagesWhileStopping":{"index":22,"kind":"parameter","displayName":"Accept Messages While Stopping","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option, if you start and stop JMS routes at runtime, while there are still messages enqueued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected, and the JMS broker would have to attempt redeliveries, which yet again may be rejected, and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option."},"allowReplyManagerQuickStop":{"index":23,"kind":"parameter","displayName":"Allow Reply Manager Quick Stop","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping is enabled, and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag."},"consumerType":{"index":24,"kind":"parameter","displayName":"Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type to use, which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"defaultTaskExecutorType":{"index":25,"kind":"parameter","displayName":"Default Task Executor Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.DefaultTaskExecutorType","enum":["ThreadPool","SimpleAsync"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer, for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached thread-pool-like). If not set, it defaults to the previous behaviour, which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers."},"eagerLoadingOfProperties":{"index":26,"kind":"parameter","displayName":"Eager Loading Of Properties","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties. See also the option eagerPoisonBody."},"eagerPoisonBody":{"index":27,"kind":"parameter","displayName":"Eager Poison Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Poison JMS message due to ${exception.message}","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties."},"exceptionHandler":{"index":28,"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":{"index":29,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"exposeListenerSession":{"index":30,"kind":"parameter","displayName":"Expose Listener Session","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the listener session should be exposed when consuming messages."},"replyToConsumerType":{"index":31,"kind":"parameter","displayName":"Reply To Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type of the reply consumer (when doing request/reply), which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"replyToSameDestinationAllowed":{"index":32,"kind":"parameter","displayName":"Reply To Same Destination Allowed","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself."},"taskExecutor":{"index":33,"kind":"parameter","displayName":"Task Executor","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.springframework.core.task.TaskExecutor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to specify a custom task executor for consuming messages."},"deliveryDelay":{"index":34,"kind":"parameter","displayName":"Delivery Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets delivery delay to use for send calls for JMS. This option requires JMS 2.0 compliant broker."},"deliveryMode":{"index":35,"kind":"parameter","displayName":"Delivery Mode","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","enum":["1","2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."},"deliveryPersistent":{"index":36,"kind":"parameter","displayName":"Delivery Persistent","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether persistent delivery is used by default."},"explicitQosEnabled":{"index":37,"kind":"parameter","displayName":"Explicit Qos Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."},"formatDateHeadersToIso8601":{"index":38,"kind":"parameter","displayName":"Format Date Headers To Iso8601","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether JMS date properties should be formatted according to the ISO 8601 standard."},"preserveMessageQos":{"index":39,"kind":"parameter","displayName":"Preserve Message Qos","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."},"priority":{"index":40,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","enum":["1","2","3","4","5","6","7","8","9"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":4,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect."},"replyToConcurrentConsumers":{"index":41,"kind":"parameter","displayName":"Reply To Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToMaxConcurrentConsumers":{"index":42,"kind":"parameter","displayName":"Reply To Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToOnTimeoutMaxConcurrentConsumers":{"index":43,"kind":"parameter","displayName":"Reply To On Timeout Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS."},"replyToOverride":{"index":44,"kind":"parameter","displayName":"Reply To Override","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."},"replyToType":{"index":45,"kind":"parameter","displayName":"Reply To Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ReplyToType","enum":["Temporary","Shared","Exclusive"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary, Shared, or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details, and especially the notes about the implications if running in a clustered environment, and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive."},"requestTimeout":{"index":46,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."},"timeToLive":{"index":47,"kind":"parameter","displayName":"Time To Live","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending messages, specifies the time-to-live of the message (in milliseconds)."},"allowAdditionalHeaders":{"index":48,"kind":"parameter","displayName":"Allow Additional Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"This option is used to allow additional headers which may have values that are invalid according to JMS specification. For example, some message systems, such as WMQ, do this with header names using prefix JMS_IBM_MQMD_ containing values with byte array or other invalid types. You can specify multiple header names separated by comma, and use as suffix for wildcard matching."},"allowNullBody":{"index":49,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."},"alwaysCopyMessage":{"index":50,"kind":"parameter","displayName":"Always Copy Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set)"},"correlationProperty":{"index":51,"kind":"parameter","displayName":"Correlation Property","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages. If set messages will be correlated solely on the value of this property JMSCorrelationID property will be ignored and not set by Camel."},"disableTimeToLive":{"index":52,"kind":"parameter","displayName":"Disable Time To Live","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."},"forceSendOriginalMessage":{"index":53,"kind":"parameter","displayName":"Force Send Original Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received."},"includeSentJMSMessageID":{"index":54,"kind":"parameter","displayName":"Include Sent JMSMessage ID","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination."},"lazyStartProducer":{"index":55,"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."},"replyToCacheLevelName":{"index":56,"kind":"parameter","displayName":"Reply To Cache Level Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed, and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION."},"replyToDestinationSelectorName":{"index":57,"kind":"parameter","displayName":"Reply To Destination Selector Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is, if you are not using a temporary reply queue)."},"streamMessageTypeEnabled":{"index":58,"kind":"parameter","displayName":"Stream Message Type Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data."},"allowSerializedHeaders":{"index":59,"kind":"parameter","displayName":"Allow Serialized Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Controls whether or not to include serialized headers. Applies only when transferExchange is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."},"artemisStreamingEnabled":{"index":60,"kind":"parameter","displayName":"Artemis Streaming Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether optimizing for Apache Artemis streaming mode. This can reduce memory overhead when using Artemis with JMS StreamMessage types. This option must only be enabled if Apache Artemis is being used."},"asyncStartListener":{"index":61,"kind":"parameter","displayName":"Async Start Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to startup the JmsConsumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail-over. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry."},"asyncStopListener":{"index":62,"kind":"parameter","displayName":"Async Stop Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to stop the JmsConsumer message listener asynchronously, when stopping a route."},"destinationResolver":{"index":63,"kind":"parameter","displayName":"Destination Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.destination.DestinationResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example, to lookup the real destination in a JNDI registry)."},"errorHandler":{"index":64,"kind":"parameter","displayName":"Error Handler","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.util.ErrorHandler","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level, if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure, than having to code a custom errorHandler."},"exceptionListener":{"index":65,"kind":"parameter","displayName":"Exception Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.jms.ExceptionListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions."},"headerFilterStrategy":{"index":66,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"idleConsumerLimit":{"index":67,"kind":"parameter","displayName":"Idle Consumer Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specify the limit for the number of consumers that are allowed to be idle at any given time."},"idleTaskExecutionLimit":{"index":68,"kind":"parameter","displayName":"Idle Task Execution Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring."},"includeAllJMSXProperties":{"index":69,"kind":"parameter","displayName":"Include All JMSXProperties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to include all JMSX prefixed properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply."},"jmsKeyFormatStrategy":{"index":70,"kind":"parameter","displayName":"Jms Key Format Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsKeyFormatStrategy","enum":["default","passthrough"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation."},"mapJmsMessage":{"index":71,"kind":"parameter","displayName":"Map Jms Message","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc."},"maxMessagesPerTask":{"index":72,"kind":"parameter","displayName":"Max Messages Per Task","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max), then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required."},"messageConverter":{"index":73,"kind":"parameter","displayName":"Message Converter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.converter.MessageConverter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a jakarta.jms.Message."},"messageCreatedStrategy":{"index":74,"kind":"parameter","displayName":"Message Created Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageCreatedStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message."},"messageIdEnabled":{"index":75,"kind":"parameter","displayName":"Message Id Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending, specifies whether message IDs should be added. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value."},"messageListenerContainerFactory":{"index":76,"kind":"parameter","displayName":"Message Listener Container Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageListenerContainerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom."},"messageTimestampEnabled":{"index":77,"kind":"parameter","displayName":"Message Timestamp Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint the timestamp must be set to its normal value."},"pubSubNoLocal":{"index":78,"kind":"parameter","displayName":"Pub Sub No Local","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to inhibit the delivery of messages published by its own connection."},"receiveTimeout":{"index":79,"kind":"parameter","displayName":"Receive Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for receiving messages (in milliseconds)."},"recoveryInterval":{"index":80,"kind":"parameter","displayName":"Recovery Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds."},"requestTimeoutCheckerInterval":{"index":81,"kind":"parameter","displayName":"Request Timeout Checker Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs, then you can lower this interval, to check more frequently. The timeout is determined by the option requestTimeout."},"synchronous":{"index":82,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used"},"temporaryQueueResolver":{"index":83,"kind":"parameter","displayName":"Temporary Queue Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.TemporaryQueueResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable TemporaryQueueResolver that allows you to use your own resolver for creating temporary queues (some messaging systems has special requirements for creating temporary queues)."},"transferException":{"index":84,"kind":"parameter","displayName":"Transfer Exception","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!"},"transferExchange":{"index":85,"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body, Out body, Fault body, In headers, Out headers, Fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side, so Camel knows the payloads is an Exchange and not a regular payload. Use this with caution as the data is using Java Object serialization and requires the receiver to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumers having to use compatible Camel versions!"},"useMessageIDAsCorrelationID":{"index":86,"kind":"parameter","displayName":"Use Message IDAs Correlation ID","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages."},"waitForProvisionCorrelationToBeUpdatedCounter":{"index":87,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":50,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled."},"waitForProvisionCorrelationToBeUpdatedThreadSleepingTime":{"index":88,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for provisional correlation id to be updated."},"waitForTemporaryReplyToToBeUpdatedCounter":{"index":89,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":200,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for temporary replyTo queue to be created and ready when doing request/reply over JMS."},"waitForTemporaryReplyToToBeUpdatedThreadSleepingTime":{"index":90,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for temporary replyTo queue to be ready."},"errorHandlerLoggingLevel":{"index":91,"kind":"parameter","displayName":"Error Handler Logging Level","group":"logging","label":"consumer,logging","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to configure the default errorHandler logging level for logging uncaught exceptions."},"errorHandlerLogStackTrace":{"index":92,"kind":"parameter","displayName":"Error Handler Log Stack Trace","group":"logging","label":"consumer,logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to control whether stack-traces should be logged or not, by the default errorHandler."},"password":{"index":93,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"username":{"index":94,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"transacted":{"index":95,"kind":"parameter","displayName":"Transacted","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use transacted mode"},"transactedInOut":{"index":96,"kind":"parameter","displayName":"Transacted In Out","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether InOut operations (request reply) default to using transacted mode If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations. Note from Spring JMS: that within a JTA transaction, the parameters passed to createQueue, createTopic methods are not taken into account. Depending on the Java EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since Spring JMS operates on an existing JMS Session in this case. Setting this flag to true will use a short local JMS transaction when running outside of a managed transaction, and a synchronized local JMS transaction in case of a managed transaction (other than an XA transaction) being present. This has the effect of a local JMS transaction being managed alongside the main transaction (which might be a native JDBC transaction), with the JMS transaction committing right after the main transaction."},"lazyCreateTransactionManager":{"index":97,"kind":"parameter","displayName":"Lazy Create Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true."},"transactionManager":{"index":98,"kind":"parameter","displayName":"Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"object","javaType":"org.springframework.transaction.PlatformTransactionManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The Spring transaction manager to use."},"transactionName":{"index":99,"kind":"parameter","displayName":"Transaction Name","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The name of the transaction to use."},"transactionTimeout":{"index":100,"kind":"parameter","displayName":"Transaction Timeout","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout value of the transaction (in seconds), if using transacted mode."}}} +{"component":{"kind":"component","name":"amqp","title":"AMQP","description":"Messaging with AMQP protocol using Apache QPid Client.","deprecated":false,"firstVersion":"1.2.0","label":"messaging","javaType":"org.apache.camel.component.amqp.AMQPComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-amqp","version":"4.8.2","scheme":"amqp","extendsScheme":"jms","syntax":"amqp:destinationType:destinationName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJmsDestination":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION"},"CamelJmsDestinationName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic to use as destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME"},"CamelJMSDestinationProduced":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic the message was sent to.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME_PRODUCED"},"JMSXGroupID":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS group ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_X_GROUP_ID"},"JMSMessageID":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS unique message ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_MESSAGE_ID"},"JMSCorrelationID":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID"},"JMSCorrelationIDAsBytes":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID as bytes.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID_AS_BYTES"},"JMSDeliveryMode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS delivery mode.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DELIVERY_MODE"},"JMSDestination":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DESTINATION"},"JMSExpiration":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS expiration.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_EXPIRATION"},"JMSPriority":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS priority (with 0 as the lowest priority and 9 as the highest).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_PRIORITY"},"JMSRedelivered":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is the JMS message redelivered.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REDELIVERED"},"JMSTimestamp":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS timestamp.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TIMESTAMP"},"JMSReplyTo":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS reply-to destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REPLY_TO"},"JMSType":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TYPE"},"JMSXUserID":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XUser id.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_XUSER_ID"},"CamelJmsMessageType":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text","Blob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_MESSAGE_TYPE"},"CamelJmsRequestTimeout":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"20_000","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_REQUEST_TIMEOUT"}},"properties":{"destinationType":{"index":0,"kind":"path","displayName":"Destination Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["queue","topic","temp-queue","temp-topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"queue","description":"The kind of destination to use"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the queue or topic to use as destination"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions with JMS 1.1."},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"","required":false,"type":"object","javaType":"jakarta.jms.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"disableReplyTo":{"index":4,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."},"durableSubscriptionName":{"index":5,"kind":"parameter","displayName":"Durable Subscription Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."},"jmsMessageType":{"index":6,"kind":"parameter","displayName":"Jms Message Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to force the use of a specific jakarta.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it."},"replyTo":{"index":7,"kind":"parameter","displayName":"Reply To","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)."},"testConnectionOnStartup":{"index":8,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"acknowledgementModeName":{"index":9,"kind":"parameter","displayName":"Acknowledgement Mode Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["SESSION_TRANSACTED","CLIENT_ACKNOWLEDGE","AUTO_ACKNOWLEDGE","DUPS_OK_ACKNOWLEDGE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO_ACKNOWLEDGE","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"},"artemisConsumerPriority":{"index":10,"kind":"parameter","displayName":"Artemis Consumer Priority","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Consumer priorities allow you to ensure that high priority consumers receive messages while they are active. Normally, active consumers connected to a queue receive messages from it in a round-robin fashion. When consumer priorities are in use, messages are delivered round-robin if multiple active consumers exist with the same high priority. Messages will only going to lower priority consumers when the high priority consumers do not have credit available to consume the message, or those high priority consumers have declined to accept the message (for instance because it does not meet the criteria of any selectors associated with the consumer)."},"asyncConsumer":{"index":11,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."},"autoStartup":{"index":12,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer container should auto-startup."},"cacheLevel":{"index":13,"kind":"parameter","displayName":"Cache Level","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details."},"cacheLevelName":{"index":14,"kind":"parameter","displayName":"Cache Level Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CACHE_AUTO","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information."},"concurrentConsumers":{"index":15,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"maxConcurrentConsumers":{"index":16,"kind":"parameter","displayName":"Max Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"replyToDeliveryPersistent":{"index":17,"kind":"parameter","displayName":"Reply To Delivery Persistent","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use persistent delivery by default for replies."},"selector":{"index":18,"kind":"parameter","displayName":"Selector","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS selector to use"},"subscriptionDurable":{"index":19,"kind":"parameter","displayName":"Subscription Durable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well."},"subscriptionName":{"index":20,"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.jms.JmsConfiguration","configurationField":"configuration","description":"Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0)."},"subscriptionShared":{"index":21,"kind":"parameter","displayName":"Subscription Shared","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker."},"acceptMessagesWhileStopping":{"index":22,"kind":"parameter","displayName":"Accept Messages While Stopping","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option, if you start and stop JMS routes at runtime, while there are still messages enqueued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected, and the JMS broker would have to attempt redeliveries, which yet again may be rejected, and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option."},"allowReplyManagerQuickStop":{"index":23,"kind":"parameter","displayName":"Allow Reply Manager Quick Stop","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping is enabled, and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag."},"consumerType":{"index":24,"kind":"parameter","displayName":"Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type to use, which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"defaultTaskExecutorType":{"index":25,"kind":"parameter","displayName":"Default Task Executor Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.DefaultTaskExecutorType","enum":["ThreadPool","SimpleAsync"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer, for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached thread-pool-like). If not set, it defaults to the previous behaviour, which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers."},"eagerLoadingOfProperties":{"index":26,"kind":"parameter","displayName":"Eager Loading Of Properties","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties. See also the option eagerPoisonBody."},"eagerPoisonBody":{"index":27,"kind":"parameter","displayName":"Eager Poison Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Poison JMS message due to ${exception.message}","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties."},"exceptionHandler":{"index":28,"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":{"index":29,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"exposeListenerSession":{"index":30,"kind":"parameter","displayName":"Expose Listener Session","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the listener session should be exposed when consuming messages."},"replyToConsumerType":{"index":31,"kind":"parameter","displayName":"Reply To Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type of the reply consumer (when doing request/reply), which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"replyToSameDestinationAllowed":{"index":32,"kind":"parameter","displayName":"Reply To Same Destination Allowed","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself."},"taskExecutor":{"index":33,"kind":"parameter","displayName":"Task Executor","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.springframework.core.task.TaskExecutor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to specify a custom task executor for consuming messages."},"deliveryDelay":{"index":34,"kind":"parameter","displayName":"Delivery Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets delivery delay to use for send calls for JMS. This option requires JMS 2.0 compliant broker."},"deliveryMode":{"index":35,"kind":"parameter","displayName":"Delivery Mode","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","enum":["1","2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."},"deliveryPersistent":{"index":36,"kind":"parameter","displayName":"Delivery Persistent","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether persistent delivery is used by default."},"explicitQosEnabled":{"index":37,"kind":"parameter","displayName":"Explicit Qos Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."},"formatDateHeadersToIso8601":{"index":38,"kind":"parameter","displayName":"Format Date Headers To Iso8601","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether JMS date properties should be formatted according to the ISO 8601 standard."},"preserveMessageQos":{"index":39,"kind":"parameter","displayName":"Preserve Message Qos","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."},"priority":{"index":40,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","enum":["1","2","3","4","5","6","7","8","9"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":4,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect."},"replyToConcurrentConsumers":{"index":41,"kind":"parameter","displayName":"Reply To Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToMaxConcurrentConsumers":{"index":42,"kind":"parameter","displayName":"Reply To Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToOnTimeoutMaxConcurrentConsumers":{"index":43,"kind":"parameter","displayName":"Reply To On Timeout Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS."},"replyToOverride":{"index":44,"kind":"parameter","displayName":"Reply To Override","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."},"replyToType":{"index":45,"kind":"parameter","displayName":"Reply To Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ReplyToType","enum":["Temporary","Shared","Exclusive"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary, Shared, or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details, and especially the notes about the implications if running in a clustered environment, and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive."},"requestTimeout":{"index":46,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."},"timeToLive":{"index":47,"kind":"parameter","displayName":"Time To Live","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending messages, specifies the time-to-live of the message (in milliseconds)."},"allowAdditionalHeaders":{"index":48,"kind":"parameter","displayName":"Allow Additional Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"This option is used to allow additional headers which may have values that are invalid according to JMS specification. For example, some message systems, such as WMQ, do this with header names using prefix JMS_IBM_MQMD_ containing values with byte array or other invalid types. You can specify multiple header names separated by comma, and use as suffix for wildcard matching."},"allowNullBody":{"index":49,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."},"alwaysCopyMessage":{"index":50,"kind":"parameter","displayName":"Always Copy Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set)"},"correlationProperty":{"index":51,"kind":"parameter","displayName":"Correlation Property","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages. If set messages will be correlated solely on the value of this property JMSCorrelationID property will be ignored and not set by Camel."},"disableTimeToLive":{"index":52,"kind":"parameter","displayName":"Disable Time To Live","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."},"forceSendOriginalMessage":{"index":53,"kind":"parameter","displayName":"Force Send Original Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received."},"includeSentJMSMessageID":{"index":54,"kind":"parameter","displayName":"Include Sent JMSMessage ID","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination."},"lazyStartProducer":{"index":55,"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."},"replyToCacheLevelName":{"index":56,"kind":"parameter","displayName":"Reply To Cache Level Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed, and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION."},"replyToDestinationSelectorName":{"index":57,"kind":"parameter","displayName":"Reply To Destination Selector Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is, if you are not using a temporary reply queue)."},"streamMessageTypeEnabled":{"index":58,"kind":"parameter","displayName":"Stream Message Type Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data."},"allowSerializedHeaders":{"index":59,"kind":"parameter","displayName":"Allow Serialized Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Controls whether or not to include serialized headers. Applies only when transferExchange is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."},"artemisStreamingEnabled":{"index":60,"kind":"parameter","displayName":"Artemis Streaming Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether optimizing for Apache Artemis streaming mode. This can reduce memory overhead when using Artemis with JMS StreamMessage types. This option must only be enabled if Apache Artemis is being used."},"asyncStartListener":{"index":61,"kind":"parameter","displayName":"Async Start Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to startup the JmsConsumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail-over. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry."},"asyncStopListener":{"index":62,"kind":"parameter","displayName":"Async Stop Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to stop the JmsConsumer message listener asynchronously, when stopping a route."},"destinationResolver":{"index":63,"kind":"parameter","displayName":"Destination Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.destination.DestinationResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example, to lookup the real destination in a JNDI registry)."},"errorHandler":{"index":64,"kind":"parameter","displayName":"Error Handler","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.util.ErrorHandler","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level, if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure, than having to code a custom errorHandler."},"exceptionListener":{"index":65,"kind":"parameter","displayName":"Exception Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.jms.ExceptionListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions."},"headerFilterStrategy":{"index":66,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"idleConsumerLimit":{"index":67,"kind":"parameter","displayName":"Idle Consumer Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specify the limit for the number of consumers that are allowed to be idle at any given time."},"idleTaskExecutionLimit":{"index":68,"kind":"parameter","displayName":"Idle Task Execution Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring."},"includeAllJMSXProperties":{"index":69,"kind":"parameter","displayName":"Include All JMSXProperties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to include all JMSX prefixed properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply."},"jmsKeyFormatStrategy":{"index":70,"kind":"parameter","displayName":"Jms Key Format Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsKeyFormatStrategy","enum":["default","passthrough"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation."},"mapJmsMessage":{"index":71,"kind":"parameter","displayName":"Map Jms Message","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc."},"maxMessagesPerTask":{"index":72,"kind":"parameter","displayName":"Max Messages Per Task","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max), then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required."},"messageConverter":{"index":73,"kind":"parameter","displayName":"Message Converter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.converter.MessageConverter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a jakarta.jms.Message."},"messageCreatedStrategy":{"index":74,"kind":"parameter","displayName":"Message Created Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageCreatedStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message."},"messageIdEnabled":{"index":75,"kind":"parameter","displayName":"Message Id Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending, specifies whether message IDs should be added. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value."},"messageListenerContainerFactory":{"index":76,"kind":"parameter","displayName":"Message Listener Container Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageListenerContainerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom."},"messageTimestampEnabled":{"index":77,"kind":"parameter","displayName":"Message Timestamp Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint the timestamp must be set to its normal value."},"pubSubNoLocal":{"index":78,"kind":"parameter","displayName":"Pub Sub No Local","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to inhibit the delivery of messages published by its own connection."},"receiveTimeout":{"index":79,"kind":"parameter","displayName":"Receive Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for receiving messages (in milliseconds)."},"recoveryInterval":{"index":80,"kind":"parameter","displayName":"Recovery Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds."},"requestTimeoutCheckerInterval":{"index":81,"kind":"parameter","displayName":"Request Timeout Checker Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs, then you can lower this interval, to check more frequently. The timeout is determined by the option requestTimeout."},"synchronous":{"index":82,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used"},"temporaryQueueResolver":{"index":83,"kind":"parameter","displayName":"Temporary Queue Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.TemporaryQueueResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable TemporaryQueueResolver that allows you to use your own resolver for creating temporary queues (some messaging systems has special requirements for creating temporary queues)."},"transferException":{"index":84,"kind":"parameter","displayName":"Transfer Exception","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!"},"transferExchange":{"index":85,"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body, Out body, Fault body, In headers, Out headers, Fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side, so Camel knows the payloads is an Exchange and not a regular payload. Use this with caution as the data is using Java Object serialization and requires the receiver to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumers having to use compatible Camel versions!"},"useMessageIDAsCorrelationID":{"index":86,"kind":"parameter","displayName":"Use Message IDAs Correlation ID","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages."},"waitForProvisionCorrelationToBeUpdatedCounter":{"index":87,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":50,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled."},"waitForProvisionCorrelationToBeUpdatedThreadSleepingTime":{"index":88,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for provisional correlation id to be updated."},"waitForTemporaryReplyToToBeUpdatedCounter":{"index":89,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":200,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for temporary replyTo queue to be created and ready when doing request/reply over JMS."},"waitForTemporaryReplyToToBeUpdatedThreadSleepingTime":{"index":90,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for temporary replyTo queue to be ready."},"errorHandlerLoggingLevel":{"index":91,"kind":"parameter","displayName":"Error Handler Logging Level","group":"logging","label":"consumer,logging","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to configure the default errorHandler logging level for logging uncaught exceptions."},"errorHandlerLogStackTrace":{"index":92,"kind":"parameter","displayName":"Error Handler Log Stack Trace","group":"logging","label":"consumer,logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to control whether stack-traces should be logged or not, by the default errorHandler."},"password":{"index":93,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"username":{"index":94,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"transacted":{"index":95,"kind":"parameter","displayName":"Transacted","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use transacted mode"},"transactedInOut":{"index":96,"kind":"parameter","displayName":"Transacted In Out","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether InOut operations (request reply) default to using transacted mode If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations. Note from Spring JMS: that within a JTA transaction, the parameters passed to createQueue, createTopic methods are not taken into account. Depending on the Java EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since Spring JMS operates on an existing JMS Session in this case. Setting this flag to true will use a short local JMS transaction when running outside of a managed transaction, and a synchronized local JMS transaction in case of a managed transaction (other than an XA transaction) being present. This has the effect of a local JMS transaction being managed alongside the main transaction (which might be a native JDBC transaction), with the JMS transaction committing right after the main transaction."},"lazyCreateTransactionManager":{"index":97,"kind":"parameter","displayName":"Lazy Create Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true."},"transactionManager":{"index":98,"kind":"parameter","displayName":"Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"object","javaType":"org.springframework.transaction.PlatformTransactionManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The Spring transaction manager to use."},"transactionName":{"index":99,"kind":"parameter","displayName":"Transaction Name","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The name of the transaction to use."},"transactionTimeout":{"index":100,"kind":"parameter","displayName":"Transaction Timeout","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout value of the transaction (in seconds), if using transacted mode."}}} , -{"component":{"kind":"component","name":"arangodb","title":"ArangoDb","description":"Perform operations on ArangoDb when used as a Document Database, or as a Graph Database","deprecated":false,"firstVersion":"3.5.0","label":"database","javaType":"org.apache.camel.component.arangodb.ArangoDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-arangodb","version":"4.8.1","scheme":"arangodb","extendsScheme":"","syntax":"arangodb:database","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelArangoDbMultiUpdate":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Indicates if there are multiple documents to update. If set to true, the body of the message must be a Collection of documents to update.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_UPDATE"},"CamelArangoDbMultiInsert":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Indicates if there are multiple documents to insert. If set to true, the body of the message must be a Collection of documents to insert.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_INSERT"},"CamelArangoDbMultiDelete":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Indicates if there are multiple documents to delete. If set to true, the body of the message must be a Collection of key of documents to delete.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_DELETE"},"key":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Arango key to use for the operation.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#ARANGO_KEY"},"ResultClassType":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"BaseDocument.class or BaseEdgeDocument.class","description":"The type of the result of the operation.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#RESULT_CLASS_TYPE"},"CamelArangoDbAqlQuery":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The AQL query to execute.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY"},"CamelArangoDbAqlParameters":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.util.Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key/value pairs defining the variables to bind the query to.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY_BIND_PARAMETERS"},"CamelArangoDbAqlOptions":{"index":7,"kind":"header","displayName":"","group":"advanced","label":"advanced","required":false,"javaType":"com.arangodb.model.AqlQueryOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The additional options that will be passed to the query API.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY_OPTIONS"}},"properties":{"database":{"index":0,"kind":"path","displayName":"Database","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"database name"},"documentCollection":{"index":1,"kind":"parameter","displayName":"Document Collection","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Collection name, when using ArangoDb as a Document Database. Set the documentCollection name when using the CRUD operation on the document database collections (SAVE_DOCUMENT , FIND_DOCUMENT_BY_KEY, UPDATE_DOCUMENT, DELETE_DOCUMENT)."},"edgeCollection":{"index":2,"kind":"parameter","displayName":"Edge Collection","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Collection name of vertices, when using ArangoDb as a Graph Database. Set the edgeCollection name to perform CRUD operation on edges using these operations : SAVE_VERTEX, FIND_VERTEX_BY_KEY, UPDATE_VERTEX, DELETE_VERTEX. The graph attribute is mandatory."},"graph":{"index":3,"kind":"parameter","displayName":"Graph","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Graph name, when using ArangoDb as a Graph Database. Combine this attribute with one of the two attributes vertexCollection and edgeCollection."},"host":{"index":4,"kind":"parameter","displayName":"Host","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"ArangoDB host. If host and port are default, this field is Optional."},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.arangodb.ArangoDbOperation","enum":["SAVE_DOCUMENT","FIND_DOCUMENT_BY_KEY","UPDATE_DOCUMENT","DELETE_DOCUMENT","AQL_QUERY","SAVE_VERTEX","FIND_VERTEX_BY_KEY","UPDATE_VERTEX","DELETE_VERTEX","SAVE_EDGE","FIND_EDGE_BY_KEY","UPDATE_EDGE","DELETE_EDGE"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Operations to perform on ArangoDb. For the operation AQL_QUERY, no need to specify a collection or graph."},"port":{"index":6,"kind":"parameter","displayName":"Port","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"ArangoDB exposed port. If host and port are default, this field is Optional."},"vertexCollection":{"index":7,"kind":"parameter","displayName":"Vertex Collection","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Collection name of vertices, when using ArangoDb as a Graph Database. Set the vertexCollection name to perform CRUD operation on vertices using these operations : SAVE_EDGE, FIND_EDGE_BY_KEY, UPDATE_EDGE, DELETE_EDGE. The graph attribute is mandatory."},"lazyStartProducer":{"index":8,"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."},"arangoDB":{"index":9,"kind":"parameter","displayName":"Arango DB","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.arangodb.ArangoDB","deprecated":false,"autowired":false,"secret":false,"description":"To use an existing ArangDB client."},"vertx":{"index":10,"kind":"parameter","displayName":"Vertx","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.vertx.core.Vertx","deprecated":false,"autowired":false,"secret":false,"description":"To use an existing Vertx instance in the ArangoDB client."},"password":{"index":11,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"ArangoDB password. If user and password are default, this field is Optional."},"user":{"index":12,"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"ArangoDB user. If user and password are default, this field is Optional."}}} +{"component":{"kind":"component","name":"arangodb","title":"ArangoDb","description":"Perform operations on ArangoDb when used as a Document Database, or as a Graph Database","deprecated":false,"firstVersion":"3.5.0","label":"database","javaType":"org.apache.camel.component.arangodb.ArangoDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-arangodb","version":"4.8.2","scheme":"arangodb","extendsScheme":"","syntax":"arangodb:database","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelArangoDbMultiUpdate":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Indicates if there are multiple documents to update. If set to true, the body of the message must be a Collection of documents to update.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_UPDATE"},"CamelArangoDbMultiInsert":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Indicates if there are multiple documents to insert. If set to true, the body of the message must be a Collection of documents to insert.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_INSERT"},"CamelArangoDbMultiDelete":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Indicates if there are multiple documents to delete. If set to true, the body of the message must be a Collection of key of documents to delete.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_DELETE"},"key":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Arango key to use for the operation.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#ARANGO_KEY"},"ResultClassType":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"BaseDocument.class or BaseEdgeDocument.class","description":"The type of the result of the operation.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#RESULT_CLASS_TYPE"},"CamelArangoDbAqlQuery":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The AQL query to execute.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY"},"CamelArangoDbAqlParameters":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.util.Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key/value pairs defining the variables to bind the query to.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY_BIND_PARAMETERS"},"CamelArangoDbAqlOptions":{"index":7,"kind":"header","displayName":"","group":"advanced","label":"advanced","required":false,"javaType":"com.arangodb.model.AqlQueryOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The additional options that will be passed to the query API.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY_OPTIONS"}},"properties":{"database":{"index":0,"kind":"path","displayName":"Database","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"database name"},"documentCollection":{"index":1,"kind":"parameter","displayName":"Document Collection","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Collection name, when using ArangoDb as a Document Database. Set the documentCollection name when using the CRUD operation on the document database collections (SAVE_DOCUMENT , FIND_DOCUMENT_BY_KEY, UPDATE_DOCUMENT, DELETE_DOCUMENT)."},"edgeCollection":{"index":2,"kind":"parameter","displayName":"Edge Collection","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Collection name of vertices, when using ArangoDb as a Graph Database. Set the edgeCollection name to perform CRUD operation on edges using these operations : SAVE_VERTEX, FIND_VERTEX_BY_KEY, UPDATE_VERTEX, DELETE_VERTEX. The graph attribute is mandatory."},"graph":{"index":3,"kind":"parameter","displayName":"Graph","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Graph name, when using ArangoDb as a Graph Database. Combine this attribute with one of the two attributes vertexCollection and edgeCollection."},"host":{"index":4,"kind":"parameter","displayName":"Host","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"ArangoDB host. If host and port are default, this field is Optional."},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.arangodb.ArangoDbOperation","enum":["SAVE_DOCUMENT","FIND_DOCUMENT_BY_KEY","UPDATE_DOCUMENT","DELETE_DOCUMENT","AQL_QUERY","SAVE_VERTEX","FIND_VERTEX_BY_KEY","UPDATE_VERTEX","DELETE_VERTEX","SAVE_EDGE","FIND_EDGE_BY_KEY","UPDATE_EDGE","DELETE_EDGE"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Operations to perform on ArangoDb. For the operation AQL_QUERY, no need to specify a collection or graph."},"port":{"index":6,"kind":"parameter","displayName":"Port","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"ArangoDB exposed port. If host and port are default, this field is Optional."},"vertexCollection":{"index":7,"kind":"parameter","displayName":"Vertex Collection","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Collection name of vertices, when using ArangoDb as a Graph Database. Set the vertexCollection name to perform CRUD operation on vertices using these operations : SAVE_EDGE, FIND_EDGE_BY_KEY, UPDATE_EDGE, DELETE_EDGE. The graph attribute is mandatory."},"lazyStartProducer":{"index":8,"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."},"arangoDB":{"index":9,"kind":"parameter","displayName":"Arango DB","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.arangodb.ArangoDB","deprecated":false,"autowired":false,"secret":false,"description":"To use an existing ArangDB client."},"vertx":{"index":10,"kind":"parameter","displayName":"Vertx","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.vertx.core.Vertx","deprecated":false,"autowired":false,"secret":false,"description":"To use an existing Vertx instance in the ArangoDB client."},"password":{"index":11,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"ArangoDB password. If user and password are default, this field is Optional."},"user":{"index":12,"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"ArangoDB user. If user and password are default, this field is Optional."}}} , -{"component":{"kind":"component","name":"as2","title":"AS2","description":"Transfer data securely and reliably using the AS2 protocol (RFC4130).","deprecated":false,"firstVersion":"2.22.0","label":"file","javaType":"org.apache.camel.component.as2.AS2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-as2","version":"4.8.1","scheme":"as2","extendsScheme":"","syntax":"as2:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.as2.internal.AS2ApiName","enum":["CLIENT","SERVER","RECEIPT"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"as2From":{"index":2,"kind":"parameter","displayName":"As2 From","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The value of the AS2From header of AS2 message."},"as2MessageStructure":{"index":3,"kind":"parameter","displayName":"As2 Message Structure","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2MessageStructure","enum":["PLAIN","SIGNED","ENCRYPTED","SIGNED_ENCRYPTED","PLAIN_COMPRESSED","COMPRESSED_SIGNED","SIGNED_COMPRESSED","ENCRYPTED_COMPRESSED","ENCRYPTED_COMPRESSED_SIGNED","ENCRYPTED_SIGNED_COMPRESSED"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The structure of AS2 Message. One of: PLAIN - No encryption, no signature, SIGNED - No encryption, signature, ENCRYPTED - Encryption, no signature, ENCRYPTED_SIGNED - Encryption, signature"},"as2To":{"index":4,"kind":"parameter","displayName":"As2 To","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The value of the AS2To header of AS2 message."},"as2Version":{"index":5,"kind":"parameter","displayName":"As2 Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["1.0","1.1"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"1.1","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The version of the AS2 protocol."},"asyncMdnPortNumber":{"index":6,"kind":"parameter","displayName":"Async Mdn Port Number","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The port number of asynchronous MDN server."},"attachedFileName":{"index":7,"kind":"parameter","displayName":"Attached File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The name of the attached file"},"clientFqdn":{"index":8,"kind":"parameter","displayName":"Client Fqdn","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel.apache.org","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The Client Fully Qualified Domain Name (FQDN). Used in message ids sent by endpoint."},"compressionAlgorithm":{"index":9,"kind":"parameter","displayName":"Compression Algorithm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2CompressionAlgorithm","enum":["ZLIB"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The algorithm used to compress EDI message."},"dispositionNotificationTo":{"index":10,"kind":"parameter","displayName":"Disposition Notification To","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The value of the Disposition-Notification-To header. Assigning a value to this parameter requests a message disposition notification (MDN) for the AS2 message."},"ediMessageTransferEncoding":{"index":11,"kind":"parameter","displayName":"Edi Message Transfer Encoding","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The transfer encoding of EDI message."},"ediMessageType":{"index":12,"kind":"parameter","displayName":"Edi Message Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.hc.core5.http.ContentType","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The content type of EDI message. One of application/edifact, application/edi-x12, application/edi-consent, application/xml"},"from":{"index":13,"kind":"parameter","displayName":"From","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The value of the From header of AS2 message."},"hostnameVerifier":{"index":14,"kind":"parameter","displayName":"Hostname Verifier","group":"common","label":"","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"Set hostname verifier for SSL session."},"httpConnectionPoolSize":{"index":15,"kind":"parameter","displayName":"Http Connection Pool Size","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The maximum size of the connection pool for http connections (client only)"},"httpConnectionPoolTtl":{"index":16,"kind":"parameter","displayName":"Http Connection Pool Ttl","group":"common","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"defaultValue":"15m","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The time to live for connections in the connection pool (client only)"},"httpConnectionTimeout":{"index":17,"kind":"parameter","displayName":"Http Connection Timeout","group":"common","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The timeout of the http connection (client only)"},"httpSocketTimeout":{"index":18,"kind":"parameter","displayName":"Http Socket Timeout","group":"common","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The timeout of the underlying http socket (client only)"},"inBody":{"index":19,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"mdnMessageTemplate":{"index":20,"kind":"parameter","displayName":"Mdn Message Template","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The template used to format MDN message"},"receiptDeliveryOption":{"index":21,"kind":"parameter","displayName":"Receipt Delivery Option","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The return URL that the message receiver should send an asynchronous MDN to. If not present the receipt is synchronous. (Client only)"},"requestUri":{"index":22,"kind":"parameter","displayName":"Request Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"/","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The request URI of EDI message."},"server":{"index":23,"kind":"parameter","displayName":"Server","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Camel AS2 Server Endpoint","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The value included in the Server message header identifying the AS2 Server."},"serverFqdn":{"index":24,"kind":"parameter","displayName":"Server Fqdn","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel.apache.org","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The Server Fully Qualified Domain Name (FQDN). Used in message ids sent by endpoint."},"serverPortNumber":{"index":25,"kind":"parameter","displayName":"Server Port Number","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The port number of server."},"sslContext":{"index":26,"kind":"parameter","displayName":"Ssl Context","group":"common","label":"","required":false,"type":"object","javaType":"javax.net.ssl.SSLContext","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"Set SSL context for connection to remote server."},"subject":{"index":27,"kind":"parameter","displayName":"Subject","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The value of Subject header of AS2 message."},"targetHostname":{"index":28,"kind":"parameter","displayName":"Target Hostname","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The host name (IP or DNS name) of target host."},"targetPortNumber":{"index":29,"kind":"parameter","displayName":"Target Port Number","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"80","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The port number of target host. -1 indicates the scheme default port."},"userAgent":{"index":30,"kind":"parameter","displayName":"User Agent","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Camel AS2 Client Endpoint","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The value included in the User-Agent message header identifying the AS2 user agent."},"exceptionHandler":{"index":31,"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":{"index":32,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":33,"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."},"decryptingPrivateKey":{"index":34,"kind":"parameter","displayName":"Decrypting Private Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The key used to encrypt the EDI message."},"encryptingAlgorithm":{"index":35,"kind":"parameter","displayName":"Encrypting Algorithm","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2EncryptionAlgorithm","enum":["AES128_CBC","AES192_CBC","AES256_CBC","AES128_CCM","AES192_CCM","AES256_CCM","AES128_GCM","AES192_GCM","AES256_GCM","CAMELLIA128_CBC","CAMELLIA192_CBC","CAMELLIA256_CBC","CAST5_CBC","DES_CBC","DES_EDE3_CBC","GOST28147_GCFB","IDEA_CBC","RC2_CBC","RC4","SEED_CBC"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The algorithm used to encrypt EDI message."},"encryptingCertificateChain":{"index":36,"kind":"parameter","displayName":"Encrypting Certificate Chain","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.cert.Certificate[]","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The chain of certificates used to encrypt EDI message."},"signedReceiptMicAlgorithms":{"index":37,"kind":"parameter","displayName":"Signed Receipt Mic Algorithms","group":"security","label":"security","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The list of algorithms, in order of preference, requested to generate a message integrity check (MIC) returned in message dispostion notification (MDN)"},"signingAlgorithm":{"index":38,"kind":"parameter","displayName":"Signing Algorithm","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2SignatureAlgorithm","enum":["SHA3_224WITHRSA","SHA3_256WITHRSA","SHA3_384withRSA","SHA3_512WITHRSA","MD5WITHRSA","SHA1WITHRSA","MD2WITHRSA","SHA224WITHRSA","SHA256WITHRSA","SHA384WITHRSA","SHA512WITHRSA","RIPEMD128WITHRSA","RIPEMD160WITHRSA","RIPEMD256WITHRSA","SHA224WITHDSA","SHA256WITHDSA","SHA384WITHDSA","SHA512WITHDSA","SHA3_224WITHDSA","SHA3_256WITHDSA","SHA3_384WITHDSA","SHA3_512WITHDSA","SHA1WITHDSA","SHA3_224WITHECDSA","SHA3_256WITHECDSA","SHA3_384WITHECDSA","SHA3_512WITHECDSA","SHA1WITHECDSA","SHA224WITHECDSA","SHA256WITHECDSA","SHA384WITHECDSA","SHA512WITHECDSA","SHA1WITHPLAIN_ECDSA","SHA224WITHPLAIN_ECDSA","SHA256WITHPLAIN_ECDSA","SHA384WITHPLAIN_ECDSA","SHA512WITHPLAIN_ECDSA","RIPEMD160WITHPLAIN_ECDSA","SHA1WITHRSAANDMGF1","SHA224WITHRSAANDMGF1","SHA256WITHRSAANDMGF1","SHA384WITHRSAANDMGF1","SHA512WITHRSAANDMGF1","SHA3_224WITHRSAANDMGF1","SHA3_256WITHRSAANDMGF1","SHA3_384WITHRSAANDMGF1","SHA3_512WITHRSAANDMGF1"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The algorithm used to sign EDI message."},"signingCertificateChain":{"index":39,"kind":"parameter","displayName":"Signing Certificate Chain","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.cert.Certificate[]","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The chain of certificates used to sign EDI message."},"signingPrivateKey":{"index":40,"kind":"parameter","displayName":"Signing Private Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The key used to sign the EDI message."},"validateSigningCertificateChain":{"index":41,"kind":"parameter","displayName":"Validate Signing Certificate Chain","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.cert.Certificate[]","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"Certificates to validate the message's signature against. If not supplied, validation will not take place. Server: validates the received message. Client: not yet implemented, should validate the MDN"}},"apis":{"client":{"consumerOnly":false,"producerOnly":true,"description":"Sends EDI Messages over HTTP","methods":{"send":{"description":"Send ediMessage to trading partner","signatures":["org.apache.hc.core5.http.protocol.HttpCoreContext send(String ediMessage, String requestUri, String subject, String from, String as2From, String as2To, org.apache.camel.component.as2.api.AS2MessageStructure as2MessageStructure, org.apache.hc.core5.http.ContentType ediMessageContentType, String ediMessageTransferEncoding, org.apache.camel.component.as2.api.AS2SignatureAlgorithm signingAlgorithm, java.security.cert.Certificate[] signingCertificateChain, java.security.PrivateKey signingPrivateKey, org.apache.camel.component.as2.api.AS2CompressionAlgorithm compressionAlgorithm, String dispositionNotificationTo, String[] signedReceiptMicAlgorithms, org.apache.camel.component.as2.api.AS2EncryptionAlgorithm encryptingAlgorithm, java.security.cert.Certificate[] encryptingCertificateChain, String attachedFileName, String receiptDeliveryOption)"]}}},"receipt":{"consumerOnly":true,"producerOnly":false,"description":"Receives the asynchronous AS2-MDN that is requested by the sender of an AS2 message","methods":{"receive":{"description":"","signatures":["void receive(String requestUriPattern, org.apache.hc.core5.http.io.HttpRequestHandler handler)"]}}},"server":{"consumerOnly":true,"producerOnly":false,"description":"Receives EDI Messages over HTTP","methods":{"listen":{"description":"","signatures":["void listen(String requestUriPattern, org.apache.hc.core5.http.io.HttpRequestHandler handler)"]}}}},"apiProperties":{"client":{"methods":{"send":{"properties":{"as2From":{"index":0,"kind":"parameter","displayName":"As2 From","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"AS2 name of sender","optional":false},"as2MessageStructure":{"index":1,"kind":"parameter","displayName":"As2 Message Structure","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2MessageStructure","enum":["PLAIN","SIGNED","ENCRYPTED","SIGNED_ENCRYPTED","PLAIN_COMPRESSED","COMPRESSED_SIGNED","SIGNED_COMPRESSED","ENCRYPTED_COMPRESSED","ENCRYPTED_COMPRESSED_SIGNED","ENCRYPTED_SIGNED_COMPRESSED"],"deprecated":false,"autowired":false,"secret":false,"description":"The structure of AS2 to send; see AS2MessageStructure","optional":false},"as2To":{"index":2,"kind":"parameter","displayName":"As2 To","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"AS2 name of recipient","optional":false},"attachedFileName":{"index":3,"kind":"parameter","displayName":"Attached File Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the attached file or null if user doesn't want to specify it","optional":true},"compressionAlgorithm":{"index":4,"kind":"parameter","displayName":"Compression Algorithm","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2CompressionAlgorithm","enum":["ZLIB"],"deprecated":false,"autowired":false,"secret":false,"description":"The algorithm used to compress the message or null if sending EDI message uncompressed","optional":true},"dispositionNotificationTo":{"index":5,"kind":"parameter","displayName":"Disposition Notification To","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An RFC2822 address to request a receipt or null if no receipt requested","optional":true},"ediMessage":{"index":6,"kind":"parameter","displayName":"Edi Message","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"EDI message to transport","optional":false},"ediMessageContentType":{"index":7,"kind":"parameter","displayName":"Edi Message Content Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.hc.core5.http.ContentType","deprecated":false,"autowired":false,"secret":false,"description":"The content type of EDI message","optional":false},"ediMessageTransferEncoding":{"index":8,"kind":"parameter","displayName":"Edi Message Transfer Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The transfer encoding used to transport EDI message","optional":true},"encryptingAlgorithm":{"index":9,"kind":"parameter","displayName":"Encrypting Algorithm","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2EncryptionAlgorithm","enum":["AES128_CBC","AES192_CBC","AES256_CBC","AES128_CCM","AES192_CCM","AES256_CCM","AES128_GCM","AES192_GCM","AES256_GCM","CAMELLIA128_CBC","CAMELLIA192_CBC","CAMELLIA256_CBC","CAST5_CBC","DES_CBC","DES_EDE3_CBC","GOST28147_GCFB","IDEA_CBC","RC2_CBC","RC4","SEED_CBC"],"deprecated":false,"autowired":false,"secret":false,"description":"The algorithm used to encrypt the message or null if sending EDI message unencrypted","optional":true},"encryptingCertificateChain":{"index":10,"kind":"parameter","displayName":"Encrypting Certificate Chain","group":"producer","label":"","required":false,"type":"object","javaType":"java.security.cert.Certificate[]","deprecated":false,"autowired":false,"secret":false,"description":"The chain of certificates used to encrypt the message or null if sending EDI message unencrypted","optional":true},"from":{"index":11,"kind":"parameter","displayName":"From","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"RFC2822 address of sender","optional":false},"receiptDeliveryOption":{"index":12,"kind":"parameter","displayName":"Receipt Delivery Option","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"requestUri":{"index":13,"kind":"parameter","displayName":"Request Uri","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource location to deliver message","optional":false},"signedReceiptMicAlgorithms":{"index":14,"kind":"parameter","displayName":"Signed Receipt Mic Algorithms","group":"producer","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"The senders list of signing algorithms for signing receipt, in preferred order, or null if requesting an unsigned receipt.","optional":true},"signingAlgorithm":{"index":15,"kind":"parameter","displayName":"Signing Algorithm","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2SignatureAlgorithm","enum":["SHA3_224WITHRSA","SHA3_256WITHRSA","SHA3_384withRSA","SHA3_512WITHRSA","MD5WITHRSA","SHA1WITHRSA","MD2WITHRSA","SHA224WITHRSA","SHA256WITHRSA","SHA384WITHRSA","SHA512WITHRSA","RIPEMD128WITHRSA","RIPEMD160WITHRSA","RIPEMD256WITHRSA","SHA224WITHDSA","SHA256WITHDSA","SHA384WITHDSA","SHA512WITHDSA","SHA3_224WITHDSA","SHA3_256WITHDSA","SHA3_384WITHDSA","SHA3_512WITHDSA","SHA1WITHDSA","SHA3_224WITHECDSA","SHA3_256WITHECDSA","SHA3_384WITHECDSA","SHA3_512WITHECDSA","SHA1WITHECDSA","SHA224WITHECDSA","SHA256WITHECDSA","SHA384WITHECDSA","SHA512WITHECDSA","SHA1WITHPLAIN_ECDSA","SHA224WITHPLAIN_ECDSA","SHA256WITHPLAIN_ECDSA","SHA384WITHPLAIN_ECDSA","SHA512WITHPLAIN_ECDSA","RIPEMD160WITHPLAIN_ECDSA","SHA1WITHRSAANDMGF1","SHA224WITHRSAANDMGF1","SHA256WITHRSAANDMGF1","SHA384WITHRSAANDMGF1","SHA512WITHRSAANDMGF1","SHA3_224WITHRSAANDMGF1","SHA3_256WITHRSAANDMGF1","SHA3_384WITHRSAANDMGF1","SHA3_512WITHRSAANDMGF1"],"deprecated":false,"autowired":false,"secret":false,"description":"The algorithm used to sign the message or null if sending EDI message unsigned","optional":true},"signingCertificateChain":{"index":16,"kind":"parameter","displayName":"Signing Certificate Chain","group":"producer","label":"","required":false,"type":"object","javaType":"java.security.cert.Certificate[]","deprecated":false,"autowired":false,"secret":false,"description":"The chain of certificates used to sign the message or null if sending EDI message unsigned","optional":true},"signingPrivateKey":{"index":17,"kind":"parameter","displayName":"Signing Private Key","group":"producer","label":"","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":false,"description":"The private key used to sign EDI message","optional":true},"subject":{"index":18,"kind":"parameter","displayName":"Subject","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Message subject","optional":false}}}}},"receipt":{"methods":{"receive":{"properties":{"requestUriPattern":{"index":0,"kind":"parameter","displayName":"Request Uri Pattern","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"server":{"methods":{"listen":{"properties":{"requestUriPattern":{"index":0,"kind":"parameter","displayName":"Request Uri Pattern","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}}}} +{"component":{"kind":"component","name":"as2","title":"AS2","description":"Transfer data securely and reliably using the AS2 protocol (RFC4130).","deprecated":false,"firstVersion":"2.22.0","label":"file","javaType":"org.apache.camel.component.as2.AS2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-as2","version":"4.8.2","scheme":"as2","extendsScheme":"","syntax":"as2:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.as2.internal.AS2ApiName","enum":["CLIENT","SERVER","RECEIPT"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"as2From":{"index":2,"kind":"parameter","displayName":"As2 From","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The value of the AS2From header of AS2 message."},"as2MessageStructure":{"index":3,"kind":"parameter","displayName":"As2 Message Structure","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2MessageStructure","enum":["PLAIN","SIGNED","ENCRYPTED","SIGNED_ENCRYPTED","PLAIN_COMPRESSED","COMPRESSED_SIGNED","SIGNED_COMPRESSED","ENCRYPTED_COMPRESSED","ENCRYPTED_COMPRESSED_SIGNED","ENCRYPTED_SIGNED_COMPRESSED"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The structure of AS2 Message. One of: PLAIN - No encryption, no signature, SIGNED - No encryption, signature, ENCRYPTED - Encryption, no signature, ENCRYPTED_SIGNED - Encryption, signature"},"as2To":{"index":4,"kind":"parameter","displayName":"As2 To","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The value of the AS2To header of AS2 message."},"as2Version":{"index":5,"kind":"parameter","displayName":"As2 Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["1.0","1.1"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"1.1","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The version of the AS2 protocol."},"asyncMdnPortNumber":{"index":6,"kind":"parameter","displayName":"Async Mdn Port Number","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The port number of asynchronous MDN server."},"attachedFileName":{"index":7,"kind":"parameter","displayName":"Attached File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The name of the attached file"},"clientFqdn":{"index":8,"kind":"parameter","displayName":"Client Fqdn","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel.apache.org","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The Client Fully Qualified Domain Name (FQDN). Used in message ids sent by endpoint."},"compressionAlgorithm":{"index":9,"kind":"parameter","displayName":"Compression Algorithm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2CompressionAlgorithm","enum":["ZLIB"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The algorithm used to compress EDI message."},"dispositionNotificationTo":{"index":10,"kind":"parameter","displayName":"Disposition Notification To","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The value of the Disposition-Notification-To header. Assigning a value to this parameter requests a message disposition notification (MDN) for the AS2 message."},"ediMessageTransferEncoding":{"index":11,"kind":"parameter","displayName":"Edi Message Transfer Encoding","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The transfer encoding of EDI message."},"ediMessageType":{"index":12,"kind":"parameter","displayName":"Edi Message Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.hc.core5.http.ContentType","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The content type of EDI message. One of application/edifact, application/edi-x12, application/edi-consent, application/xml"},"from":{"index":13,"kind":"parameter","displayName":"From","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The value of the From header of AS2 message."},"hostnameVerifier":{"index":14,"kind":"parameter","displayName":"Hostname Verifier","group":"common","label":"","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"Set hostname verifier for SSL session."},"httpConnectionPoolSize":{"index":15,"kind":"parameter","displayName":"Http Connection Pool Size","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The maximum size of the connection pool for http connections (client only)"},"httpConnectionPoolTtl":{"index":16,"kind":"parameter","displayName":"Http Connection Pool Ttl","group":"common","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"defaultValue":"15m","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The time to live for connections in the connection pool (client only)"},"httpConnectionTimeout":{"index":17,"kind":"parameter","displayName":"Http Connection Timeout","group":"common","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The timeout of the http connection (client only)"},"httpSocketTimeout":{"index":18,"kind":"parameter","displayName":"Http Socket Timeout","group":"common","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The timeout of the underlying http socket (client only)"},"inBody":{"index":19,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"mdnMessageTemplate":{"index":20,"kind":"parameter","displayName":"Mdn Message Template","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The template used to format MDN message"},"receiptDeliveryOption":{"index":21,"kind":"parameter","displayName":"Receipt Delivery Option","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The return URL that the message receiver should send an asynchronous MDN to. If not present the receipt is synchronous. (Client only)"},"requestUri":{"index":22,"kind":"parameter","displayName":"Request Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"/","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The request URI of EDI message."},"server":{"index":23,"kind":"parameter","displayName":"Server","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Camel AS2 Server Endpoint","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The value included in the Server message header identifying the AS2 Server."},"serverFqdn":{"index":24,"kind":"parameter","displayName":"Server Fqdn","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel.apache.org","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The Server Fully Qualified Domain Name (FQDN). Used in message ids sent by endpoint."},"serverPortNumber":{"index":25,"kind":"parameter","displayName":"Server Port Number","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The port number of server."},"sslContext":{"index":26,"kind":"parameter","displayName":"Ssl Context","group":"common","label":"","required":false,"type":"object","javaType":"javax.net.ssl.SSLContext","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"Set SSL context for connection to remote server."},"subject":{"index":27,"kind":"parameter","displayName":"Subject","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The value of Subject header of AS2 message."},"targetHostname":{"index":28,"kind":"parameter","displayName":"Target Hostname","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The host name (IP or DNS name) of target host."},"targetPortNumber":{"index":29,"kind":"parameter","displayName":"Target Port Number","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"80","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The port number of target host. -1 indicates the scheme default port."},"userAgent":{"index":30,"kind":"parameter","displayName":"User Agent","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Camel AS2 Client Endpoint","configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The value included in the User-Agent message header identifying the AS2 user agent."},"exceptionHandler":{"index":31,"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":{"index":32,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":33,"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."},"decryptingPrivateKey":{"index":34,"kind":"parameter","displayName":"Decrypting Private Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The key used to encrypt the EDI message."},"encryptingAlgorithm":{"index":35,"kind":"parameter","displayName":"Encrypting Algorithm","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2EncryptionAlgorithm","enum":["AES128_CBC","AES192_CBC","AES256_CBC","AES128_CCM","AES192_CCM","AES256_CCM","AES128_GCM","AES192_GCM","AES256_GCM","CAMELLIA128_CBC","CAMELLIA192_CBC","CAMELLIA256_CBC","CAST5_CBC","DES_CBC","DES_EDE3_CBC","GOST28147_GCFB","IDEA_CBC","RC2_CBC","RC4","SEED_CBC"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The algorithm used to encrypt EDI message."},"encryptingCertificateChain":{"index":36,"kind":"parameter","displayName":"Encrypting Certificate Chain","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.cert.Certificate[]","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The chain of certificates used to encrypt EDI message."},"signedReceiptMicAlgorithms":{"index":37,"kind":"parameter","displayName":"Signed Receipt Mic Algorithms","group":"security","label":"security","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The list of algorithms, in order of preference, requested to generate a message integrity check (MIC) returned in message dispostion notification (MDN)"},"signingAlgorithm":{"index":38,"kind":"parameter","displayName":"Signing Algorithm","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2SignatureAlgorithm","enum":["SHA3_224WITHRSA","SHA3_256WITHRSA","SHA3_384withRSA","SHA3_512WITHRSA","MD5WITHRSA","SHA1WITHRSA","MD2WITHRSA","SHA224WITHRSA","SHA256WITHRSA","SHA384WITHRSA","SHA512WITHRSA","RIPEMD128WITHRSA","RIPEMD160WITHRSA","RIPEMD256WITHRSA","SHA224WITHDSA","SHA256WITHDSA","SHA384WITHDSA","SHA512WITHDSA","SHA3_224WITHDSA","SHA3_256WITHDSA","SHA3_384WITHDSA","SHA3_512WITHDSA","SHA1WITHDSA","SHA3_224WITHECDSA","SHA3_256WITHECDSA","SHA3_384WITHECDSA","SHA3_512WITHECDSA","SHA1WITHECDSA","SHA224WITHECDSA","SHA256WITHECDSA","SHA384WITHECDSA","SHA512WITHECDSA","SHA1WITHPLAIN_ECDSA","SHA224WITHPLAIN_ECDSA","SHA256WITHPLAIN_ECDSA","SHA384WITHPLAIN_ECDSA","SHA512WITHPLAIN_ECDSA","RIPEMD160WITHPLAIN_ECDSA","SHA1WITHRSAANDMGF1","SHA224WITHRSAANDMGF1","SHA256WITHRSAANDMGF1","SHA384WITHRSAANDMGF1","SHA512WITHRSAANDMGF1","SHA3_224WITHRSAANDMGF1","SHA3_256WITHRSAANDMGF1","SHA3_384WITHRSAANDMGF1","SHA3_512WITHRSAANDMGF1"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The algorithm used to sign EDI message."},"signingCertificateChain":{"index":39,"kind":"parameter","displayName":"Signing Certificate Chain","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.cert.Certificate[]","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The chain of certificates used to sign EDI message."},"signingPrivateKey":{"index":40,"kind":"parameter","displayName":"Signing Private Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"The key used to sign the EDI message."},"validateSigningCertificateChain":{"index":41,"kind":"parameter","displayName":"Validate Signing Certificate Chain","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.cert.Certificate[]","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.as2.AS2Configuration","configurationField":"configuration","description":"Certificates to validate the message's signature against. If not supplied, validation will not take place. Server: validates the received message. Client: not yet implemented, should validate the MDN"}},"apis":{"client":{"consumerOnly":false,"producerOnly":true,"description":"Sends EDI Messages over HTTP","methods":{"send":{"description":"Send ediMessage to trading partner","signatures":["org.apache.hc.core5.http.protocol.HttpCoreContext send(String ediMessage, String requestUri, String subject, String from, String as2From, String as2To, org.apache.camel.component.as2.api.AS2MessageStructure as2MessageStructure, org.apache.hc.core5.http.ContentType ediMessageContentType, String ediMessageTransferEncoding, org.apache.camel.component.as2.api.AS2SignatureAlgorithm signingAlgorithm, java.security.cert.Certificate[] signingCertificateChain, java.security.PrivateKey signingPrivateKey, org.apache.camel.component.as2.api.AS2CompressionAlgorithm compressionAlgorithm, String dispositionNotificationTo, String[] signedReceiptMicAlgorithms, org.apache.camel.component.as2.api.AS2EncryptionAlgorithm encryptingAlgorithm, java.security.cert.Certificate[] encryptingCertificateChain, String attachedFileName, String receiptDeliveryOption)"]}}},"receipt":{"consumerOnly":true,"producerOnly":false,"description":"Receives the asynchronous AS2-MDN that is requested by the sender of an AS2 message","methods":{"receive":{"description":"","signatures":["void receive(String requestUriPattern, org.apache.hc.core5.http.io.HttpRequestHandler handler)"]}}},"server":{"consumerOnly":true,"producerOnly":false,"description":"Receives EDI Messages over HTTP","methods":{"listen":{"description":"","signatures":["void listen(String requestUriPattern, org.apache.hc.core5.http.io.HttpRequestHandler handler)"]}}}},"apiProperties":{"client":{"methods":{"send":{"properties":{"as2From":{"index":0,"kind":"parameter","displayName":"As2 From","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"AS2 name of sender","optional":false},"as2MessageStructure":{"index":1,"kind":"parameter","displayName":"As2 Message Structure","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2MessageStructure","enum":["PLAIN","SIGNED","ENCRYPTED","SIGNED_ENCRYPTED","PLAIN_COMPRESSED","COMPRESSED_SIGNED","SIGNED_COMPRESSED","ENCRYPTED_COMPRESSED","ENCRYPTED_COMPRESSED_SIGNED","ENCRYPTED_SIGNED_COMPRESSED"],"deprecated":false,"autowired":false,"secret":false,"description":"The structure of AS2 to send; see AS2MessageStructure","optional":false},"as2To":{"index":2,"kind":"parameter","displayName":"As2 To","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"AS2 name of recipient","optional":false},"attachedFileName":{"index":3,"kind":"parameter","displayName":"Attached File Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the attached file or null if user doesn't want to specify it","optional":true},"compressionAlgorithm":{"index":4,"kind":"parameter","displayName":"Compression Algorithm","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2CompressionAlgorithm","enum":["ZLIB"],"deprecated":false,"autowired":false,"secret":false,"description":"The algorithm used to compress the message or null if sending EDI message uncompressed","optional":true},"dispositionNotificationTo":{"index":5,"kind":"parameter","displayName":"Disposition Notification To","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An RFC2822 address to request a receipt or null if no receipt requested","optional":true},"ediMessage":{"index":6,"kind":"parameter","displayName":"Edi Message","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"EDI message to transport","optional":false},"ediMessageContentType":{"index":7,"kind":"parameter","displayName":"Edi Message Content Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.hc.core5.http.ContentType","deprecated":false,"autowired":false,"secret":false,"description":"The content type of EDI message","optional":false},"ediMessageTransferEncoding":{"index":8,"kind":"parameter","displayName":"Edi Message Transfer Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The transfer encoding used to transport EDI message","optional":true},"encryptingAlgorithm":{"index":9,"kind":"parameter","displayName":"Encrypting Algorithm","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2EncryptionAlgorithm","enum":["AES128_CBC","AES192_CBC","AES256_CBC","AES128_CCM","AES192_CCM","AES256_CCM","AES128_GCM","AES192_GCM","AES256_GCM","CAMELLIA128_CBC","CAMELLIA192_CBC","CAMELLIA256_CBC","CAST5_CBC","DES_CBC","DES_EDE3_CBC","GOST28147_GCFB","IDEA_CBC","RC2_CBC","RC4","SEED_CBC"],"deprecated":false,"autowired":false,"secret":false,"description":"The algorithm used to encrypt the message or null if sending EDI message unencrypted","optional":true},"encryptingCertificateChain":{"index":10,"kind":"parameter","displayName":"Encrypting Certificate Chain","group":"producer","label":"","required":false,"type":"object","javaType":"java.security.cert.Certificate[]","deprecated":false,"autowired":false,"secret":false,"description":"The chain of certificates used to encrypt the message or null if sending EDI message unencrypted","optional":true},"from":{"index":11,"kind":"parameter","displayName":"From","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"RFC2822 address of sender","optional":false},"receiptDeliveryOption":{"index":12,"kind":"parameter","displayName":"Receipt Delivery Option","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"requestUri":{"index":13,"kind":"parameter","displayName":"Request Uri","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource location to deliver message","optional":false},"signedReceiptMicAlgorithms":{"index":14,"kind":"parameter","displayName":"Signed Receipt Mic Algorithms","group":"producer","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"The senders list of signing algorithms for signing receipt, in preferred order, or null if requesting an unsigned receipt.","optional":true},"signingAlgorithm":{"index":15,"kind":"parameter","displayName":"Signing Algorithm","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.as2.api.AS2SignatureAlgorithm","enum":["SHA3_224WITHRSA","SHA3_256WITHRSA","SHA3_384withRSA","SHA3_512WITHRSA","MD5WITHRSA","SHA1WITHRSA","MD2WITHRSA","SHA224WITHRSA","SHA256WITHRSA","SHA384WITHRSA","SHA512WITHRSA","RIPEMD128WITHRSA","RIPEMD160WITHRSA","RIPEMD256WITHRSA","SHA224WITHDSA","SHA256WITHDSA","SHA384WITHDSA","SHA512WITHDSA","SHA3_224WITHDSA","SHA3_256WITHDSA","SHA3_384WITHDSA","SHA3_512WITHDSA","SHA1WITHDSA","SHA3_224WITHECDSA","SHA3_256WITHECDSA","SHA3_384WITHECDSA","SHA3_512WITHECDSA","SHA1WITHECDSA","SHA224WITHECDSA","SHA256WITHECDSA","SHA384WITHECDSA","SHA512WITHECDSA","SHA1WITHPLAIN_ECDSA","SHA224WITHPLAIN_ECDSA","SHA256WITHPLAIN_ECDSA","SHA384WITHPLAIN_ECDSA","SHA512WITHPLAIN_ECDSA","RIPEMD160WITHPLAIN_ECDSA","SHA1WITHRSAANDMGF1","SHA224WITHRSAANDMGF1","SHA256WITHRSAANDMGF1","SHA384WITHRSAANDMGF1","SHA512WITHRSAANDMGF1","SHA3_224WITHRSAANDMGF1","SHA3_256WITHRSAANDMGF1","SHA3_384WITHRSAANDMGF1","SHA3_512WITHRSAANDMGF1"],"deprecated":false,"autowired":false,"secret":false,"description":"The algorithm used to sign the message or null if sending EDI message unsigned","optional":true},"signingCertificateChain":{"index":16,"kind":"parameter","displayName":"Signing Certificate Chain","group":"producer","label":"","required":false,"type":"object","javaType":"java.security.cert.Certificate[]","deprecated":false,"autowired":false,"secret":false,"description":"The chain of certificates used to sign the message or null if sending EDI message unsigned","optional":true},"signingPrivateKey":{"index":17,"kind":"parameter","displayName":"Signing Private Key","group":"producer","label":"","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":false,"description":"The private key used to sign EDI message","optional":true},"subject":{"index":18,"kind":"parameter","displayName":"Subject","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Message subject","optional":false}}}}},"receipt":{"methods":{"receive":{"properties":{"requestUriPattern":{"index":0,"kind":"parameter","displayName":"Request Uri Pattern","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"server":{"methods":{"listen":{"properties":{"requestUriPattern":{"index":0,"kind":"parameter","displayName":"Request Uri Pattern","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}}}} , -{"component":{"kind":"component","name":"asterisk","title":"Asterisk","description":"Interact with Asterisk PBX Server (VoIP).","deprecated":false,"firstVersion":"2.18.0","label":"mobile","javaType":"org.apache.camel.component.asterisk.AsteriskComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-asterisk","version":"4.8.1","scheme":"asterisk","extendsScheme":"","syntax":"asterisk:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAsteriskEventName":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"Simple name of the event","description":"The name of the Asterisk event.","constantName":"org.apache.camel.component.asterisk.AsteriskConstants#EVENT_NAME"},"CamelAsteriskExtension":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The extension to query in case of an ExtensionStateAction.","constantName":"org.apache.camel.component.asterisk.AsteriskConstants#EXTENSION"},"CamelAsteriskContext":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the context that contains the extension to query in case of an ExtensionStateAction.","constantName":"org.apache.camel.component.asterisk.AsteriskConstants#CONTEXT"},"CamelAsteriskAction":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.asterisk.AsteriskAction","enum":["QUEUE_STATUS","SIP_PEERS","EXTENSION_STATE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Asterisk action to do.","constantName":"org.apache.camel.component.asterisk.AsteriskConstants#ACTION"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of component"},"hostname":{"index":1,"kind":"parameter","displayName":"Hostname","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The hostname of the asterisk server"},"password":{"index":2,"kind":"parameter","displayName":"Password","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Login password"},"username":{"index":3,"kind":"parameter","displayName":"Username","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Login username"},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"action":{"index":7,"kind":"parameter","displayName":"Action","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.asterisk.AsteriskAction","enum":["QUEUE_STATUS","SIP_PEERS","EXTENSION_STATE"],"deprecated":false,"autowired":false,"secret":false,"description":"What action to perform such as getting queue status, sip peers or extension state."},"lazyStartProducer":{"index":8,"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."}}} +{"component":{"kind":"component","name":"asterisk","title":"Asterisk","description":"Interact with Asterisk PBX Server (VoIP).","deprecated":false,"firstVersion":"2.18.0","label":"mobile","javaType":"org.apache.camel.component.asterisk.AsteriskComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-asterisk","version":"4.8.2","scheme":"asterisk","extendsScheme":"","syntax":"asterisk:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAsteriskEventName":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"Simple name of the event","description":"The name of the Asterisk event.","constantName":"org.apache.camel.component.asterisk.AsteriskConstants#EVENT_NAME"},"CamelAsteriskExtension":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The extension to query in case of an ExtensionStateAction.","constantName":"org.apache.camel.component.asterisk.AsteriskConstants#EXTENSION"},"CamelAsteriskContext":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the context that contains the extension to query in case of an ExtensionStateAction.","constantName":"org.apache.camel.component.asterisk.AsteriskConstants#CONTEXT"},"CamelAsteriskAction":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.asterisk.AsteriskAction","enum":["QUEUE_STATUS","SIP_PEERS","EXTENSION_STATE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Asterisk action to do.","constantName":"org.apache.camel.component.asterisk.AsteriskConstants#ACTION"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of component"},"hostname":{"index":1,"kind":"parameter","displayName":"Hostname","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The hostname of the asterisk server"},"password":{"index":2,"kind":"parameter","displayName":"Password","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Login password"},"username":{"index":3,"kind":"parameter","displayName":"Username","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Login username"},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"action":{"index":7,"kind":"parameter","displayName":"Action","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.asterisk.AsteriskAction","enum":["QUEUE_STATUS","SIP_PEERS","EXTENSION_STATE"],"deprecated":false,"autowired":false,"secret":false,"description":"What action to perform such as getting queue status, sip peers or extension state."},"lazyStartProducer":{"index":8,"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."}}} , -{"component":{"kind":"component","name":"atmosphere-websocket","title":"Atmosphere Websocket","description":"Expose WebSocket endpoints using the Atmosphere framework.","deprecated":false,"firstVersion":"2.14.0","label":"http,networking","javaType":"org.apache.camel.component.atmosphere.websocket.WebsocketComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-atmosphere-websocket","version":"4.8.1","scheme":"atmosphere-websocket","extendsScheme":"servlet","syntax":"atmosphere-websocket:servicePath","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"websocket.connectionKey":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The connection key.","constantName":"org.apache.camel.component.atmosphere.websocket.WebsocketConstants#CONNECTION_KEY"},"websocket.connectionKey.list":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.util.List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of connection keys.","constantName":"org.apache.camel.component.atmosphere.websocket.WebsocketConstants#CONNECTION_KEY_LIST"},"websocket.eventType":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event received. It can be ONOPEN_EVENT_TYPE, ONERROR_EVENT_TYPE or ONCLOSE_EVENT_TYPE.","constantName":"org.apache.camel.component.atmosphere.websocket.WebsocketConstants#EVENT_TYPE"},"websocket.errorType":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of error that occurred. It can be MESSAGE_NOT_SENT_ERROR_TYPE.","constantName":"org.apache.camel.component.atmosphere.websocket.WebsocketConstants#ERROR_TYPE"}},"properties":{"servicePath":{"index":0,"kind":"path","displayName":"Service Path","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of websocket endpoint"},"chunked":{"index":1,"kind":"parameter","displayName":"Chunked","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response"},"disableStreamCache":{"index":2,"kind":"parameter","displayName":"Disable Stream Cache","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The producer (camel-http) will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is (the stream can only be read once) as the message body."},"sendToAll":{"index":3,"kind":"parameter","displayName":"Send To All","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to send to all (broadcast) or send to a single receiver."},"transferException":{"index":4,"kind":"parameter","displayName":"Transfer Exception","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk."},"useStreaming":{"index":5,"kind":"parameter","displayName":"Use Streaming","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To enable streaming to send data as multiple text fragments."},"headerFilterStrategy":{"index":6,"kind":"parameter","displayName":"Header Filter Strategy","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"httpBinding":{"index":7,"kind":"parameter","displayName":"Http Binding","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.http.common.HttpBinding","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpBinding to control the mapping between Camel message and HttpClient."},"async":{"index":8,"kind":"parameter","displayName":"Async","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configure the consumer to work in async mode"},"httpMethodRestrict":{"index":9,"kind":"parameter","displayName":"Http Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma."},"logException":{"index":10,"kind":"parameter","displayName":"Log Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side the exception's stack trace will be logged when the exception stack trace is not sent in the response's body."},"matchOnUriPrefix":{"index":11,"kind":"parameter","displayName":"Match On Uri Prefix","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found."},"muteException":{"index":12,"kind":"parameter","displayName":"Mute Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace."},"responseBufferSize":{"index":13,"kind":"parameter","displayName":"Response Buffer Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom buffer size on the jakarta.servlet.ServletResponse."},"servletName":{"index":14,"kind":"parameter","displayName":"Servlet Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelServlet","description":"Name of the servlet to use"},"attachmentMultipartBinding":{"index":15,"kind":"parameter","displayName":"Attachment Multipart Binding","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's."},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"eagerCheckContentAvailable":{"index":17,"kind":"parameter","displayName":"Eager Check Content Available","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data."},"exceptionHandler":{"index":18,"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":{"index":19,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"fileNameExtWhitelist":{"index":20,"kind":"parameter","displayName":"File Name Ext Whitelist","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml."},"mapHttpMessageBody":{"index":21,"kind":"parameter","displayName":"Map Http Message Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping."},"mapHttpMessageFormUrlEncodedBody":{"index":22,"kind":"parameter","displayName":"Map Http Message Form Url Encoded Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping."},"mapHttpMessageHeaders":{"index":23,"kind":"parameter","displayName":"Map Http Message Headers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping."},"optionsEnabled":{"index":24,"kind":"parameter","displayName":"Options Enabled","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off."},"traceEnabled":{"index":25,"kind":"parameter","displayName":"Trace Enabled","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off."},"bridgeEndpoint":{"index":26,"kind":"parameter","displayName":"Bridge Endpoint","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back."},"lazyStartProducer":{"index":27,"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."}}} +{"component":{"kind":"component","name":"atmosphere-websocket","title":"Atmosphere Websocket","description":"Expose WebSocket endpoints using the Atmosphere framework.","deprecated":false,"firstVersion":"2.14.0","label":"http,networking","javaType":"org.apache.camel.component.atmosphere.websocket.WebsocketComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-atmosphere-websocket","version":"4.8.2","scheme":"atmosphere-websocket","extendsScheme":"servlet","syntax":"atmosphere-websocket:servicePath","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"websocket.connectionKey":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The connection key.","constantName":"org.apache.camel.component.atmosphere.websocket.WebsocketConstants#CONNECTION_KEY"},"websocket.connectionKey.list":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.util.List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of connection keys.","constantName":"org.apache.camel.component.atmosphere.websocket.WebsocketConstants#CONNECTION_KEY_LIST"},"websocket.eventType":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event received. It can be ONOPEN_EVENT_TYPE, ONERROR_EVENT_TYPE or ONCLOSE_EVENT_TYPE.","constantName":"org.apache.camel.component.atmosphere.websocket.WebsocketConstants#EVENT_TYPE"},"websocket.errorType":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of error that occurred. It can be MESSAGE_NOT_SENT_ERROR_TYPE.","constantName":"org.apache.camel.component.atmosphere.websocket.WebsocketConstants#ERROR_TYPE"}},"properties":{"servicePath":{"index":0,"kind":"path","displayName":"Service Path","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of websocket endpoint"},"chunked":{"index":1,"kind":"parameter","displayName":"Chunked","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response"},"disableStreamCache":{"index":2,"kind":"parameter","displayName":"Disable Stream Cache","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The producer (camel-http) will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is (the stream can only be read once) as the message body."},"sendToAll":{"index":3,"kind":"parameter","displayName":"Send To All","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to send to all (broadcast) or send to a single receiver."},"transferException":{"index":4,"kind":"parameter","displayName":"Transfer Exception","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk."},"useStreaming":{"index":5,"kind":"parameter","displayName":"Use Streaming","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To enable streaming to send data as multiple text fragments."},"headerFilterStrategy":{"index":6,"kind":"parameter","displayName":"Header Filter Strategy","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"httpBinding":{"index":7,"kind":"parameter","displayName":"Http Binding","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.http.common.HttpBinding","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpBinding to control the mapping between Camel message and HttpClient."},"async":{"index":8,"kind":"parameter","displayName":"Async","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configure the consumer to work in async mode"},"httpMethodRestrict":{"index":9,"kind":"parameter","displayName":"Http Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma."},"logException":{"index":10,"kind":"parameter","displayName":"Log Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side the exception's stack trace will be logged when the exception stack trace is not sent in the response's body."},"matchOnUriPrefix":{"index":11,"kind":"parameter","displayName":"Match On Uri Prefix","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found."},"muteException":{"index":12,"kind":"parameter","displayName":"Mute Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace."},"responseBufferSize":{"index":13,"kind":"parameter","displayName":"Response Buffer Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom buffer size on the jakarta.servlet.ServletResponse."},"servletName":{"index":14,"kind":"parameter","displayName":"Servlet Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelServlet","description":"Name of the servlet to use"},"attachmentMultipartBinding":{"index":15,"kind":"parameter","displayName":"Attachment Multipart Binding","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's."},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"eagerCheckContentAvailable":{"index":17,"kind":"parameter","displayName":"Eager Check Content Available","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data."},"exceptionHandler":{"index":18,"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":{"index":19,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"fileNameExtWhitelist":{"index":20,"kind":"parameter","displayName":"File Name Ext Whitelist","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml."},"mapHttpMessageBody":{"index":21,"kind":"parameter","displayName":"Map Http Message Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping."},"mapHttpMessageFormUrlEncodedBody":{"index":22,"kind":"parameter","displayName":"Map Http Message Form Url Encoded Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping."},"mapHttpMessageHeaders":{"index":23,"kind":"parameter","displayName":"Map Http Message Headers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping."},"optionsEnabled":{"index":24,"kind":"parameter","displayName":"Options Enabled","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off."},"traceEnabled":{"index":25,"kind":"parameter","displayName":"Trace Enabled","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off."},"bridgeEndpoint":{"index":26,"kind":"parameter","displayName":"Bridge Endpoint","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back."},"lazyStartProducer":{"index":27,"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."}}} , -{"component":{"kind":"component","name":"atom","title":"Atom","description":"Poll Atom RSS feeds.","deprecated":false,"firstVersion":"1.2.0","label":"document","javaType":"org.apache.camel.component.atom.AtomComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-atom","version":"4.8.1","scheme":"atom","extendsScheme":"","syntax":"atom:feedUri","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelAtomFeed":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"java.util.List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When consuming the List object is set to this header.","constantName":"org.apache.camel.component.atom.AtomConstants#ATOM_FEED"}},"properties":{"feedUri":{"index":0,"kind":"path","displayName":"Feed Uri","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The URI to the feed to poll."},"sendEmptyMessageWhenIdle":{"index":1,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"sortEntries":{"index":2,"kind":"parameter","displayName":"Sort Entries","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to sort entries by published date. Only works when splitEntries = true."},"splitEntries":{"index":3,"kind":"parameter","displayName":"Split Entries","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message"},"throttleEntries":{"index":4,"kind":"parameter","displayName":"Throttle Entries","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether all entries identified in a single feed poll should be delivered immediately. If true, only one entry is processed per delay. Only applicable when splitEntries = true."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":8,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"feedHeader":{"index":9,"kind":"parameter","displayName":"Feed Header","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to add the feed object as a header."},"backoffErrorThreshold":{"index":10,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":11,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":12,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":13,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":14,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":15,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":16,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":17,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":18,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":19,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":20,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":21,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":22,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":23,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} +{"component":{"kind":"component","name":"atom","title":"Atom","description":"Poll Atom RSS feeds.","deprecated":false,"firstVersion":"1.2.0","label":"document","javaType":"org.apache.camel.component.atom.AtomComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-atom","version":"4.8.2","scheme":"atom","extendsScheme":"","syntax":"atom:feedUri","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelAtomFeed":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"java.util.List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When consuming the List object is set to this header.","constantName":"org.apache.camel.component.atom.AtomConstants#ATOM_FEED"}},"properties":{"feedUri":{"index":0,"kind":"path","displayName":"Feed Uri","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The URI to the feed to poll."},"sendEmptyMessageWhenIdle":{"index":1,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"sortEntries":{"index":2,"kind":"parameter","displayName":"Sort Entries","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to sort entries by published date. Only works when splitEntries = true."},"splitEntries":{"index":3,"kind":"parameter","displayName":"Split Entries","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message"},"throttleEntries":{"index":4,"kind":"parameter","displayName":"Throttle Entries","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether all entries identified in a single feed poll should be delivered immediately. If true, only one entry is processed per delay. Only applicable when splitEntries = true."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":8,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"feedHeader":{"index":9,"kind":"parameter","displayName":"Feed Header","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to add the feed object as a header."},"backoffErrorThreshold":{"index":10,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":11,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":12,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":13,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":14,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":15,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":16,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":17,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":18,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":19,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":20,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":21,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":22,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":23,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} , -{"component":{"kind":"component","name":"avro","title":"Avro RPC","description":"Produce or consume Apache Avro RPC services.","deprecated":false,"firstVersion":"2.10.0","label":"rpc","javaType":"org.apache.camel.component.avro.AvroComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-avro-rpc","version":"4.8.1","scheme":"avro","extendsScheme":"","syntax":"avro:transport:host:port/messageName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAvroMessageName":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the message to send. In consumer overrides message name from URI (if any)","constantName":"org.apache.camel.component.avro.AvroConstants#AVRO_MESSAGE_NAME"}},"properties":{"transport":{"index":0,"kind":"path","displayName":"Transport","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.avro.AvroTransport","enum":["http","netty"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"Transport to use, can be either http or netty"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"Port number to use"},"host":{"index":2,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"Hostname to use"},"messageName":{"index":3,"kind":"path","displayName":"Message Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"The name of the message to send."},"protocol":{"index":4,"kind":"parameter","displayName":"Protocol","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.avro.Protocol","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"Avro protocol to use"},"protocolClassName":{"index":5,"kind":"parameter","displayName":"Protocol Class Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"Avro protocol to use defined by the FQN class name"},"protocolLocation":{"index":6,"kind":"parameter","displayName":"Protocol Location","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"Avro protocol location"},"reflectionProtocol":{"index":7,"kind":"parameter","displayName":"Reflection Protocol","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"If the protocol object provided is reflection protocol. Should be used only with protocol parameter because for protocolClassName protocol type will be auto-detected"},"singleParameter":{"index":8,"kind":"parameter","displayName":"Single Parameter","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"If true, consumer parameter won't be wrapped into an array. Will fail if protocol specifies more than one parameter for the message"},"uriAuthority":{"index":9,"kind":"parameter","displayName":"Uri Authority","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"Authority to use (username and password)"},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":13,"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."}}} +{"component":{"kind":"component","name":"avro","title":"Avro RPC","description":"Produce or consume Apache Avro RPC services.","deprecated":false,"firstVersion":"2.10.0","label":"rpc","javaType":"org.apache.camel.component.avro.AvroComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-avro-rpc","version":"4.8.2","scheme":"avro","extendsScheme":"","syntax":"avro:transport:host:port/messageName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAvroMessageName":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the message to send. In consumer overrides message name from URI (if any)","constantName":"org.apache.camel.component.avro.AvroConstants#AVRO_MESSAGE_NAME"}},"properties":{"transport":{"index":0,"kind":"path","displayName":"Transport","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.avro.AvroTransport","enum":["http","netty"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"Transport to use, can be either http or netty"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"Port number to use"},"host":{"index":2,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"Hostname to use"},"messageName":{"index":3,"kind":"path","displayName":"Message Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"The name of the message to send."},"protocol":{"index":4,"kind":"parameter","displayName":"Protocol","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.avro.Protocol","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"Avro protocol to use"},"protocolClassName":{"index":5,"kind":"parameter","displayName":"Protocol Class Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"Avro protocol to use defined by the FQN class name"},"protocolLocation":{"index":6,"kind":"parameter","displayName":"Protocol Location","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"Avro protocol location"},"reflectionProtocol":{"index":7,"kind":"parameter","displayName":"Reflection Protocol","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"If the protocol object provided is reflection protocol. Should be used only with protocol parameter because for protocolClassName protocol type will be auto-detected"},"singleParameter":{"index":8,"kind":"parameter","displayName":"Single Parameter","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"If true, consumer parameter won't be wrapped into an array. Will fail if protocol specifies more than one parameter for the message"},"uriAuthority":{"index":9,"kind":"parameter","displayName":"Uri Authority","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.avro.AvroConfiguration","configurationField":"configuration","description":"Authority to use (username and password)"},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":13,"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."}}} , -{"component":{"kind":"component","name":"aws-bedrock","title":"AWS Bedrock","description":"Invoke Model of AWS Bedrock service.","deprecated":false,"firstVersion":"4.5.0","label":"ai,cloud","javaType":"org.apache.camel.component.aws2.bedrock.runtime.BedrockComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws-bedrock","version":"4.8.1","scheme":"aws-bedrock","extendsScheme":"","syntax":"aws-bedrock:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsBedrockOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConstants#OPERATION"},"CamelAwsBedrockContentType":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The model content type","constantName":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConstants#MODEL_CONTENT_TYPE"},"CamelAwsBedrockAcceptContentType":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The model accept content type","constantName":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConstants#MODEL_ACCEPT_CONTENT_TYPE"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Logical name"},"modelId":{"index":1,"kind":"parameter","displayName":"Model Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["amazon.titan-text-express-v1","amazon.titan-text-lite-v1","amazon.titan-image-generator-v1","amazon.titan-embed-text-v1","ai21.j2-ultra-v1","ai21.j2-mid-v1","anthropic.claude-instant-v1","anthropic.claude-v2","anthropic.claude-v2:1","anthropic.claude-3-sonnet-20240229-v1:0","anthropic.claude-3-haiku-20240307-v1:0","amazon.titan-text-premier-v1:0","amazon.titan-embed-text-v2:0"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Define the model Id we are going to use"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.bedrock.runtime.BedrockOperations","enum":["invokeTextModel","invokeImageModel","invokeEmbeddingsModel"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":5,"kind":"parameter","displayName":"Profile Credentials Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":6,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["us-east-1","us-west-1","ap-southeast-1","ap-northeast-1","eu-central-1"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"The region in which Bedrock client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":7,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"index":8,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Set whether the Bedrock client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":9,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Set whether the Bedrock client should expect to load credentials through a profile credentials provider."},"lazyStartProducer":{"index":10,"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."},"bedrockRuntimeClient":{"index":11,"kind":"parameter","displayName":"Bedrock Runtime Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.bedrockruntime.BedrockRuntimeClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"To use an existing configured AWS Bedrock Runtime client"},"proxyHost":{"index":12,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the Bedrock client"},"proxyPort":{"index":13,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the Bedrock client"},"proxyProtocol":{"index":14,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Bedrock client"},"accessKey":{"index":15,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":16,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":17,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":18,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useSessionCredentials":{"index":19,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Set whether the Bedrock client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Bedrock."}}} +{"component":{"kind":"component","name":"aws-bedrock","title":"AWS Bedrock","description":"Invoke Model of AWS Bedrock service.","deprecated":false,"firstVersion":"4.5.0","label":"ai,cloud","javaType":"org.apache.camel.component.aws2.bedrock.runtime.BedrockComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws-bedrock","version":"4.8.2","scheme":"aws-bedrock","extendsScheme":"","syntax":"aws-bedrock:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsBedrockOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConstants#OPERATION"},"CamelAwsBedrockContentType":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The model content type","constantName":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConstants#MODEL_CONTENT_TYPE"},"CamelAwsBedrockAcceptContentType":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The model accept content type","constantName":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConstants#MODEL_ACCEPT_CONTENT_TYPE"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Logical name"},"modelId":{"index":1,"kind":"parameter","displayName":"Model Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["amazon.titan-text-express-v1","amazon.titan-text-lite-v1","amazon.titan-image-generator-v1","amazon.titan-embed-text-v1","ai21.j2-ultra-v1","ai21.j2-mid-v1","anthropic.claude-instant-v1","anthropic.claude-v2","anthropic.claude-v2:1","anthropic.claude-3-sonnet-20240229-v1:0","anthropic.claude-3-haiku-20240307-v1:0","amazon.titan-text-premier-v1:0","amazon.titan-embed-text-v2:0"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Define the model Id we are going to use"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.bedrock.runtime.BedrockOperations","enum":["invokeTextModel","invokeImageModel","invokeEmbeddingsModel"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":5,"kind":"parameter","displayName":"Profile Credentials Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":6,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["us-east-1","us-west-1","ap-southeast-1","ap-northeast-1","eu-central-1"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"The region in which Bedrock client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":7,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"index":8,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Set whether the Bedrock client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":9,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Set whether the Bedrock client should expect to load credentials through a profile credentials provider."},"lazyStartProducer":{"index":10,"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."},"bedrockRuntimeClient":{"index":11,"kind":"parameter","displayName":"Bedrock Runtime Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.bedrockruntime.BedrockRuntimeClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"To use an existing configured AWS Bedrock Runtime client"},"proxyHost":{"index":12,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the Bedrock client"},"proxyPort":{"index":13,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the Bedrock client"},"proxyProtocol":{"index":14,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Bedrock client"},"accessKey":{"index":15,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":16,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":17,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":18,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useSessionCredentials":{"index":19,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.runtime.BedrockConfiguration","configurationField":"configuration","description":"Set whether the Bedrock client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Bedrock."}}} , -{"component":{"kind":"component","name":"aws-bedrock-agent","title":"AWS Bedrock Agent","description":"Operate on AWS Bedrock through its Agent.","deprecated":false,"firstVersion":"4.5.0","label":"ai,cloud","javaType":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws-bedrock","version":"4.8.1","scheme":"aws-bedrock-agent","extendsScheme":"","syntax":"aws-bedrock-agent:label","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAwsBedrockAgentRuntimeOperation":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConstants#OPERATION"},"CamelAwsBedrockAgentRuntimeCitations":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When retrieving and generating a response, this header will contain the citations","constantName":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConstants#CITATIONS"},"CamelAwsBedrockAgentRuntimeSessionId":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When retrieving and generating a response, this header will contain he unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.","constantName":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConstants#SESSION_ID"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Logical name"},"dataSourceId":{"index":1,"kind":"parameter","displayName":"Data Source Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Define the Data source Id we are going to use"},"knowledgeBaseId":{"index":2,"kind":"parameter","displayName":"Knowledge Base Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Define the Knowledge Base Id we are going to use"},"modelId":{"index":3,"kind":"parameter","displayName":"Model Id","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["anthropic.claude-instant-v1","anthropic.claude-v2","anthropic.claude-v2:1"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Define the model Id we are going to use"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentOperations","enum":["startIngestionJob","listIngestionJobs","getIngestionJob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":5,"kind":"parameter","displayName":"Override Endpoint","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":6,"kind":"parameter","displayName":"Pojo Request","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":7,"kind":"parameter","displayName":"Profile Credentials Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":8,"kind":"parameter","displayName":"Region","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["us-east-1","us-west-1","ap-southeast-1","ap-northeast-1","eu-central-1"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"The region in which Bedrock Agent client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":9,"kind":"parameter","displayName":"Uri Endpoint Override","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"index":10,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Set whether the Bedrock Agent client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":11,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Set whether the Bedrock Agent client should expect to load credentials through a profile credentials provider."},"ingestionJobId":{"index":12,"kind":"parameter","displayName":"Ingestion Job Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Define the Ingestion Job Id we want to track"},"sendEmptyMessageWhenIdle":{"index":13,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":17,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":18,"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."},"bedrockAgentClient":{"index":19,"kind":"parameter","displayName":"Bedrock Agent Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.bedrockagent.BedrockAgentClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"To use an existing configured AWS Bedrock Agent client"},"proxyHost":{"index":20,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the Bedrock Agent client"},"proxyPort":{"index":21,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the Bedrock Agent client"},"proxyProtocol":{"index":22,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Bedrock Agent client"},"backoffErrorThreshold":{"index":23,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":24,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":25,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":26,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":27,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":28,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":29,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":30,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":31,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":32,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":33,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":34,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":35,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":36,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":37,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":38,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":39,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":40,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useSessionCredentials":{"index":41,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Set whether the Bedrock Agent client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Bedrock."}}} +{"component":{"kind":"component","name":"aws-bedrock-agent","title":"AWS Bedrock Agent","description":"Operate on AWS Bedrock through its Agent.","deprecated":false,"firstVersion":"4.5.0","label":"ai,cloud","javaType":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws-bedrock","version":"4.8.2","scheme":"aws-bedrock-agent","extendsScheme":"","syntax":"aws-bedrock-agent:label","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAwsBedrockAgentRuntimeOperation":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConstants#OPERATION"},"CamelAwsBedrockAgentRuntimeCitations":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When retrieving and generating a response, this header will contain the citations","constantName":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConstants#CITATIONS"},"CamelAwsBedrockAgentRuntimeSessionId":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When retrieving and generating a response, this header will contain he unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.","constantName":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConstants#SESSION_ID"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Logical name"},"dataSourceId":{"index":1,"kind":"parameter","displayName":"Data Source Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Define the Data source Id we are going to use"},"knowledgeBaseId":{"index":2,"kind":"parameter","displayName":"Knowledge Base Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Define the Knowledge Base Id we are going to use"},"modelId":{"index":3,"kind":"parameter","displayName":"Model Id","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["anthropic.claude-instant-v1","anthropic.claude-v2","anthropic.claude-v2:1"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Define the model Id we are going to use"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentOperations","enum":["startIngestionJob","listIngestionJobs","getIngestionJob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":5,"kind":"parameter","displayName":"Override Endpoint","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":6,"kind":"parameter","displayName":"Pojo Request","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":7,"kind":"parameter","displayName":"Profile Credentials Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":8,"kind":"parameter","displayName":"Region","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["us-east-1","us-west-1","ap-southeast-1","ap-northeast-1","eu-central-1"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"The region in which Bedrock Agent client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":9,"kind":"parameter","displayName":"Uri Endpoint Override","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"index":10,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Set whether the Bedrock Agent client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":11,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Set whether the Bedrock Agent client should expect to load credentials through a profile credentials provider."},"ingestionJobId":{"index":12,"kind":"parameter","displayName":"Ingestion Job Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Define the Ingestion Job Id we want to track"},"sendEmptyMessageWhenIdle":{"index":13,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":17,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":18,"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."},"bedrockAgentClient":{"index":19,"kind":"parameter","displayName":"Bedrock Agent Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.bedrockagent.BedrockAgentClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"To use an existing configured AWS Bedrock Agent client"},"proxyHost":{"index":20,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the Bedrock Agent client"},"proxyPort":{"index":21,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the Bedrock Agent client"},"proxyProtocol":{"index":22,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Bedrock Agent client"},"backoffErrorThreshold":{"index":23,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":24,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":25,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":26,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":27,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":28,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":29,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":30,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":31,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":32,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":33,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":34,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":35,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":36,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":37,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":38,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":39,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":40,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useSessionCredentials":{"index":41,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agent.BedrockAgentConfiguration","configurationField":"configuration","description":"Set whether the Bedrock Agent client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Bedrock."}}} , -{"component":{"kind":"component","name":"aws-bedrock-agent-runtime","title":"AWS Bedrock Agent Runtime","description":"Invoke Model of AWS Bedrock Agent Runtime service.","deprecated":false,"firstVersion":"4.5.0","label":"ai,cloud","javaType":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws-bedrock","version":"4.8.1","scheme":"aws-bedrock-agent-runtime","extendsScheme":"","syntax":"aws-bedrock-agent-runtime:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsBedrockAgentRuntimeOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConstants#OPERATION"},"CamelAwsBedrockAgentRuntimeCitations":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When retrieving and generating a response, this header will contain the citations","constantName":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConstants#CITATIONS"},"CamelAwsBedrockAgentRuntimeSessionId":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When retrieving and generating a response, this header will contain he unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.","constantName":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConstants#SESSION_ID"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Logical name"},"knowledgeBaseId":{"index":1,"kind":"parameter","displayName":"Knowledge Base Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Define the Knowledge Base Id we are going to use"},"modelId":{"index":2,"kind":"parameter","displayName":"Model Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["anthropic.claude-instant-v1","anthropic.claude-v2","anthropic.claude-v2:1"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Define the model Id we are going to use"},"operation":{"index":3,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeOperations","enum":["retrieveAndGenerate"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":4,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":5,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":6,"kind":"parameter","displayName":"Profile Credentials Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":7,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["us-east-1","us-west-1","ap-southeast-1","ap-northeast-1","eu-central-1"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"The region in which Bedrock Agent Runtime client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":8,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"index":9,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Set whether the Bedrock Agent Runtime client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":10,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Set whether the Bedrock Agent Runtime client should expect to load credentials through a profile credentials provider."},"lazyStartProducer":{"index":11,"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."},"bedrockAgentRuntimeClient":{"index":12,"kind":"parameter","displayName":"Bedrock Agent Runtime Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.bedrockagentruntime.BedrockAgentRuntimeClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"To use an existing configured AWS Bedrock Agent Runtime client"},"proxyHost":{"index":13,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the Bedrock Agent Runtime client"},"proxyPort":{"index":14,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the Bedrock Agent Runtime client"},"proxyProtocol":{"index":15,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Bedrock Agent Runtime client"},"accessKey":{"index":16,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":17,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":18,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":19,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useSessionCredentials":{"index":20,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Set whether the Bedrock Agent Runtime client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Bedrock."}}} +{"component":{"kind":"component","name":"aws-bedrock-agent-runtime","title":"AWS Bedrock Agent Runtime","description":"Invoke Model of AWS Bedrock Agent Runtime service.","deprecated":false,"firstVersion":"4.5.0","label":"ai,cloud","javaType":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws-bedrock","version":"4.8.2","scheme":"aws-bedrock-agent-runtime","extendsScheme":"","syntax":"aws-bedrock-agent-runtime:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsBedrockAgentRuntimeOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConstants#OPERATION"},"CamelAwsBedrockAgentRuntimeCitations":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When retrieving and generating a response, this header will contain the citations","constantName":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConstants#CITATIONS"},"CamelAwsBedrockAgentRuntimeSessionId":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When retrieving and generating a response, this header will contain he unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.","constantName":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConstants#SESSION_ID"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Logical name"},"knowledgeBaseId":{"index":1,"kind":"parameter","displayName":"Knowledge Base Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Define the Knowledge Base Id we are going to use"},"modelId":{"index":2,"kind":"parameter","displayName":"Model Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["anthropic.claude-instant-v1","anthropic.claude-v2","anthropic.claude-v2:1"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Define the model Id we are going to use"},"operation":{"index":3,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeOperations","enum":["retrieveAndGenerate"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":4,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":5,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":6,"kind":"parameter","displayName":"Profile Credentials Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":7,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["us-east-1","us-west-1","ap-southeast-1","ap-northeast-1","eu-central-1"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"The region in which Bedrock Agent Runtime client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":8,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"index":9,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Set whether the Bedrock Agent Runtime client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":10,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Set whether the Bedrock Agent Runtime client should expect to load credentials through a profile credentials provider."},"lazyStartProducer":{"index":11,"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."},"bedrockAgentRuntimeClient":{"index":12,"kind":"parameter","displayName":"Bedrock Agent Runtime Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.bedrockagentruntime.BedrockAgentRuntimeClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"To use an existing configured AWS Bedrock Agent Runtime client"},"proxyHost":{"index":13,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the Bedrock Agent Runtime client"},"proxyPort":{"index":14,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the Bedrock Agent Runtime client"},"proxyProtocol":{"index":15,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Bedrock Agent Runtime client"},"accessKey":{"index":16,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":17,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":18,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":19,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useSessionCredentials":{"index":20,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.bedrock.agentruntime.BedrockAgentRuntimeConfiguration","configurationField":"configuration","description":"Set whether the Bedrock Agent Runtime client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Bedrock."}}} , -{"component":{"kind":"component","name":"aws-cloudtrail","title":"AWS Cloudtrail","description":"Consume events from Amazon Cloudtrail using AWS SDK version 2.x.","deprecated":false,"firstVersion":"3.19.0","label":"cloud,management,monitoring","javaType":"org.apache.camel.component.aws.cloudtrail.CloudtrailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws-cloudtrail","version":"4.8.1","scheme":"aws-cloudtrail","extendsScheme":"","syntax":"aws-cloudtrail:label","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAwsCloudTrailEventId":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event ID of the cloud trail event consumed.","constantName":"org.apache.camel.component.aws.cloudtrail.CloudtrailConstants#EVENT_ID"},"CamelAwsCloudTrailEventName":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event Name of the cloud trail event consumed.","constantName":"org.apache.camel.component.aws.cloudtrail.CloudtrailConstants#EVENT_NAME"},"CamelAwsCloudTrailEventSource":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event Source of the cloud trail event consumed.","constantName":"org.apache.camel.component.aws.cloudtrail.CloudtrailConstants#EVENT_SOURCE"},"CamelAwsCloudTrailEventUsername":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The associated username of the event of the cloud trail event consumed.","constantName":"org.apache.camel.component.aws.cloudtrail.CloudtrailConstants#USERNAME"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"A label for indexing cloudtrail endpoints"},"eventSource":{"index":1,"kind":"parameter","displayName":"Event Source","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Specify an event source to select events"},"maxResults":{"index":2,"kind":"parameter","displayName":"Max Results","group":"consumer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Maximum number of records that will be fetched in each poll"},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"The region in which Cloudtrail client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"sendEmptyMessageWhenIdle":{"index":5,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"uriEndpointOverride":{"index":6,"kind":"parameter","displayName":"Uri Endpoint Override","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":10,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"cloudTrailClient":{"index":11,"kind":"parameter","displayName":"Cloud Trail Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.cloudtrail.CloudTrailClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Amazon Cloudtrail client to use for all requests for this endpoint"},"proxyHost":{"index":12,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the Cloudtrail client"},"proxyPort":{"index":13,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the Cloudtrail client"},"proxyProtocol":{"index":14,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Cloudtrail client"},"backoffErrorThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":17,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":18,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":19,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":20,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":21,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":22,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":23,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":24,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":25,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":26,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":27,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":28,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":29,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":30,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"If using a profile credentials provider this parameter will set the profile name."},"secretKey":{"index":31,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":32,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume a IAM role"},"trustAllCertificates":{"index":33,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":34,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Set whether the Cloudtrail client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":35,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Set whether the Cloudtrail client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":36,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Set whether the CloudTrail client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in CloudTrail."}}} +{"component":{"kind":"component","name":"aws-cloudtrail","title":"AWS Cloudtrail","description":"Consume events from Amazon Cloudtrail using AWS SDK version 2.x.","deprecated":false,"firstVersion":"3.19.0","label":"cloud,management,monitoring","javaType":"org.apache.camel.component.aws.cloudtrail.CloudtrailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws-cloudtrail","version":"4.8.2","scheme":"aws-cloudtrail","extendsScheme":"","syntax":"aws-cloudtrail:label","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAwsCloudTrailEventId":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event ID of the cloud trail event consumed.","constantName":"org.apache.camel.component.aws.cloudtrail.CloudtrailConstants#EVENT_ID"},"CamelAwsCloudTrailEventName":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event Name of the cloud trail event consumed.","constantName":"org.apache.camel.component.aws.cloudtrail.CloudtrailConstants#EVENT_NAME"},"CamelAwsCloudTrailEventSource":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event Source of the cloud trail event consumed.","constantName":"org.apache.camel.component.aws.cloudtrail.CloudtrailConstants#EVENT_SOURCE"},"CamelAwsCloudTrailEventUsername":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The associated username of the event of the cloud trail event consumed.","constantName":"org.apache.camel.component.aws.cloudtrail.CloudtrailConstants#USERNAME"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"A label for indexing cloudtrail endpoints"},"eventSource":{"index":1,"kind":"parameter","displayName":"Event Source","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Specify an event source to select events"},"maxResults":{"index":2,"kind":"parameter","displayName":"Max Results","group":"consumer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Maximum number of records that will be fetched in each poll"},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"The region in which Cloudtrail client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"sendEmptyMessageWhenIdle":{"index":5,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"uriEndpointOverride":{"index":6,"kind":"parameter","displayName":"Uri Endpoint Override","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":10,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"cloudTrailClient":{"index":11,"kind":"parameter","displayName":"Cloud Trail Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.cloudtrail.CloudTrailClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Amazon Cloudtrail client to use for all requests for this endpoint"},"proxyHost":{"index":12,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the Cloudtrail client"},"proxyPort":{"index":13,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the Cloudtrail client"},"proxyProtocol":{"index":14,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Cloudtrail client"},"backoffErrorThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":17,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":18,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":19,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":20,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":21,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":22,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":23,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":24,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":25,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":26,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":27,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":28,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":29,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":30,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"If using a profile credentials provider this parameter will set the profile name."},"secretKey":{"index":31,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":32,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume a IAM role"},"trustAllCertificates":{"index":33,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":34,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Set whether the Cloudtrail client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":35,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Set whether the Cloudtrail client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":36,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration","configurationField":"configuration","description":"Set whether the CloudTrail client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in CloudTrail."}}} , -{"component":{"kind":"component","name":"aws-config","title":"AWS Config Service","description":"Manage AWS Config service.","deprecated":false,"firstVersion":"4.3.0","label":"cloud,management","javaType":"org.apache.camel.component.aws.config.AWSConfigComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws-config","version":"4.8.1","scheme":"aws-config","extendsScheme":"","syntax":"aws-config:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsConfigOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws.config.AWSConfigConstants#OPERATION"},"CamelAwsConfigRuleSourceIdentifier":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Managed rule source identifier","constantName":"org.apache.camel.component.aws.config.AWSConfigConstants#RULE_SOURCE_IDENTIFIER"},"CamelAwsConfigRuleSource":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The source object for the rule. The owner of the rule could be AWS, CUSTOM_LAMBDA or CUSTOM_POLICY","constantName":"org.apache.camel.component.aws.config.AWSConfigConstants#SOURCE"},"CamelAwsConfigRuleName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Managed rule name","constantName":"org.apache.camel.component.aws.config.AWSConfigConstants#RULE_NAME"},"CamelAwsConformancePackName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Conformance pack name","constantName":"org.apache.camel.component.aws.config.AWSConfigConstants#CONFORMACE_PACK_NAME"},"CamelAwsConfigConformacePackS3TemplateURI":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The location of the file containing the template body in S3","constantName":"org.apache.camel.component.aws.config.AWSConfigConstants#CONFORMACE_PACK_S3_TEMPLATE_URI"},"CamelAwsConfigConformacePackTemplateBody":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A string containing the full conformance pack template body","constantName":"org.apache.camel.component.aws.config.AWSConfigConstants#CONFORMACE_PACK_TEMPLATE_BODY"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws.config.AWSConfigOperations","enum":["putConfigRule","removeConfigRule","describeRuleCompliance","putConformancePack","removeConformancePack"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"The region in which the Config client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":5,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":6,"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."},"configClient":{"index":7,"kind":"parameter","displayName":"Config Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.config.ConfigClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Amazon AWS Config Client instance"},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the Config client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the Config client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Config client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Set whether the Config client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Set whether the Config client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Set whether the Config client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Config."}}} +{"component":{"kind":"component","name":"aws-config","title":"AWS Config Service","description":"Manage AWS Config service.","deprecated":false,"firstVersion":"4.3.0","label":"cloud,management","javaType":"org.apache.camel.component.aws.config.AWSConfigComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws-config","version":"4.8.2","scheme":"aws-config","extendsScheme":"","syntax":"aws-config:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsConfigOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws.config.AWSConfigConstants#OPERATION"},"CamelAwsConfigRuleSourceIdentifier":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Managed rule source identifier","constantName":"org.apache.camel.component.aws.config.AWSConfigConstants#RULE_SOURCE_IDENTIFIER"},"CamelAwsConfigRuleSource":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The source object for the rule. The owner of the rule could be AWS, CUSTOM_LAMBDA or CUSTOM_POLICY","constantName":"org.apache.camel.component.aws.config.AWSConfigConstants#SOURCE"},"CamelAwsConfigRuleName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Managed rule name","constantName":"org.apache.camel.component.aws.config.AWSConfigConstants#RULE_NAME"},"CamelAwsConformancePackName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Conformance pack name","constantName":"org.apache.camel.component.aws.config.AWSConfigConstants#CONFORMACE_PACK_NAME"},"CamelAwsConfigConformacePackS3TemplateURI":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The location of the file containing the template body in S3","constantName":"org.apache.camel.component.aws.config.AWSConfigConstants#CONFORMACE_PACK_S3_TEMPLATE_URI"},"CamelAwsConfigConformacePackTemplateBody":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A string containing the full conformance pack template body","constantName":"org.apache.camel.component.aws.config.AWSConfigConstants#CONFORMACE_PACK_TEMPLATE_BODY"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws.config.AWSConfigOperations","enum":["putConfigRule","removeConfigRule","describeRuleCompliance","putConformancePack","removeConformancePack"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"The region in which the Config client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":5,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":6,"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."},"configClient":{"index":7,"kind":"parameter","displayName":"Config Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.config.ConfigClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Amazon AWS Config Client instance"},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the Config client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the Config client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Config client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Set whether the Config client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Set whether the Config client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.config.AWSConfigConfiguration","configurationField":"configuration","description":"Set whether the Config client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Config."}}} , -{"component":{"kind":"component","name":"aws-secrets-manager","title":"AWS Secrets Manager","description":"Manage secrets using AWS Secrets Manager.","deprecated":false,"firstVersion":"3.9.0","label":"cloud,management","javaType":"org.apache.camel.component.aws.secretsmanager.SecretsManagerComponent","supportLevel":"Stable","metadata":{"vault":"aws-secrets-manager"},"groupId":"org.apache.camel","artifactId":"camel-aws-secrets-manager","version":"4.8.1","scheme":"aws-secrets-manager","extendsScheme":"","syntax":"aws-secrets-manager:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsSecretsManagerOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#OPERATION"},"CamelAwsSecretsManagerMaxResults":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of results to include in the response.","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#MAX_RESULTS"},"CamelAwsSecretsManagerSecretName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the secret.","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#SECRET_NAME"},"CamelAwsSecretsManagerSecretDescription":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The description of the secret.","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#SECRET_DESCRIPTION"},"CamelAwsSecretsManagerSecretId":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ARN or name of the secret.","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#SECRET_ID"},"CamelAwsSecretsManagerLambdaRotationFunctionArn":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ARN of the Lambda rotation function that can rotate the secret.","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#LAMBDA_ROTATION_FUNCTION_ARN"},"CamelAwsSecretsManagerSecretVersionId":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The unique identifier of the version of the secret.","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#SECRET_VERSION_ID"},"CamelAwsSecretsManagerSecretReplicationRegions":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A comma separated list of Regions in which to replicate the secret.","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#SECRET_REPLICATION_REGIONS"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Logical name"},"binaryPayload":{"index":1,"kind":"parameter","displayName":"Binary Payload","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Set if the secret is binary or not"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws.secretsmanager.SecretsManagerOperations","enum":["listSecrets","createSecret","getSecret","describeSecret","deleteSecret","rotateSecret","updateSecret","restoreSecret","replicateSecretToRegions"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":5,"kind":"parameter","displayName":"Profile Credentials Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":6,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"The region in which a Secrets Manager client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":7,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useProfileCredentialsProvider":{"index":8,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Set whether the Secrets Manager client should expect to load credentials through a profile credentials provider."},"lazyStartProducer":{"index":9,"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."},"secretsManagerClient":{"index":10,"kind":"parameter","displayName":"Secrets Manager Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.secretsmanager.SecretsManagerClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"To use an existing configured AWS Secrets Manager client"},"proxyHost":{"index":11,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the Secrets Manager client"},"proxyPort":{"index":12,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the Secrets Manager client"},"proxyProtocol":{"index":13,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Secrets Manager client"},"accessKey":{"index":14,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":15,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":16,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":17,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":18,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Set whether the Translate client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useSessionCredentials":{"index":19,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Set whether the Secrets Manager client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Secrets Manager."}}} +{"component":{"kind":"component","name":"aws-secrets-manager","title":"AWS Secrets Manager","description":"Manage secrets using AWS Secrets Manager.","deprecated":false,"firstVersion":"3.9.0","label":"cloud,management","javaType":"org.apache.camel.component.aws.secretsmanager.SecretsManagerComponent","supportLevel":"Stable","metadata":{"vault":"aws-secrets-manager"},"groupId":"org.apache.camel","artifactId":"camel-aws-secrets-manager","version":"4.8.2","scheme":"aws-secrets-manager","extendsScheme":"","syntax":"aws-secrets-manager:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsSecretsManagerOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#OPERATION"},"CamelAwsSecretsManagerMaxResults":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of results to include in the response.","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#MAX_RESULTS"},"CamelAwsSecretsManagerSecretName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the secret.","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#SECRET_NAME"},"CamelAwsSecretsManagerSecretDescription":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The description of the secret.","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#SECRET_DESCRIPTION"},"CamelAwsSecretsManagerSecretId":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ARN or name of the secret.","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#SECRET_ID"},"CamelAwsSecretsManagerLambdaRotationFunctionArn":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ARN of the Lambda rotation function that can rotate the secret.","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#LAMBDA_ROTATION_FUNCTION_ARN"},"CamelAwsSecretsManagerSecretVersionId":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The unique identifier of the version of the secret.","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#SECRET_VERSION_ID"},"CamelAwsSecretsManagerSecretReplicationRegions":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A comma separated list of Regions in which to replicate the secret.","constantName":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConstants#SECRET_REPLICATION_REGIONS"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Logical name"},"binaryPayload":{"index":1,"kind":"parameter","displayName":"Binary Payload","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Set if the secret is binary or not"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws.secretsmanager.SecretsManagerOperations","enum":["listSecrets","createSecret","getSecret","describeSecret","deleteSecret","rotateSecret","updateSecret","restoreSecret","replicateSecretToRegions"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":5,"kind":"parameter","displayName":"Profile Credentials Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":6,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"The region in which a Secrets Manager client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":7,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useProfileCredentialsProvider":{"index":8,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Set whether the Secrets Manager client should expect to load credentials through a profile credentials provider."},"lazyStartProducer":{"index":9,"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."},"secretsManagerClient":{"index":10,"kind":"parameter","displayName":"Secrets Manager Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.secretsmanager.SecretsManagerClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"To use an existing configured AWS Secrets Manager client"},"proxyHost":{"index":11,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the Secrets Manager client"},"proxyPort":{"index":12,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the Secrets Manager client"},"proxyProtocol":{"index":13,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Secrets Manager client"},"accessKey":{"index":14,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":15,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":16,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":17,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":18,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Set whether the Translate client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useSessionCredentials":{"index":19,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration","configurationField":"configuration","description":"Set whether the Secrets Manager client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Secrets Manager."}}} , -{"component":{"kind":"component","name":"aws2-athena","title":"AWS Athena","description":"Access AWS Athena.","deprecated":false,"firstVersion":"3.4.0","label":"cloud,database","javaType":"org.apache.camel.component.aws2.athena.Athena2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-athena","version":"4.8.1","scheme":"aws2-athena","extendsScheme":"","syntax":"aws2-athena:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsAthenaOperation":{"index":0,"kind":"header","displayName":"","group":"all","label":"all","required":false,"javaType":"org.apache.camel.component.aws2.athena.Athena2Operations","enum":["getQueryExecution","getQueryResults","listQueryExecutions","startQueryExecution"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"startQueryExecution","description":"The operation to perform. Permitted values are getQueryExecution, getQueryResults, listQueryExecutions, startQueryExecution.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#OPERATION"},"CamelAwsAthenaDatabase":{"index":1,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Athena database to use.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#DATABASE"},"CamelAwsAthenaQueryExecutionId":{"index":2,"kind":"header","displayName":"","group":"getQueryExecution getQueryResults startQueryExecution","label":"getQueryExecution getQueryResults startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The unique ID identifying the query execution.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#QUERY_EXECUTION_ID"},"CamelAwsAthenaWorkGroup":{"index":3,"kind":"header","displayName":"","group":"listQueryExecutions startQueryExecution","label":"listQueryExecutions startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The workgroup to use for running the query.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#WORK_GROUP"},"CamelAwsAthenaNextToken":{"index":4,"kind":"header","displayName":"","group":"getQueryResults listQueryExecutions","label":"getQueryResults listQueryExecutions","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Pagination token to use in the case where the response from the previous request was truncated.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#NEXT_TOKEN"},"CamelAwsAthenaMaxResults":{"index":5,"kind":"header","displayName":"","group":"getQueryResults listQueryExecutions","label":"getQueryResults listQueryExecutions","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Max number of results to return for the given operation (if supported by the Athena API endpoint). If not set, will use the Athena API default for the given operation.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#MAX_RESULTS"},"CamelAwsAthenaIncludeTrace":{"index":6,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Include useful trace information at the beginning of queries as an SQL comment (prefixed with --).","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#INCLUDE_TRACE"},"CamelAwsAthenaOutputLocation":{"index":7,"kind":"header","displayName":"","group":"getQueryExecution getQueryResults startQueryExecution","label":"getQueryExecution getQueryResults startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The location in Amazon S3 where query results are stored, such as s3://path/to/query/bucket/. Ensure this value ends with a forward slash ('/').","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#OUTPUT_LOCATION"},"CamelAwsAthenaOutputType":{"index":8,"kind":"header","displayName":"","group":"getQueryResults","label":"getQueryResults","required":false,"javaType":"org.apache.camel.component.aws2.athena.Athena2OutputType","enum":["StreamList","SelectList","S3Pointer"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"How query results should be returned. One of StreamList (default - return a GetQueryResultsIterable that can page through all results), SelectList (returns at most 1,000 rows at a time, plus a NextToken value as a header than can be used for manual pagination of results), S3Pointer (return an S3 path pointing to the results).","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#OUTPUT_TYPE"},"CamelAwsAthenaQueryExecutionState":{"index":9,"kind":"header","displayName":"","group":"getQueryExecution getQueryResults startQueryExecution","label":"getQueryExecution getQueryResults startQueryExecution","required":false,"javaType":"software.amazon.awssdk.services.athena.model.QueryExecutionState","enum":["QUEUED","RUNNING","SUCCEEDED","FAILED","CANCELLED","null"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The state of the query execution.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#QUERY_EXECUTION_STATE"},"CamelAwsAthenaClientRequestToken":{"index":10,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A unique string to ensure issues queries are idempotent. It is unlikely you will need to set this.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#CLIENT_REQUEST_TOKEN"},"CamelAwsAthenaQueryString":{"index":11,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SQL query to run. Except for simple queries, prefer setting this as the body of the Exchange or as this header to avoid having to deal with URL encoding issues.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#QUERY_STRING"},"CamelAwsAthenaEncryptionOption":{"index":12,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"software.amazon.awssdk.services.athena.model.EncryptionOption","enum":["SSE_S3","SSE_KMS","CSE_KMS","null"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The encryption type to use when storing query results in S3.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#ENCRYPTION_OPTION"},"CamelAwsAthenaKmsKey":{"index":13,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#KMS_KEY"},"CamelAwsAthenaWaitTimeout":{"index":14,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Optional max wait time in millis to wait for a successful query completion. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#WAIT_TIMEOUT"},"CamelAwsAthenaInitialDelay":{"index":15,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Milliseconds before the first poll for query execution status. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#INITIAL_DELAY"},"CamelAwsAthenaDelay":{"index":16,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Milliseconds before the next poll for query execution status. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#DELAY"},"CamelAwsAthenaMaxAttempts":{"index":17,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Maximum number of times to attempt a query. Set to 1 to disable retries. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#MAX_ATTEMPTS"},"CamelAwsAthenaRetry":{"index":18,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Optional comma separated list of error types to retry the query for. Use 'retryable' to retry all retryable failure conditions (e.g. generic errors and resources exhausted), 'generic' to retry 'GENERIC_INTERNAL_ERROR' failures, 'exhausted' to retry queries that have exhausted resource limits, 'always' to always retry regardless of failure condition, or 'never' or null to never retry (default). See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#RETRY"},"CamelAwsAthenaResetWaitTimeoutOnRetry":{"index":19,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reset the waitTimeout countdown in the event of a query retry. If set to true, potential max time spent waiting for queries is equal to waitTimeout x maxAttempts. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#RESET_WAIT_TIMEOUT_ON_RETRY"},"CamelAwsAthenaStartQueryExecutionAttempts":{"index":20,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Total number of attempts made to run the query. Will be greater than 1 if the query is retried.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#START_QUERY_EXECUTION_ATTEMPTS"},"CamelAwsAthenaStartQueryExecutionElapsedMillis":{"index":21,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Total time in millis taken in startQueryExecution (mostly relevant when waiting for query completion within startQueryExecution).","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#START_QUERY_EXECUTION_ELAPSED_MILLIS"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Logical name"},"database":{"index":1,"kind":"parameter","displayName":"Database","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The Athena database to use."},"delay":{"index":2,"kind":"parameter","displayName":"Delay","group":"producer","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":2000,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Milliseconds before the next poll for query execution status. See the section Waiting for Query Completion and Retrying Failed Queries to learn more."},"initialDelay":{"index":3,"kind":"parameter","displayName":"Initial Delay","group":"producer","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Milliseconds before the first poll for query execution status. See the section Waiting for Query Completion and Retrying Failed Queries to learn more."},"maxAttempts":{"index":4,"kind":"parameter","displayName":"Max Attempts","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Maximum number of times to attempt a query. Set to 1 to disable retries. See the section Waiting for Query Completion and Retrying Failed Queries to learn more."},"maxResults":{"index":5,"kind":"parameter","displayName":"Max Results","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Max number of results to return for the given operation (if supported by the Athena API endpoint). If not set, will use the Athena API default for the given operation."},"nextToken":{"index":6,"kind":"parameter","displayName":"Next Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Pagination token to use in the case where the response from the previous request was truncated."},"operation":{"index":7,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.athena.Athena2Operations","enum":["getQueryExecution","getQueryResults","listQueryExecutions","startQueryExecution"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"startQueryExecution","configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The Athena API function to call."},"outputLocation":{"index":8,"kind":"parameter","displayName":"Output Location","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The location in Amazon S3 where query results are stored, such as s3://path/to/query/bucket/. Ensure this value ends with a forward slash."},"outputType":{"index":9,"kind":"parameter","displayName":"Output Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.athena.Athena2OutputType","enum":["StreamList","SelectList","S3Pointer"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"StreamList","configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"How query results should be returned. One of StreamList (default - return a GetQueryResultsIterable that can page through all results), SelectList (returns at most 1000 rows at a time, plus a NextToken value as a header than can be used for manual pagination of results), S3Pointer (return an S3 path pointing to the results)."},"queryExecutionId":{"index":10,"kind":"parameter","displayName":"Query Execution Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The unique ID identifying the query execution."},"queryString":{"index":11,"kind":"parameter","displayName":"Query String","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The SQL query to run. Except for simple queries, prefer setting this as the body of the Exchange or as a header using Athena2Constants.QUERY_STRING to avoid having to deal with URL encoding issues."},"region":{"index":12,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The region in which Athena client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1)."},"resetWaitTimeoutOnRetry":{"index":13,"kind":"parameter","displayName":"Reset Wait Timeout On Retry","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Reset the waitTimeout countdown in the event of a query retry. If set to true, potential max time spent waiting for queries is equal to waitTimeout x maxAttempts. See the section Waiting for Query Completion and Retrying Failed Queries to learn more."},"retry":{"index":14,"kind":"parameter","displayName":"Retry","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["never","always","retryable","exhausted","generic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"never","configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Optional comma separated list of error types to retry the query for. Use: 'retryable' to retry all retryable failure conditions (e.g. generic errors and resources exhausted), 'generic' to retry 'GENERIC_INTERNAL_ERROR' failures, 'exhausted' to retry queries that have exhausted resource limits, 'always' to always retry regardless of failure condition, or 'never' or null to never retry (default). See the section Waiting for Query Completion and Retrying Failed Queries to learn more."},"waitTimeout":{"index":15,"kind":"parameter","displayName":"Wait Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Optional max wait time in millis to wait for a successful query completion. See the section Waiting for Query Completion and Retrying Failed Queries to learn more."},"workGroup":{"index":16,"kind":"parameter","displayName":"Work Group","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The workgroup to use for running the query."},"lazyStartProducer":{"index":17,"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."},"amazonAthenaClient":{"index":18,"kind":"parameter","displayName":"Amazon Athena Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.athena.AthenaClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The AmazonAthena instance to use as the client."},"clientRequestToken":{"index":19,"kind":"parameter","displayName":"Client Request Token","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"A unique string to ensure issues queries are idempotent. It is unlikely you will need to set this."},"includeTrace":{"index":20,"kind":"parameter","displayName":"Include Trace","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Include useful trace information at the beginning of queries as an SQL comment (prefixed with --)."},"proxyHost":{"index":21,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the Athena client."},"proxyPort":{"index":22,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the Athena client."},"proxyProtocol":{"index":23,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Athena client."},"accessKey":{"index":24,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key."},"encryptionOption":{"index":25,"kind":"parameter","displayName":"Encryption Option","group":"security","label":"security","required":false,"type":"object","javaType":"software.amazon.awssdk.services.athena.model.EncryptionOption","enum":["SSE_S3","SSE_KMS","CSE_KMS","null"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The encryption type to use when storing query results in S3. One of SSE_S3, SSE_KMS, or CSE_KMS."},"kmsKey":{"index":26,"kind":"parameter","displayName":"Kms Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID."},"profileCredentialsName":{"index":27,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":28,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key."},"sessionToken":{"index":29,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"useDefaultCredentialsProvider":{"index":30,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Set whether the Athena client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in"},"useProfileCredentialsProvider":{"index":31,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Set whether the Athena client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":32,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Set whether the Athena client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Athena."}}} +{"component":{"kind":"component","name":"aws2-athena","title":"AWS Athena","description":"Access AWS Athena.","deprecated":false,"firstVersion":"3.4.0","label":"cloud,database","javaType":"org.apache.camel.component.aws2.athena.Athena2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-athena","version":"4.8.2","scheme":"aws2-athena","extendsScheme":"","syntax":"aws2-athena:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsAthenaOperation":{"index":0,"kind":"header","displayName":"","group":"all","label":"all","required":false,"javaType":"org.apache.camel.component.aws2.athena.Athena2Operations","enum":["getQueryExecution","getQueryResults","listQueryExecutions","startQueryExecution"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"startQueryExecution","description":"The operation to perform. Permitted values are getQueryExecution, getQueryResults, listQueryExecutions, startQueryExecution.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#OPERATION"},"CamelAwsAthenaDatabase":{"index":1,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Athena database to use.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#DATABASE"},"CamelAwsAthenaQueryExecutionId":{"index":2,"kind":"header","displayName":"","group":"getQueryExecution getQueryResults startQueryExecution","label":"getQueryExecution getQueryResults startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The unique ID identifying the query execution.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#QUERY_EXECUTION_ID"},"CamelAwsAthenaWorkGroup":{"index":3,"kind":"header","displayName":"","group":"listQueryExecutions startQueryExecution","label":"listQueryExecutions startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The workgroup to use for running the query.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#WORK_GROUP"},"CamelAwsAthenaNextToken":{"index":4,"kind":"header","displayName":"","group":"getQueryResults listQueryExecutions","label":"getQueryResults listQueryExecutions","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Pagination token to use in the case where the response from the previous request was truncated.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#NEXT_TOKEN"},"CamelAwsAthenaMaxResults":{"index":5,"kind":"header","displayName":"","group":"getQueryResults listQueryExecutions","label":"getQueryResults listQueryExecutions","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Max number of results to return for the given operation (if supported by the Athena API endpoint). If not set, will use the Athena API default for the given operation.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#MAX_RESULTS"},"CamelAwsAthenaIncludeTrace":{"index":6,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Include useful trace information at the beginning of queries as an SQL comment (prefixed with --).","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#INCLUDE_TRACE"},"CamelAwsAthenaOutputLocation":{"index":7,"kind":"header","displayName":"","group":"getQueryExecution getQueryResults startQueryExecution","label":"getQueryExecution getQueryResults startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The location in Amazon S3 where query results are stored, such as s3://path/to/query/bucket/. Ensure this value ends with a forward slash ('/').","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#OUTPUT_LOCATION"},"CamelAwsAthenaOutputType":{"index":8,"kind":"header","displayName":"","group":"getQueryResults","label":"getQueryResults","required":false,"javaType":"org.apache.camel.component.aws2.athena.Athena2OutputType","enum":["StreamList","SelectList","S3Pointer"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"How query results should be returned. One of StreamList (default - return a GetQueryResultsIterable that can page through all results), SelectList (returns at most 1,000 rows at a time, plus a NextToken value as a header than can be used for manual pagination of results), S3Pointer (return an S3 path pointing to the results).","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#OUTPUT_TYPE"},"CamelAwsAthenaQueryExecutionState":{"index":9,"kind":"header","displayName":"","group":"getQueryExecution getQueryResults startQueryExecution","label":"getQueryExecution getQueryResults startQueryExecution","required":false,"javaType":"software.amazon.awssdk.services.athena.model.QueryExecutionState","enum":["QUEUED","RUNNING","SUCCEEDED","FAILED","CANCELLED","null"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The state of the query execution.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#QUERY_EXECUTION_STATE"},"CamelAwsAthenaClientRequestToken":{"index":10,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A unique string to ensure issues queries are idempotent. It is unlikely you will need to set this.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#CLIENT_REQUEST_TOKEN"},"CamelAwsAthenaQueryString":{"index":11,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SQL query to run. Except for simple queries, prefer setting this as the body of the Exchange or as this header to avoid having to deal with URL encoding issues.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#QUERY_STRING"},"CamelAwsAthenaEncryptionOption":{"index":12,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"software.amazon.awssdk.services.athena.model.EncryptionOption","enum":["SSE_S3","SSE_KMS","CSE_KMS","null"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The encryption type to use when storing query results in S3.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#ENCRYPTION_OPTION"},"CamelAwsAthenaKmsKey":{"index":13,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#KMS_KEY"},"CamelAwsAthenaWaitTimeout":{"index":14,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Optional max wait time in millis to wait for a successful query completion. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#WAIT_TIMEOUT"},"CamelAwsAthenaInitialDelay":{"index":15,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Milliseconds before the first poll for query execution status. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#INITIAL_DELAY"},"CamelAwsAthenaDelay":{"index":16,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Milliseconds before the next poll for query execution status. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#DELAY"},"CamelAwsAthenaMaxAttempts":{"index":17,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Maximum number of times to attempt a query. Set to 1 to disable retries. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#MAX_ATTEMPTS"},"CamelAwsAthenaRetry":{"index":18,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Optional comma separated list of error types to retry the query for. Use 'retryable' to retry all retryable failure conditions (e.g. generic errors and resources exhausted), 'generic' to retry 'GENERIC_INTERNAL_ERROR' failures, 'exhausted' to retry queries that have exhausted resource limits, 'always' to always retry regardless of failure condition, or 'never' or null to never retry (default). See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#RETRY"},"CamelAwsAthenaResetWaitTimeoutOnRetry":{"index":19,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reset the waitTimeout countdown in the event of a query retry. If set to true, potential max time spent waiting for queries is equal to waitTimeout x maxAttempts. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#RESET_WAIT_TIMEOUT_ON_RETRY"},"CamelAwsAthenaStartQueryExecutionAttempts":{"index":20,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Total number of attempts made to run the query. Will be greater than 1 if the query is retried.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#START_QUERY_EXECUTION_ATTEMPTS"},"CamelAwsAthenaStartQueryExecutionElapsedMillis":{"index":21,"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Total time in millis taken in startQueryExecution (mostly relevant when waiting for query completion within startQueryExecution).","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#START_QUERY_EXECUTION_ELAPSED_MILLIS"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Logical name"},"database":{"index":1,"kind":"parameter","displayName":"Database","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The Athena database to use."},"delay":{"index":2,"kind":"parameter","displayName":"Delay","group":"producer","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":2000,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Milliseconds before the next poll for query execution status. See the section Waiting for Query Completion and Retrying Failed Queries to learn more."},"initialDelay":{"index":3,"kind":"parameter","displayName":"Initial Delay","group":"producer","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Milliseconds before the first poll for query execution status. See the section Waiting for Query Completion and Retrying Failed Queries to learn more."},"maxAttempts":{"index":4,"kind":"parameter","displayName":"Max Attempts","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Maximum number of times to attempt a query. Set to 1 to disable retries. See the section Waiting for Query Completion and Retrying Failed Queries to learn more."},"maxResults":{"index":5,"kind":"parameter","displayName":"Max Results","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Max number of results to return for the given operation (if supported by the Athena API endpoint). If not set, will use the Athena API default for the given operation."},"nextToken":{"index":6,"kind":"parameter","displayName":"Next Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Pagination token to use in the case where the response from the previous request was truncated."},"operation":{"index":7,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.athena.Athena2Operations","enum":["getQueryExecution","getQueryResults","listQueryExecutions","startQueryExecution"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"startQueryExecution","configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The Athena API function to call."},"outputLocation":{"index":8,"kind":"parameter","displayName":"Output Location","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The location in Amazon S3 where query results are stored, such as s3://path/to/query/bucket/. Ensure this value ends with a forward slash."},"outputType":{"index":9,"kind":"parameter","displayName":"Output Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.athena.Athena2OutputType","enum":["StreamList","SelectList","S3Pointer"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"StreamList","configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"How query results should be returned. One of StreamList (default - return a GetQueryResultsIterable that can page through all results), SelectList (returns at most 1000 rows at a time, plus a NextToken value as a header than can be used for manual pagination of results), S3Pointer (return an S3 path pointing to the results)."},"queryExecutionId":{"index":10,"kind":"parameter","displayName":"Query Execution Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The unique ID identifying the query execution."},"queryString":{"index":11,"kind":"parameter","displayName":"Query String","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The SQL query to run. Except for simple queries, prefer setting this as the body of the Exchange or as a header using Athena2Constants.QUERY_STRING to avoid having to deal with URL encoding issues."},"region":{"index":12,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The region in which Athena client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1)."},"resetWaitTimeoutOnRetry":{"index":13,"kind":"parameter","displayName":"Reset Wait Timeout On Retry","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Reset the waitTimeout countdown in the event of a query retry. If set to true, potential max time spent waiting for queries is equal to waitTimeout x maxAttempts. See the section Waiting for Query Completion and Retrying Failed Queries to learn more."},"retry":{"index":14,"kind":"parameter","displayName":"Retry","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["never","always","retryable","exhausted","generic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"never","configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Optional comma separated list of error types to retry the query for. Use: 'retryable' to retry all retryable failure conditions (e.g. generic errors and resources exhausted), 'generic' to retry 'GENERIC_INTERNAL_ERROR' failures, 'exhausted' to retry queries that have exhausted resource limits, 'always' to always retry regardless of failure condition, or 'never' or null to never retry (default). See the section Waiting for Query Completion and Retrying Failed Queries to learn more."},"waitTimeout":{"index":15,"kind":"parameter","displayName":"Wait Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Optional max wait time in millis to wait for a successful query completion. See the section Waiting for Query Completion and Retrying Failed Queries to learn more."},"workGroup":{"index":16,"kind":"parameter","displayName":"Work Group","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The workgroup to use for running the query."},"lazyStartProducer":{"index":17,"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."},"amazonAthenaClient":{"index":18,"kind":"parameter","displayName":"Amazon Athena Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.athena.AthenaClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The AmazonAthena instance to use as the client."},"clientRequestToken":{"index":19,"kind":"parameter","displayName":"Client Request Token","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"A unique string to ensure issues queries are idempotent. It is unlikely you will need to set this."},"includeTrace":{"index":20,"kind":"parameter","displayName":"Include Trace","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Include useful trace information at the beginning of queries as an SQL comment (prefixed with --)."},"proxyHost":{"index":21,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the Athena client."},"proxyPort":{"index":22,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the Athena client."},"proxyProtocol":{"index":23,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Athena client."},"accessKey":{"index":24,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key."},"encryptionOption":{"index":25,"kind":"parameter","displayName":"Encryption Option","group":"security","label":"security","required":false,"type":"object","javaType":"software.amazon.awssdk.services.athena.model.EncryptionOption","enum":["SSE_S3","SSE_KMS","CSE_KMS","null"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The encryption type to use when storing query results in S3. One of SSE_S3, SSE_KMS, or CSE_KMS."},"kmsKey":{"index":26,"kind":"parameter","displayName":"Kms Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID."},"profileCredentialsName":{"index":27,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":28,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key."},"sessionToken":{"index":29,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"useDefaultCredentialsProvider":{"index":30,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Set whether the Athena client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in"},"useProfileCredentialsProvider":{"index":31,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Set whether the Athena client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":32,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Set whether the Athena client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Athena."}}} , -{"component":{"kind":"component","name":"aws2-cw","title":"AWS CloudWatch","description":"Sending metrics to AWS CloudWatch.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,monitoring","javaType":"org.apache.camel.component.aws2.cw.Cw2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-cw","version":"4.8.1","scheme":"aws2-cw","extendsScheme":"","syntax":"aws2-cw:namespace","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsCwMetricNamespace":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon CW metric namespace.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_NAMESPACE"},"CamelAwsCwMetricName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon CW metric name.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_NAME"},"CamelAwsCwMetricValue":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon CW metric value.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_VALUE"},"CamelAwsCwMetricUnit":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon CW metric unit.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_UNIT"},"CamelAwsCwMetricTimestamp":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon CW metric timestamp.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_TIMESTAMP"},"CamelAwsCwMetricDimensions":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A map of dimension names and dimension values.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_DIMENSIONS"},"CamelAwsCwMetricDimensionName":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon CW metric dimension name.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_DIMENSION_NAME"},"CamelAwsCwMetricDimensionValue":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon CW metric dimension value.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_DIMENSION_VALUE"}},"properties":{"namespace":{"index":0,"kind":"path","displayName":"Namespace","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"The metric namespace"},"name":{"index":1,"kind":"parameter","displayName":"Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"The metric name"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"region":{"index":3,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"The region in which CW client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"timestamp":{"index":4,"kind":"parameter","displayName":"Timestamp","group":"producer","label":"","required":false,"type":"object","javaType":"java.time.Instant","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"The metric timestamp"},"unit":{"index":5,"kind":"parameter","displayName":"Unit","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"The metric unit"},"uriEndpointOverride":{"index":6,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"value":{"index":7,"kind":"parameter","displayName":"Value","group":"producer","label":"","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"The metric value"},"lazyStartProducer":{"index":8,"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."},"amazonCwClient":{"index":9,"kind":"parameter","displayName":"Amazon Cw Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.cloudwatch.CloudWatchClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"To use the AmazonCloudWatch as the client"},"proxyHost":{"index":10,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the CW client"},"proxyPort":{"index":11,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the CW client"},"proxyProtocol":{"index":12,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the CW client"},"accessKey":{"index":13,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":14,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":15,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":16,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":17,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":18,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":19,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Set whether the Cloudwatch client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":20,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Set whether the CloudWatch client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in CloudWatch."}}} +{"component":{"kind":"component","name":"aws2-cw","title":"AWS CloudWatch","description":"Sending metrics to AWS CloudWatch.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,monitoring","javaType":"org.apache.camel.component.aws2.cw.Cw2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-cw","version":"4.8.2","scheme":"aws2-cw","extendsScheme":"","syntax":"aws2-cw:namespace","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsCwMetricNamespace":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon CW metric namespace.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_NAMESPACE"},"CamelAwsCwMetricName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon CW metric name.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_NAME"},"CamelAwsCwMetricValue":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon CW metric value.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_VALUE"},"CamelAwsCwMetricUnit":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon CW metric unit.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_UNIT"},"CamelAwsCwMetricTimestamp":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon CW metric timestamp.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_TIMESTAMP"},"CamelAwsCwMetricDimensions":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A map of dimension names and dimension values.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_DIMENSIONS"},"CamelAwsCwMetricDimensionName":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon CW metric dimension name.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_DIMENSION_NAME"},"CamelAwsCwMetricDimensionValue":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon CW metric dimension value.","constantName":"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_DIMENSION_VALUE"}},"properties":{"namespace":{"index":0,"kind":"path","displayName":"Namespace","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"The metric namespace"},"name":{"index":1,"kind":"parameter","displayName":"Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"The metric name"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"region":{"index":3,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"The region in which CW client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"timestamp":{"index":4,"kind":"parameter","displayName":"Timestamp","group":"producer","label":"","required":false,"type":"object","javaType":"java.time.Instant","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"The metric timestamp"},"unit":{"index":5,"kind":"parameter","displayName":"Unit","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"The metric unit"},"uriEndpointOverride":{"index":6,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"value":{"index":7,"kind":"parameter","displayName":"Value","group":"producer","label":"","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"The metric value"},"lazyStartProducer":{"index":8,"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."},"amazonCwClient":{"index":9,"kind":"parameter","displayName":"Amazon Cw Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.cloudwatch.CloudWatchClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"To use the AmazonCloudWatch as the client"},"proxyHost":{"index":10,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the CW client"},"proxyPort":{"index":11,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the CW client"},"proxyProtocol":{"index":12,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the CW client"},"accessKey":{"index":13,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":14,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":15,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":16,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":17,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":18,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":19,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Set whether the Cloudwatch client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":20,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.cw.Cw2Configuration","configurationField":"configuration","description":"Set whether the CloudWatch client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in CloudWatch."}}} , -{"component":{"kind":"component","name":"aws2-ddb","title":"AWS DynamoDB","description":"Store and retrieve data from AWS DynamoDB.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,database","javaType":"org.apache.camel.component.aws2.ddb.Ddb2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-ddb","version":"4.8.1","scheme":"aws2-ddb","extendsScheme":"","syntax":"aws2-ddb:tableName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsDdbAttributes":{"index":0,"kind":"header","displayName":"","group":"DeleteItem GetItem PutItem UpdateItem","label":"DeleteItem GetItem PutItem UpdateItem","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of attributes returned by the operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ATTRIBUTES"},"CamelAwsDdbAttributeNames":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If attribute names are not specified then all attributes will be returned.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ATTRIBUTE_NAMES"},"CamelAwsDdbBatchItems":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A map of the table name and corresponding items to get by primary key.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#BATCH_ITEMS"},"CamelAwsDdbBatchResponse":{"index":3,"kind":"header","displayName":"","group":"BatchGetItems","label":"BatchGetItems","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Table names and the respective item attributes from the tables.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#BATCH_RESPONSE"},"CamelAwsDdbConsistentRead":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If set to true, then a consistent read is issued, otherwise eventually consistent is used.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#CONSISTENT_READ"},"CamelAwsDdbConsumedCapacity":{"index":5,"kind":"header","displayName":"","group":"Query Scan","label":"Query Scan","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of Capacity Units of the provisioned throughput of the table consumed during the operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#CONSUMED_CAPACITY"},"CamelAwsDdbCount":{"index":6,"kind":"header","displayName":"","group":"Query Scan","label":"Query Scan","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Number of items in the response.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#COUNT"},"CamelAwsDdbCreationDate":{"index":7,"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Creation DateTime of this table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#CREATION_DATE"},"CamelAwsDdbIndexName":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If set will be used as Secondary Index for Query operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#INDEX_NAME"},"CamelAwsDdbItem":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A map of the attributes for the item, and must include the primary key values that define the item.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ITEM"},"CamelAwsDdbItems":{"index":10,"kind":"header","displayName":"","group":"Query Scan","label":"Query Scan","required":false,"javaType":"List>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of attributes returned by the operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ITEMS"},"CamelAwsDdbTableItemCount":{"index":11,"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Item count for this table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ITEM_COUNT"},"CamelAwsDdbKey":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The primary key that uniquely identifies each item in a table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#KEY"},"CamelAwsDdbKeyConditions":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header specify the selection criteria for the query, and merge together the two old headers CamelAwsDdbHashKeyValue and CamelAwsDdbScanRangeKeyCondition","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#KEY_CONDITIONS"},"CamelAwsDdbKeySchema":{"index":14,"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The KeySchema that identifies the primary key for this table. From Camel 2.16.0 the type of this header is List and not KeySchema","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#KEY_SCHEMA"},"CamelAwsDdbLastEvaluatedKey":{"index":15,"kind":"header","displayName":"","group":"Query Scan","label":"Query Scan","required":false,"javaType":"Key","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Primary key of the item where the query operation stopped, inclusive of the previous result set.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#LAST_EVALUATED_KEY"},"CamelAwsDdbLimit":{"index":16,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of items to return.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#LIMIT"},"CamelAwsDdbOperation":{"index":17,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.aws2.ddb.Ddb2Operations","enum":["BatchGetItems","DeleteItem","DeleteTable","DescribeTable","GetItem","PutItem","Query","Scan","UpdateItem","UpdateTable"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#OPERATION"},"CamelAwsDdbProvisionedThroughput":{"index":18,"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"software.amazon.awssdk.services.dynamodb.model.ProvisionedThroughputDescription","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of the ProvisionedThroughput property for this table","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#PROVISIONED_THROUGHPUT"},"CamelAwsDdbReadCapacity":{"index":19,"kind":"header","displayName":"","group":"UpdateTable DescribeTable","label":"UpdateTable DescribeTable","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ReadCapacityUnits property of this table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#READ_CAPACITY"},"CamelAwsDdbReturnValues":{"index":20,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Use this parameter if you want to get the attribute name-value pairs before or after they are modified(NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW).","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#RETURN_VALUES"},"CamelAwsDdbScannedCount":{"index":21,"kind":"header","displayName":"","group":"Scan","label":"Scan","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Number of items in the complete scan before any filters are applied.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#SCANNED_COUNT"},"CamelAwsDdbScanIndexForward":{"index":22,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies forward or backward traversal of the index.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#SCAN_INDEX_FORWARD"},"CamelAwsDdbScanFilter":{"index":23,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Evaluates the scan results and returns only the desired values.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#SCAN_FILTER"},"CamelAwsDdbStartKey":{"index":24,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Primary key of the item from which to continue an earlier query.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#START_KEY"},"CamelAwsDdbTableName":{"index":25,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Table Name for this operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#TABLE_NAME"},"CamelAwsDdbTableSize":{"index":26,"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The table size in bytes.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#TABLE_SIZE"},"CamelAwsDdbTableStatus":{"index":27,"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The status of the table: CREATING, UPDATING, DELETING, ACTIVE","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#TABLE_STATUS"},"CamelAwsDdbUpdateCondition":{"index":28,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Designates an attribute for a conditional modification.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#UPDATE_CONDITION"},"CamelAwsDdbUpdateValues":{"index":29,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Map of attribute name to the new value and action for the update.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#UPDATE_VALUES"},"CamelAwsDdbUnprocessedKeys":{"index":30,"kind":"header","displayName":"","group":"BatchGetItems","label":"BatchGetItems","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Contains a map of tables and their respective keys that were not processed with the current response.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#UNPROCESSED_KEYS"},"CamelAwsDdbWriteCapacity":{"index":31,"kind":"header","displayName":"","group":"UpdateTable DescribeTable","label":"UpdateTable DescribeTable","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"WriteCapacityUnits property of this table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#WRITE_CAPACITY"}},"properties":{"tableName":{"index":0,"kind":"path","displayName":"Table Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The name of the table currently worked with."},"consistentRead":{"index":1,"kind":"parameter","displayName":"Consistent Read","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Determines whether strong consistency should be enforced when data is read."},"enabledInitialDescribeTable":{"index":2,"kind":"parameter","displayName":"Enabled Initial Describe Table","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set whether the initial Describe table operation in the DDB Endpoint must be done, or not."},"keyAttributeName":{"index":3,"kind":"parameter","displayName":"Key Attribute Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Attribute name when creating table"},"keyAttributeType":{"index":4,"kind":"parameter","displayName":"Key Attribute Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Attribute type when creating table"},"keyScalarType":{"index":5,"kind":"parameter","displayName":"Key Scalar Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The key scalar type, it can be S (String), N (Number) and B (Bytes)"},"operation":{"index":6,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.ddb.Ddb2Operations","enum":["BatchGetItems","DeleteItem","DeleteTable","DescribeTable","GetItem","PutItem","Query","Scan","UpdateItem","UpdateTable"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PutItem","configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"What operation to perform"},"overrideEndpoint":{"index":7,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"readCapacity":{"index":8,"kind":"parameter","displayName":"Read Capacity","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The provisioned throughput to reserve for reading resources from your table"},"region":{"index":9,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The region in which DDB client needs to work"},"uriEndpointOverride":{"index":10,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"writeCapacity":{"index":11,"kind":"parameter","displayName":"Write Capacity","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The provisioned throughput to reserved for writing resources to your table"},"lazyStartProducer":{"index":12,"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."},"amazonDDBClient":{"index":13,"kind":"parameter","displayName":"Amazon DDBClient","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.dynamodb.DynamoDbClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"To use the AmazonDynamoDB as the client"},"proxyHost":{"index":14,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the DDB client"},"proxyPort":{"index":15,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The region in which DynamoDB client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"proxyProtocol":{"index":16,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the DDB client"},"accessKey":{"index":17,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":18,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"If using a profile credentials provider this parameter will set the profile name"},"secretKey":{"index":19,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":20,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume a IAM role"},"trustAllCertificates":{"index":21,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":22,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":23,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set whether the DDB client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":24,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set whether the DDB client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in DDB."}}} +{"component":{"kind":"component","name":"aws2-ddb","title":"AWS DynamoDB","description":"Store and retrieve data from AWS DynamoDB.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,database","javaType":"org.apache.camel.component.aws2.ddb.Ddb2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-ddb","version":"4.8.2","scheme":"aws2-ddb","extendsScheme":"","syntax":"aws2-ddb:tableName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsDdbAttributes":{"index":0,"kind":"header","displayName":"","group":"DeleteItem GetItem PutItem UpdateItem","label":"DeleteItem GetItem PutItem UpdateItem","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of attributes returned by the operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ATTRIBUTES"},"CamelAwsDdbAttributeNames":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If attribute names are not specified then all attributes will be returned.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ATTRIBUTE_NAMES"},"CamelAwsDdbBatchItems":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A map of the table name and corresponding items to get by primary key.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#BATCH_ITEMS"},"CamelAwsDdbBatchResponse":{"index":3,"kind":"header","displayName":"","group":"BatchGetItems","label":"BatchGetItems","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Table names and the respective item attributes from the tables.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#BATCH_RESPONSE"},"CamelAwsDdbConsistentRead":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If set to true, then a consistent read is issued, otherwise eventually consistent is used.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#CONSISTENT_READ"},"CamelAwsDdbConsumedCapacity":{"index":5,"kind":"header","displayName":"","group":"Query Scan","label":"Query Scan","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of Capacity Units of the provisioned throughput of the table consumed during the operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#CONSUMED_CAPACITY"},"CamelAwsDdbCount":{"index":6,"kind":"header","displayName":"","group":"Query Scan","label":"Query Scan","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Number of items in the response.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#COUNT"},"CamelAwsDdbCreationDate":{"index":7,"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Creation DateTime of this table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#CREATION_DATE"},"CamelAwsDdbIndexName":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If set will be used as Secondary Index for Query operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#INDEX_NAME"},"CamelAwsDdbItem":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A map of the attributes for the item, and must include the primary key values that define the item.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ITEM"},"CamelAwsDdbItems":{"index":10,"kind":"header","displayName":"","group":"Query Scan","label":"Query Scan","required":false,"javaType":"List>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of attributes returned by the operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ITEMS"},"CamelAwsDdbTableItemCount":{"index":11,"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Item count for this table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ITEM_COUNT"},"CamelAwsDdbKey":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The primary key that uniquely identifies each item in a table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#KEY"},"CamelAwsDdbKeyConditions":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header specify the selection criteria for the query, and merge together the two old headers CamelAwsDdbHashKeyValue and CamelAwsDdbScanRangeKeyCondition","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#KEY_CONDITIONS"},"CamelAwsDdbKeySchema":{"index":14,"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The KeySchema that identifies the primary key for this table. From Camel 2.16.0 the type of this header is List and not KeySchema","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#KEY_SCHEMA"},"CamelAwsDdbLastEvaluatedKey":{"index":15,"kind":"header","displayName":"","group":"Query Scan","label":"Query Scan","required":false,"javaType":"Key","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Primary key of the item where the query operation stopped, inclusive of the previous result set.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#LAST_EVALUATED_KEY"},"CamelAwsDdbLimit":{"index":16,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of items to return.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#LIMIT"},"CamelAwsDdbOperation":{"index":17,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.aws2.ddb.Ddb2Operations","enum":["BatchGetItems","DeleteItem","DeleteTable","DescribeTable","GetItem","PutItem","Query","Scan","UpdateItem","UpdateTable"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#OPERATION"},"CamelAwsDdbProvisionedThroughput":{"index":18,"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"software.amazon.awssdk.services.dynamodb.model.ProvisionedThroughputDescription","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of the ProvisionedThroughput property for this table","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#PROVISIONED_THROUGHPUT"},"CamelAwsDdbReadCapacity":{"index":19,"kind":"header","displayName":"","group":"UpdateTable DescribeTable","label":"UpdateTable DescribeTable","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ReadCapacityUnits property of this table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#READ_CAPACITY"},"CamelAwsDdbReturnValues":{"index":20,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Use this parameter if you want to get the attribute name-value pairs before or after they are modified(NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW).","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#RETURN_VALUES"},"CamelAwsDdbScannedCount":{"index":21,"kind":"header","displayName":"","group":"Scan","label":"Scan","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Number of items in the complete scan before any filters are applied.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#SCANNED_COUNT"},"CamelAwsDdbScanIndexForward":{"index":22,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies forward or backward traversal of the index.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#SCAN_INDEX_FORWARD"},"CamelAwsDdbScanFilter":{"index":23,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Evaluates the scan results and returns only the desired values.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#SCAN_FILTER"},"CamelAwsDdbStartKey":{"index":24,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Primary key of the item from which to continue an earlier query.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#START_KEY"},"CamelAwsDdbTableName":{"index":25,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Table Name for this operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#TABLE_NAME"},"CamelAwsDdbTableSize":{"index":26,"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The table size in bytes.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#TABLE_SIZE"},"CamelAwsDdbTableStatus":{"index":27,"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The status of the table: CREATING, UPDATING, DELETING, ACTIVE","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#TABLE_STATUS"},"CamelAwsDdbUpdateCondition":{"index":28,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Designates an attribute for a conditional modification.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#UPDATE_CONDITION"},"CamelAwsDdbUpdateValues":{"index":29,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Map of attribute name to the new value and action for the update.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#UPDATE_VALUES"},"CamelAwsDdbUnprocessedKeys":{"index":30,"kind":"header","displayName":"","group":"BatchGetItems","label":"BatchGetItems","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Contains a map of tables and their respective keys that were not processed with the current response.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#UNPROCESSED_KEYS"},"CamelAwsDdbWriteCapacity":{"index":31,"kind":"header","displayName":"","group":"UpdateTable DescribeTable","label":"UpdateTable DescribeTable","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"WriteCapacityUnits property of this table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#WRITE_CAPACITY"}},"properties":{"tableName":{"index":0,"kind":"path","displayName":"Table Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The name of the table currently worked with."},"consistentRead":{"index":1,"kind":"parameter","displayName":"Consistent Read","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Determines whether strong consistency should be enforced when data is read."},"enabledInitialDescribeTable":{"index":2,"kind":"parameter","displayName":"Enabled Initial Describe Table","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set whether the initial Describe table operation in the DDB Endpoint must be done, or not."},"keyAttributeName":{"index":3,"kind":"parameter","displayName":"Key Attribute Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Attribute name when creating table"},"keyAttributeType":{"index":4,"kind":"parameter","displayName":"Key Attribute Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Attribute type when creating table"},"keyScalarType":{"index":5,"kind":"parameter","displayName":"Key Scalar Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The key scalar type, it can be S (String), N (Number) and B (Bytes)"},"operation":{"index":6,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.ddb.Ddb2Operations","enum":["BatchGetItems","DeleteItem","DeleteTable","DescribeTable","GetItem","PutItem","Query","Scan","UpdateItem","UpdateTable"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PutItem","configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"What operation to perform"},"overrideEndpoint":{"index":7,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"readCapacity":{"index":8,"kind":"parameter","displayName":"Read Capacity","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The provisioned throughput to reserve for reading resources from your table"},"region":{"index":9,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The region in which DDB client needs to work"},"uriEndpointOverride":{"index":10,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"writeCapacity":{"index":11,"kind":"parameter","displayName":"Write Capacity","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The provisioned throughput to reserved for writing resources to your table"},"lazyStartProducer":{"index":12,"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."},"amazonDDBClient":{"index":13,"kind":"parameter","displayName":"Amazon DDBClient","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.dynamodb.DynamoDbClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"To use the AmazonDynamoDB as the client"},"proxyHost":{"index":14,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the DDB client"},"proxyPort":{"index":15,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The region in which DynamoDB client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"proxyProtocol":{"index":16,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the DDB client"},"accessKey":{"index":17,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":18,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"If using a profile credentials provider this parameter will set the profile name"},"secretKey":{"index":19,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":20,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume a IAM role"},"trustAllCertificates":{"index":21,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":22,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":23,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set whether the DDB client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":24,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set whether the DDB client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in DDB."}}} , -{"component":{"kind":"component","name":"aws2-ddbstream","title":"AWS DynamoDB Streams","description":"Receive messages from AWS DynamoDB Stream.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,messaging","javaType":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-ddb","version":"4.8.1","scheme":"aws2-ddbstream","extendsScheme":"","syntax":"aws2-ddbstream:tableName","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"tableName":{"index":0,"kind":"path","displayName":"Table Name","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Name of the dynamodb table"},"maxResultsPerRequest":{"index":1,"kind":"parameter","displayName":"Max Results Per Request","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Maximum number of records that will be fetched in each poll"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"region":{"index":3,"kind":"parameter","displayName":"Region","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"The region in which DDBStreams client needs to work"},"sendEmptyMessageWhenIdle":{"index":4,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"streamIteratorType":{"index":5,"kind":"parameter","displayName":"Stream Iterator Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration.StreamIteratorType","enum":["FROM_LATEST","FROM_START"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"FROM_LATEST","configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Defines where in the DynamoDB stream to start getting records. Note that using FROM_START can cause a significant delay before the stream has caught up to real-time."},"uriEndpointOverride":{"index":6,"kind":"parameter","displayName":"Uri Endpoint Override","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"amazonDynamoDbStreamsClient":{"index":7,"kind":"parameter","displayName":"Amazon Dynamo Db Streams Client","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.dynamodb.streams.DynamoDbStreamsClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Amazon DynamoDB client to use for all requests for this endpoint"},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"proxyHost":{"index":12,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the DDBStreams client"},"proxyPort":{"index":13,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the DDBStreams client"},"proxyProtocol":{"index":14,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the DDBStreams client"},"backoffErrorThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":17,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":18,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":19,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":20,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":21,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":22,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":23,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":24,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":25,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":26,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":27,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":28,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":29,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":30,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"If using a profile credentials provider this parameter will set the profile name."},"secretKey":{"index":31,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":32,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume a IAM role"},"trustAllCertificates":{"index":33,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":34,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Set whether the DynamoDB Streams client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":35,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Set whether the Cloudtrail client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":36,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Set whether the DDB Streams client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in DDB."}}} +{"component":{"kind":"component","name":"aws2-ddbstream","title":"AWS DynamoDB Streams","description":"Receive messages from AWS DynamoDB Stream.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,messaging","javaType":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-ddb","version":"4.8.2","scheme":"aws2-ddbstream","extendsScheme":"","syntax":"aws2-ddbstream:tableName","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"tableName":{"index":0,"kind":"path","displayName":"Table Name","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Name of the dynamodb table"},"maxResultsPerRequest":{"index":1,"kind":"parameter","displayName":"Max Results Per Request","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Maximum number of records that will be fetched in each poll"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"region":{"index":3,"kind":"parameter","displayName":"Region","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"The region in which DDBStreams client needs to work"},"sendEmptyMessageWhenIdle":{"index":4,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"streamIteratorType":{"index":5,"kind":"parameter","displayName":"Stream Iterator Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration.StreamIteratorType","enum":["FROM_LATEST","FROM_START"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"FROM_LATEST","configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Defines where in the DynamoDB stream to start getting records. Note that using FROM_START can cause a significant delay before the stream has caught up to real-time."},"uriEndpointOverride":{"index":6,"kind":"parameter","displayName":"Uri Endpoint Override","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"amazonDynamoDbStreamsClient":{"index":7,"kind":"parameter","displayName":"Amazon Dynamo Db Streams Client","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.dynamodb.streams.DynamoDbStreamsClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Amazon DynamoDB client to use for all requests for this endpoint"},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"proxyHost":{"index":12,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the DDBStreams client"},"proxyPort":{"index":13,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the DDBStreams client"},"proxyProtocol":{"index":14,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the DDBStreams client"},"backoffErrorThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":17,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":18,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":19,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":20,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":21,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":22,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":23,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":24,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":25,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":26,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":27,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":28,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":29,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":30,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"If using a profile credentials provider this parameter will set the profile name."},"secretKey":{"index":31,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":32,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume a IAM role"},"trustAllCertificates":{"index":33,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":34,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Set whether the DynamoDB Streams client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":35,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Set whether the Cloudtrail client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":36,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration","configurationField":"configuration","description":"Set whether the DDB Streams client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in DDB."}}} , -{"component":{"kind":"component","name":"aws2-ec2","title":"AWS Elastic Compute Cloud (EC2)","description":"Manage AWS EC2 instances.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.ec2.AWS2EC2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-ec2","version":"4.8.1","scheme":"aws2-ec2","extendsScheme":"","syntax":"aws2-ec2:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsEC2ImageId":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"An image ID of the AWS marketplace","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#IMAGE_ID"},"CamelAwsEC2InstanceType":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.ec2.model.InstanceType","enum":["a1.medium","a1.large","a1.xlarge","a1.2xlarge","a1.4xlarge","a1.metal","c1.medium","c1.xlarge","c3.large","c3.xlarge","c3.2xlarge","c3.4xlarge","c3.8xlarge","c4.large","c4.xlarge","c4.2xlarge","c4.4xlarge","c4.8xlarge","c5.large","c5.xlarge","c5.2xlarge","c5.4xlarge","c5.9xlarge","c5.12xlarge","c5.18xlarge","c5.24xlarge","c5.metal","c5a.large","c5a.xlarge","c5a.2xlarge","c5a.4xlarge","c5a.8xlarge","c5a.12xlarge","c5a.16xlarge","c5a.24xlarge","c5ad.large","c5ad.xlarge","c5ad.2xlarge","c5ad.4xlarge","c5ad.8xlarge","c5ad.12xlarge","c5ad.16xlarge","c5ad.24xlarge","c5d.large","c5d.xlarge","c5d.2xlarge","c5d.4xlarge","c5d.9xlarge","c5d.12xlarge","c5d.18xlarge","c5d.24xlarge","c5d.metal","c5n.large","c5n.xlarge","c5n.2xlarge","c5n.4xlarge","c5n.9xlarge","c5n.18xlarge","c5n.metal","c6g.medium","c6g.large","c6g.xlarge","c6g.2xlarge","c6g.4xlarge","c6g.8xlarge","c6g.12xlarge","c6g.16xlarge","c6g.metal","c6gd.medium","c6gd.large","c6gd.xlarge","c6gd.2xlarge","c6gd.4xlarge","c6gd.8xlarge","c6gd.12xlarge","c6gd.16xlarge","c6gd.metal","c6gn.medium","c6gn.large","c6gn.xlarge","c6gn.2xlarge","c6gn.4xlarge","c6gn.8xlarge","c6gn.12xlarge","c6gn.16xlarge","c6i.large","c6i.xlarge","c6i.2xlarge","c6i.4xlarge","c6i.8xlarge","c6i.12xlarge","c6i.16xlarge","c6i.24xlarge","c6i.32xlarge","c6i.metal","cc1.4xlarge","cc2.8xlarge","cg1.4xlarge","cr1.8xlarge","d2.xlarge","d2.2xlarge","d2.4xlarge","d2.8xlarge","d3.xlarge","d3.2xlarge","d3.4xlarge","d3.8xlarge","d3en.xlarge","d3en.2xlarge","d3en.4xlarge","d3en.6xlarge","d3en.8xlarge","d3en.12xlarge","dl1.24xlarge","f1.2xlarge","f1.4xlarge","f1.16xlarge","g2.2xlarge","g2.8xlarge","g3.4xlarge","g3.8xlarge","g3.16xlarge","g3s.xlarge","g4ad.xlarge","g4ad.2xlarge","g4ad.4xlarge","g4ad.8xlarge","g4ad.16xlarge","g4dn.xlarge","g4dn.2xlarge","g4dn.4xlarge","g4dn.8xlarge","g4dn.12xlarge","g4dn.16xlarge","g4dn.metal","g5.xlarge","g5.2xlarge","g5.4xlarge","g5.8xlarge","g5.12xlarge","g5.16xlarge","g5.24xlarge","g5.48xlarge","g5g.xlarge","g5g.2xlarge","g5g.4xlarge","g5g.8xlarge","g5g.16xlarge","g5g.metal","hi1.4xlarge","hpc6a.48xlarge","hs1.8xlarge","h1.2xlarge","h1.4xlarge","h1.8xlarge","h1.16xlarge","i2.xlarge","i2.2xlarge","i2.4xlarge","i2.8xlarge","i3.large","i3.xlarge","i3.2xlarge","i3.4xlarge","i3.8xlarge","i3.16xlarge","i3.metal","i3en.large","i3en.xlarge","i3en.2xlarge","i3en.3xlarge","i3en.6xlarge","i3en.12xlarge","i3en.24xlarge","i3en.metal","im4gn.large","im4gn.xlarge","im4gn.2xlarge","im4gn.4xlarge","im4gn.8xlarge","im4gn.16xlarge","inf1.xlarge","inf1.2xlarge","inf1.6xlarge","inf1.24xlarge","is4gen.medium","is4gen.large","is4gen.xlarge","is4gen.2xlarge","is4gen.4xlarge","is4gen.8xlarge","m1.small","m1.medium","m1.large","m1.xlarge","m2.xlarge","m2.2xlarge","m2.4xlarge","m3.medium","m3.large","m3.xlarge","m3.2xlarge","m4.large","m4.xlarge","m4.2xlarge","m4.4xlarge","m4.10xlarge","m4.16xlarge","m5.large","m5.xlarge","m5.2xlarge","m5.4xlarge","m5.8xlarge","m5.12xlarge","m5.16xlarge","m5.24xlarge","m5.metal","m5a.large","m5a.xlarge","m5a.2xlarge","m5a.4xlarge","m5a.8xlarge","m5a.12xlarge","m5a.16xlarge","m5a.24xlarge","m5ad.large","m5ad.xlarge","m5ad.2xlarge","m5ad.4xlarge","m5ad.8xlarge","m5ad.12xlarge","m5ad.16xlarge","m5ad.24xlarge","m5d.large","m5d.xlarge","m5d.2xlarge","m5d.4xlarge","m5d.8xlarge","m5d.12xlarge","m5d.16xlarge","m5d.24xlarge","m5d.metal","m5dn.large","m5dn.xlarge","m5dn.2xlarge","m5dn.4xlarge","m5dn.8xlarge","m5dn.12xlarge","m5dn.16xlarge","m5dn.24xlarge","m5dn.metal","m5n.large","m5n.xlarge","m5n.2xlarge","m5n.4xlarge","m5n.8xlarge","m5n.12xlarge","m5n.16xlarge","m5n.24xlarge","m5n.metal","m5zn.large","m5zn.xlarge","m5zn.2xlarge","m5zn.3xlarge","m5zn.6xlarge","m5zn.12xlarge","m5zn.metal","m6a.large","m6a.xlarge","m6a.2xlarge","m6a.4xlarge","m6a.8xlarge","m6a.12xlarge","m6a.16xlarge","m6a.24xlarge","m6a.32xlarge","m6a.48xlarge","m6g.metal","m6g.medium","m6g.large","m6g.xlarge","m6g.2xlarge","m6g.4xlarge","m6g.8xlarge","m6g.12xlarge","m6g.16xlarge","m6gd.metal","m6gd.medium","m6gd.large","m6gd.xlarge","m6gd.2xlarge","m6gd.4xlarge","m6gd.8xlarge","m6gd.12xlarge","m6gd.16xlarge","m6i.large","m6i.xlarge","m6i.2xlarge","m6i.4xlarge","m6i.8xlarge","m6i.12xlarge","m6i.16xlarge","m6i.24xlarge","m6i.32xlarge","m6i.metal","mac1.metal","p2.xlarge","p2.8xlarge","p2.16xlarge","p3.2xlarge","p3.8xlarge","p3.16xlarge","p3dn.24xlarge","p4d.24xlarge","r3.large","r3.xlarge","r3.2xlarge","r3.4xlarge","r3.8xlarge","r4.large","r4.xlarge","r4.2xlarge","r4.4xlarge","r4.8xlarge","r4.16xlarge","r5.large","r5.xlarge","r5.2xlarge","r5.4xlarge","r5.8xlarge","r5.12xlarge","r5.16xlarge","r5.24xlarge","r5.metal","r5a.large","r5a.xlarge","r5a.2xlarge","r5a.4xlarge","r5a.8xlarge","r5a.12xlarge","r5a.16xlarge","r5a.24xlarge","r5ad.large","r5ad.xlarge","r5ad.2xlarge","r5ad.4xlarge","r5ad.8xlarge","r5ad.12xlarge","r5ad.16xlarge","r5ad.24xlarge","r5b.large","r5b.xlarge","r5b.2xlarge","r5b.4xlarge","r5b.8xlarge","r5b.12xlarge","r5b.16xlarge","r5b.24xlarge","r5b.metal","r5d.large","r5d.xlarge","r5d.2xlarge","r5d.4xlarge","r5d.8xlarge","r5d.12xlarge","r5d.16xlarge","r5d.24xlarge","r5d.metal","r5dn.large","r5dn.xlarge","r5dn.2xlarge","r5dn.4xlarge","r5dn.8xlarge","r5dn.12xlarge","r5dn.16xlarge","r5dn.24xlarge","r5dn.metal","r5n.large","r5n.xlarge","r5n.2xlarge","r5n.4xlarge","r5n.8xlarge","r5n.12xlarge","r5n.16xlarge","r5n.24xlarge","r5n.metal","r6g.medium","r6g.large","r6g.xlarge","r6g.2xlarge","r6g.4xlarge","r6g.8xlarge","r6g.12xlarge","r6g.16xlarge","r6g.metal","r6gd.medium","r6gd.large","r6gd.xlarge","r6gd.2xlarge","r6gd.4xlarge","r6gd.8xlarge","r6gd.12xlarge","r6gd.16xlarge","r6gd.metal","r6i.large","r6i.xlarge","r6i.2xlarge","r6i.4xlarge","r6i.8xlarge","r6i.12xlarge","r6i.16xlarge","r6i.24xlarge","r6i.32xlarge","r6i.metal","t1.micro","t2.nano","t2.micro","t2.small","t2.medium","t2.large","t2.xlarge","t2.2xlarge","t3.nano","t3.micro","t3.small","t3.medium","t3.large","t3.xlarge","t3.2xlarge","t3a.nano","t3a.micro","t3a.small","t3a.medium","t3a.large","t3a.xlarge","t3a.2xlarge","t4g.nano","t4g.micro","t4g.small","t4g.medium","t4g.large","t4g.xlarge","t4g.2xlarge","u-6tb1.56xlarge","u-6tb1.112xlarge","u-9tb1.112xlarge","u-12tb1.112xlarge","u-6tb1.metal","u-9tb1.metal","u-12tb1.metal","u-18tb1.metal","u-24tb1.metal","vt1.3xlarge","vt1.6xlarge","vt1.24xlarge","x1.16xlarge","x1.32xlarge","x1e.xlarge","x1e.2xlarge","x1e.4xlarge","x1e.8xlarge","x1e.16xlarge","x1e.32xlarge","x2iezn.2xlarge","x2iezn.4xlarge","x2iezn.6xlarge","x2iezn.8xlarge","x2iezn.12xlarge","x2iezn.metal","x2gd.medium","x2gd.large","x2gd.xlarge","x2gd.2xlarge","x2gd.4xlarge","x2gd.8xlarge","x2gd.12xlarge","x2gd.16xlarge","x2gd.metal","z1d.large","z1d.xlarge","z1d.2xlarge","z1d.3xlarge","z1d.6xlarge","z1d.12xlarge","z1d.metal","x2idn.16xlarge","x2idn.24xlarge","x2idn.32xlarge","x2iedn.xlarge","x2iedn.2xlarge","x2iedn.4xlarge","x2iedn.8xlarge","x2iedn.16xlarge","x2iedn.24xlarge","x2iedn.32xlarge","c6a.large","c6a.xlarge","c6a.2xlarge","c6a.4xlarge","c6a.8xlarge","c6a.12xlarge","c6a.16xlarge","c6a.24xlarge","c6a.32xlarge","c6a.48xlarge","c6a.metal","m6a.metal","i4i.large","i4i.xlarge","i4i.2xlarge","i4i.4xlarge","i4i.8xlarge","i4i.16xlarge","i4i.32xlarge","i4i.metal","x2idn.metal","x2iedn.metal","c7g.medium","c7g.large","c7g.xlarge","c7g.2xlarge","c7g.4xlarge","c7g.8xlarge","c7g.12xlarge","c7g.16xlarge","mac2.metal","c6id.large","c6id.xlarge","c6id.2xlarge","c6id.4xlarge","c6id.8xlarge","c6id.12xlarge","c6id.16xlarge","c6id.24xlarge","c6id.32xlarge","c6id.metal","m6id.large","m6id.xlarge","m6id.2xlarge","m6id.4xlarge","m6id.8xlarge","m6id.12xlarge","m6id.16xlarge","m6id.24xlarge","m6id.32xlarge","m6id.metal","r6id.large","r6id.xlarge","r6id.2xlarge","r6id.4xlarge","r6id.8xlarge","r6id.12xlarge","r6id.16xlarge","r6id.24xlarge","r6id.32xlarge","r6id.metal","r6a.large","r6a.xlarge","r6a.2xlarge","r6a.4xlarge","r6a.8xlarge","r6a.12xlarge","r6a.16xlarge","r6a.24xlarge","r6a.32xlarge","r6a.48xlarge","r6a.metal","p4de.24xlarge","u-3tb1.56xlarge","u-18tb1.112xlarge","u-24tb1.112xlarge","trn1.2xlarge","trn1.32xlarge","hpc6id.32xlarge","c6in.large","c6in.xlarge","c6in.2xlarge","c6in.4xlarge","c6in.8xlarge","c6in.12xlarge","c6in.16xlarge","c6in.24xlarge","c6in.32xlarge","m6in.large","m6in.xlarge","m6in.2xlarge","m6in.4xlarge","m6in.8xlarge","m6in.12xlarge","m6in.16xlarge","m6in.24xlarge","m6in.32xlarge","m6idn.large","m6idn.xlarge","m6idn.2xlarge","m6idn.4xlarge","m6idn.8xlarge","m6idn.12xlarge","m6idn.16xlarge","m6idn.24xlarge","m6idn.32xlarge","r6in.large","r6in.xlarge","r6in.2xlarge","r6in.4xlarge","r6in.8xlarge","r6in.12xlarge","r6in.16xlarge","r6in.24xlarge","r6in.32xlarge","r6idn.large","r6idn.xlarge","r6idn.2xlarge","r6idn.4xlarge","r6idn.8xlarge","r6idn.12xlarge","r6idn.16xlarge","r6idn.24xlarge","r6idn.32xlarge","c7g.metal","m7g.medium","m7g.large","m7g.xlarge","m7g.2xlarge","m7g.4xlarge","m7g.8xlarge","m7g.12xlarge","m7g.16xlarge","m7g.metal","r7g.medium","r7g.large","r7g.xlarge","r7g.2xlarge","r7g.4xlarge","r7g.8xlarge","r7g.12xlarge","r7g.16xlarge","r7g.metal","c6in.metal","m6in.metal","m6idn.metal","r6in.metal","r6idn.metal","inf2.xlarge","inf2.8xlarge","inf2.24xlarge","inf2.48xlarge","trn1n.32xlarge","i4g.large","i4g.xlarge","i4g.2xlarge","i4g.4xlarge","i4g.8xlarge","i4g.16xlarge","hpc7g.4xlarge","hpc7g.8xlarge","hpc7g.16xlarge","c7gn.medium","c7gn.large","c7gn.xlarge","c7gn.2xlarge","c7gn.4xlarge","c7gn.8xlarge","c7gn.12xlarge","c7gn.16xlarge","p5.48xlarge","m7i.large","m7i.xlarge","m7i.2xlarge","m7i.4xlarge","m7i.8xlarge","m7i.12xlarge","m7i.16xlarge","m7i.24xlarge","m7i.48xlarge","m7i-flex.large","m7i-flex.xlarge","m7i-flex.2xlarge","m7i-flex.4xlarge","m7i-flex.8xlarge","m7a.medium","m7a.large","m7a.xlarge","m7a.2xlarge","m7a.4xlarge","m7a.8xlarge","m7a.12xlarge","m7a.16xlarge","m7a.24xlarge","m7a.32xlarge","m7a.48xlarge","m7a.metal-48xl","hpc7a.12xlarge","hpc7a.24xlarge","hpc7a.48xlarge","hpc7a.96xlarge","c7gd.medium","c7gd.large","c7gd.xlarge","c7gd.2xlarge","c7gd.4xlarge","c7gd.8xlarge","c7gd.12xlarge","c7gd.16xlarge","m7gd.medium","m7gd.large","m7gd.xlarge","m7gd.2xlarge","m7gd.4xlarge","m7gd.8xlarge","m7gd.12xlarge","m7gd.16xlarge","r7gd.medium","r7gd.large","r7gd.xlarge","r7gd.2xlarge","r7gd.4xlarge","r7gd.8xlarge","r7gd.12xlarge","r7gd.16xlarge","r7a.medium","r7a.large","r7a.xlarge","r7a.2xlarge","r7a.4xlarge","r7a.8xlarge","r7a.12xlarge","r7a.16xlarge","r7a.24xlarge","r7a.32xlarge","r7a.48xlarge","c7i.large","c7i.xlarge","c7i.2xlarge","c7i.4xlarge","c7i.8xlarge","c7i.12xlarge","c7i.16xlarge","c7i.24xlarge","c7i.48xlarge","mac2-m2pro.metal","r7iz.large","r7iz.xlarge","r7iz.2xlarge","r7iz.4xlarge","r7iz.8xlarge","r7iz.12xlarge","r7iz.16xlarge","r7iz.32xlarge","c7a.medium","c7a.large","c7a.xlarge","c7a.2xlarge","c7a.4xlarge","c7a.8xlarge","c7a.12xlarge","c7a.16xlarge","c7a.24xlarge","c7a.32xlarge","c7a.48xlarge","c7a.metal-48xl","r7a.metal-48xl","r7i.large","r7i.xlarge","r7i.2xlarge","r7i.4xlarge","r7i.8xlarge","r7i.12xlarge","r7i.16xlarge","r7i.24xlarge","r7i.48xlarge","dl2q.24xlarge","mac2-m2.metal","i4i.12xlarge","i4i.24xlarge","c7i.metal-24xl","c7i.metal-48xl","m7i.metal-24xl","m7i.metal-48xl","r7i.metal-24xl","r7i.metal-48xl","r7iz.metal-16xl","r7iz.metal-32xl","c7gd.metal","m7gd.metal","r7gd.metal","g6.xlarge","g6.2xlarge","g6.4xlarge","g6.8xlarge","g6.12xlarge","g6.16xlarge","g6.24xlarge","g6.48xlarge","gr6.4xlarge","gr6.8xlarge","c7i-flex.large","c7i-flex.xlarge","c7i-flex.2xlarge","c7i-flex.4xlarge","c7i-flex.8xlarge","u7i-12tb.224xlarge","u7in-16tb.224xlarge","u7in-24tb.224xlarge","u7in-32tb.224xlarge","u7ib-12tb.224xlarge","c7gn.metal","r8g.medium","r8g.large","r8g.xlarge","r8g.2xlarge","r8g.4xlarge","r8g.8xlarge","r8g.12xlarge","r8g.16xlarge","r8g.24xlarge","r8g.48xlarge","r8g.metal-24xl","r8g.metal-48xl","mac2-m1ultra.metal","null"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The instance type we want to create and run","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCE_TYPE"},"CamelAwsEC2Operation":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#OPERATION"},"CamelAwsEC2InstanceMinCount":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The minimum number of instances we want to run.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCE_MIN_COUNT"},"CamelAwsEC2InstanceMaxCount":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of instances we want to run.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCE_MAX_COUNT"},"CamelAwsEC2InstanceMonitoring":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Define if we want the running instances to be monitored","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCE_MONITORING"},"CamelAwsEC2InstanceKernelId":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of the kernel.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCE_KERNEL_ID"},"CamelAwsEC2InstanceEbsOptimized":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Define if the creating instance is optimized for EBS I/O.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCE_EBS_OPTIMIZED"},"CamelAwsEC2InstanceSecurityGroups":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The security groups to associate to the instances","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCE_SECURITY_GROUPS"},"CamelAwsEC2InstancesIds":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A collection of instances IDS to execute start, stop, describe and terminate operations on.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCES_IDS"},"CamelAwsEC2InstancesKeyPair":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the key pair.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCES_KEY_PAIR"},"CamelAwsEC2InstancesClientToken":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCES_CLIENT_TOKEN"},"CamelAwsEC2InstancesPlacement":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.ec2.model.Placement","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The placement for the instance.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCES_PLACEMENT"},"CamelAwsEC2InstancesTags":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A collection of tags to add or remove from EC2 resources","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCES_TAGS"},"CamelAwsEC2SubnetId":{"index":14,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of the subnet to launch the instance into.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#SUBNET_ID"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Logical name"},"amazonEc2Client":{"index":1,"kind":"parameter","displayName":"Amazon Ec2 Client","group":"producer","label":"producer","required":false,"type":"object","javaType":"software.amazon.awssdk.services.ec2.Ec2Client","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"To use an existing configured AmazonEC2Client client"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.ec2.AWS2EC2Operations","enum":["createAndRunInstances","startInstances","stopInstances","terminateInstances","describeInstances","describeInstancesStatus","rebootInstances","monitorInstances","unmonitorInstances","createTags","deleteTags"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"The operation to perform. It can be createAndRunInstances, startInstances, stopInstances, terminateInstances, describeInstances, describeInstancesStatus, rebootInstances, monitorInstances, unmonitorInstances, createTags or deleteTags"},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"The region in which EC2 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":6,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":7,"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."},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the EC2 client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"producer,proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the EC2 client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"producer,proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the EC2 client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Set whether the EC2 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Set whether the EC2 client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Set whether the EC2 client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in EC2."}}} +{"component":{"kind":"component","name":"aws2-ec2","title":"AWS Elastic Compute Cloud (EC2)","description":"Manage AWS EC2 instances.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.ec2.AWS2EC2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-ec2","version":"4.8.2","scheme":"aws2-ec2","extendsScheme":"","syntax":"aws2-ec2:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsEC2ImageId":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"An image ID of the AWS marketplace","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#IMAGE_ID"},"CamelAwsEC2InstanceType":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.ec2.model.InstanceType","enum":["a1.medium","a1.large","a1.xlarge","a1.2xlarge","a1.4xlarge","a1.metal","c1.medium","c1.xlarge","c3.large","c3.xlarge","c3.2xlarge","c3.4xlarge","c3.8xlarge","c4.large","c4.xlarge","c4.2xlarge","c4.4xlarge","c4.8xlarge","c5.large","c5.xlarge","c5.2xlarge","c5.4xlarge","c5.9xlarge","c5.12xlarge","c5.18xlarge","c5.24xlarge","c5.metal","c5a.large","c5a.xlarge","c5a.2xlarge","c5a.4xlarge","c5a.8xlarge","c5a.12xlarge","c5a.16xlarge","c5a.24xlarge","c5ad.large","c5ad.xlarge","c5ad.2xlarge","c5ad.4xlarge","c5ad.8xlarge","c5ad.12xlarge","c5ad.16xlarge","c5ad.24xlarge","c5d.large","c5d.xlarge","c5d.2xlarge","c5d.4xlarge","c5d.9xlarge","c5d.12xlarge","c5d.18xlarge","c5d.24xlarge","c5d.metal","c5n.large","c5n.xlarge","c5n.2xlarge","c5n.4xlarge","c5n.9xlarge","c5n.18xlarge","c5n.metal","c6g.medium","c6g.large","c6g.xlarge","c6g.2xlarge","c6g.4xlarge","c6g.8xlarge","c6g.12xlarge","c6g.16xlarge","c6g.metal","c6gd.medium","c6gd.large","c6gd.xlarge","c6gd.2xlarge","c6gd.4xlarge","c6gd.8xlarge","c6gd.12xlarge","c6gd.16xlarge","c6gd.metal","c6gn.medium","c6gn.large","c6gn.xlarge","c6gn.2xlarge","c6gn.4xlarge","c6gn.8xlarge","c6gn.12xlarge","c6gn.16xlarge","c6i.large","c6i.xlarge","c6i.2xlarge","c6i.4xlarge","c6i.8xlarge","c6i.12xlarge","c6i.16xlarge","c6i.24xlarge","c6i.32xlarge","c6i.metal","cc1.4xlarge","cc2.8xlarge","cg1.4xlarge","cr1.8xlarge","d2.xlarge","d2.2xlarge","d2.4xlarge","d2.8xlarge","d3.xlarge","d3.2xlarge","d3.4xlarge","d3.8xlarge","d3en.xlarge","d3en.2xlarge","d3en.4xlarge","d3en.6xlarge","d3en.8xlarge","d3en.12xlarge","dl1.24xlarge","f1.2xlarge","f1.4xlarge","f1.16xlarge","g2.2xlarge","g2.8xlarge","g3.4xlarge","g3.8xlarge","g3.16xlarge","g3s.xlarge","g4ad.xlarge","g4ad.2xlarge","g4ad.4xlarge","g4ad.8xlarge","g4ad.16xlarge","g4dn.xlarge","g4dn.2xlarge","g4dn.4xlarge","g4dn.8xlarge","g4dn.12xlarge","g4dn.16xlarge","g4dn.metal","g5.xlarge","g5.2xlarge","g5.4xlarge","g5.8xlarge","g5.12xlarge","g5.16xlarge","g5.24xlarge","g5.48xlarge","g5g.xlarge","g5g.2xlarge","g5g.4xlarge","g5g.8xlarge","g5g.16xlarge","g5g.metal","hi1.4xlarge","hpc6a.48xlarge","hs1.8xlarge","h1.2xlarge","h1.4xlarge","h1.8xlarge","h1.16xlarge","i2.xlarge","i2.2xlarge","i2.4xlarge","i2.8xlarge","i3.large","i3.xlarge","i3.2xlarge","i3.4xlarge","i3.8xlarge","i3.16xlarge","i3.metal","i3en.large","i3en.xlarge","i3en.2xlarge","i3en.3xlarge","i3en.6xlarge","i3en.12xlarge","i3en.24xlarge","i3en.metal","im4gn.large","im4gn.xlarge","im4gn.2xlarge","im4gn.4xlarge","im4gn.8xlarge","im4gn.16xlarge","inf1.xlarge","inf1.2xlarge","inf1.6xlarge","inf1.24xlarge","is4gen.medium","is4gen.large","is4gen.xlarge","is4gen.2xlarge","is4gen.4xlarge","is4gen.8xlarge","m1.small","m1.medium","m1.large","m1.xlarge","m2.xlarge","m2.2xlarge","m2.4xlarge","m3.medium","m3.large","m3.xlarge","m3.2xlarge","m4.large","m4.xlarge","m4.2xlarge","m4.4xlarge","m4.10xlarge","m4.16xlarge","m5.large","m5.xlarge","m5.2xlarge","m5.4xlarge","m5.8xlarge","m5.12xlarge","m5.16xlarge","m5.24xlarge","m5.metal","m5a.large","m5a.xlarge","m5a.2xlarge","m5a.4xlarge","m5a.8xlarge","m5a.12xlarge","m5a.16xlarge","m5a.24xlarge","m5ad.large","m5ad.xlarge","m5ad.2xlarge","m5ad.4xlarge","m5ad.8xlarge","m5ad.12xlarge","m5ad.16xlarge","m5ad.24xlarge","m5d.large","m5d.xlarge","m5d.2xlarge","m5d.4xlarge","m5d.8xlarge","m5d.12xlarge","m5d.16xlarge","m5d.24xlarge","m5d.metal","m5dn.large","m5dn.xlarge","m5dn.2xlarge","m5dn.4xlarge","m5dn.8xlarge","m5dn.12xlarge","m5dn.16xlarge","m5dn.24xlarge","m5dn.metal","m5n.large","m5n.xlarge","m5n.2xlarge","m5n.4xlarge","m5n.8xlarge","m5n.12xlarge","m5n.16xlarge","m5n.24xlarge","m5n.metal","m5zn.large","m5zn.xlarge","m5zn.2xlarge","m5zn.3xlarge","m5zn.6xlarge","m5zn.12xlarge","m5zn.metal","m6a.large","m6a.xlarge","m6a.2xlarge","m6a.4xlarge","m6a.8xlarge","m6a.12xlarge","m6a.16xlarge","m6a.24xlarge","m6a.32xlarge","m6a.48xlarge","m6g.metal","m6g.medium","m6g.large","m6g.xlarge","m6g.2xlarge","m6g.4xlarge","m6g.8xlarge","m6g.12xlarge","m6g.16xlarge","m6gd.metal","m6gd.medium","m6gd.large","m6gd.xlarge","m6gd.2xlarge","m6gd.4xlarge","m6gd.8xlarge","m6gd.12xlarge","m6gd.16xlarge","m6i.large","m6i.xlarge","m6i.2xlarge","m6i.4xlarge","m6i.8xlarge","m6i.12xlarge","m6i.16xlarge","m6i.24xlarge","m6i.32xlarge","m6i.metal","mac1.metal","p2.xlarge","p2.8xlarge","p2.16xlarge","p3.2xlarge","p3.8xlarge","p3.16xlarge","p3dn.24xlarge","p4d.24xlarge","r3.large","r3.xlarge","r3.2xlarge","r3.4xlarge","r3.8xlarge","r4.large","r4.xlarge","r4.2xlarge","r4.4xlarge","r4.8xlarge","r4.16xlarge","r5.large","r5.xlarge","r5.2xlarge","r5.4xlarge","r5.8xlarge","r5.12xlarge","r5.16xlarge","r5.24xlarge","r5.metal","r5a.large","r5a.xlarge","r5a.2xlarge","r5a.4xlarge","r5a.8xlarge","r5a.12xlarge","r5a.16xlarge","r5a.24xlarge","r5ad.large","r5ad.xlarge","r5ad.2xlarge","r5ad.4xlarge","r5ad.8xlarge","r5ad.12xlarge","r5ad.16xlarge","r5ad.24xlarge","r5b.large","r5b.xlarge","r5b.2xlarge","r5b.4xlarge","r5b.8xlarge","r5b.12xlarge","r5b.16xlarge","r5b.24xlarge","r5b.metal","r5d.large","r5d.xlarge","r5d.2xlarge","r5d.4xlarge","r5d.8xlarge","r5d.12xlarge","r5d.16xlarge","r5d.24xlarge","r5d.metal","r5dn.large","r5dn.xlarge","r5dn.2xlarge","r5dn.4xlarge","r5dn.8xlarge","r5dn.12xlarge","r5dn.16xlarge","r5dn.24xlarge","r5dn.metal","r5n.large","r5n.xlarge","r5n.2xlarge","r5n.4xlarge","r5n.8xlarge","r5n.12xlarge","r5n.16xlarge","r5n.24xlarge","r5n.metal","r6g.medium","r6g.large","r6g.xlarge","r6g.2xlarge","r6g.4xlarge","r6g.8xlarge","r6g.12xlarge","r6g.16xlarge","r6g.metal","r6gd.medium","r6gd.large","r6gd.xlarge","r6gd.2xlarge","r6gd.4xlarge","r6gd.8xlarge","r6gd.12xlarge","r6gd.16xlarge","r6gd.metal","r6i.large","r6i.xlarge","r6i.2xlarge","r6i.4xlarge","r6i.8xlarge","r6i.12xlarge","r6i.16xlarge","r6i.24xlarge","r6i.32xlarge","r6i.metal","t1.micro","t2.nano","t2.micro","t2.small","t2.medium","t2.large","t2.xlarge","t2.2xlarge","t3.nano","t3.micro","t3.small","t3.medium","t3.large","t3.xlarge","t3.2xlarge","t3a.nano","t3a.micro","t3a.small","t3a.medium","t3a.large","t3a.xlarge","t3a.2xlarge","t4g.nano","t4g.micro","t4g.small","t4g.medium","t4g.large","t4g.xlarge","t4g.2xlarge","u-6tb1.56xlarge","u-6tb1.112xlarge","u-9tb1.112xlarge","u-12tb1.112xlarge","u-6tb1.metal","u-9tb1.metal","u-12tb1.metal","u-18tb1.metal","u-24tb1.metal","vt1.3xlarge","vt1.6xlarge","vt1.24xlarge","x1.16xlarge","x1.32xlarge","x1e.xlarge","x1e.2xlarge","x1e.4xlarge","x1e.8xlarge","x1e.16xlarge","x1e.32xlarge","x2iezn.2xlarge","x2iezn.4xlarge","x2iezn.6xlarge","x2iezn.8xlarge","x2iezn.12xlarge","x2iezn.metal","x2gd.medium","x2gd.large","x2gd.xlarge","x2gd.2xlarge","x2gd.4xlarge","x2gd.8xlarge","x2gd.12xlarge","x2gd.16xlarge","x2gd.metal","z1d.large","z1d.xlarge","z1d.2xlarge","z1d.3xlarge","z1d.6xlarge","z1d.12xlarge","z1d.metal","x2idn.16xlarge","x2idn.24xlarge","x2idn.32xlarge","x2iedn.xlarge","x2iedn.2xlarge","x2iedn.4xlarge","x2iedn.8xlarge","x2iedn.16xlarge","x2iedn.24xlarge","x2iedn.32xlarge","c6a.large","c6a.xlarge","c6a.2xlarge","c6a.4xlarge","c6a.8xlarge","c6a.12xlarge","c6a.16xlarge","c6a.24xlarge","c6a.32xlarge","c6a.48xlarge","c6a.metal","m6a.metal","i4i.large","i4i.xlarge","i4i.2xlarge","i4i.4xlarge","i4i.8xlarge","i4i.16xlarge","i4i.32xlarge","i4i.metal","x2idn.metal","x2iedn.metal","c7g.medium","c7g.large","c7g.xlarge","c7g.2xlarge","c7g.4xlarge","c7g.8xlarge","c7g.12xlarge","c7g.16xlarge","mac2.metal","c6id.large","c6id.xlarge","c6id.2xlarge","c6id.4xlarge","c6id.8xlarge","c6id.12xlarge","c6id.16xlarge","c6id.24xlarge","c6id.32xlarge","c6id.metal","m6id.large","m6id.xlarge","m6id.2xlarge","m6id.4xlarge","m6id.8xlarge","m6id.12xlarge","m6id.16xlarge","m6id.24xlarge","m6id.32xlarge","m6id.metal","r6id.large","r6id.xlarge","r6id.2xlarge","r6id.4xlarge","r6id.8xlarge","r6id.12xlarge","r6id.16xlarge","r6id.24xlarge","r6id.32xlarge","r6id.metal","r6a.large","r6a.xlarge","r6a.2xlarge","r6a.4xlarge","r6a.8xlarge","r6a.12xlarge","r6a.16xlarge","r6a.24xlarge","r6a.32xlarge","r6a.48xlarge","r6a.metal","p4de.24xlarge","u-3tb1.56xlarge","u-18tb1.112xlarge","u-24tb1.112xlarge","trn1.2xlarge","trn1.32xlarge","hpc6id.32xlarge","c6in.large","c6in.xlarge","c6in.2xlarge","c6in.4xlarge","c6in.8xlarge","c6in.12xlarge","c6in.16xlarge","c6in.24xlarge","c6in.32xlarge","m6in.large","m6in.xlarge","m6in.2xlarge","m6in.4xlarge","m6in.8xlarge","m6in.12xlarge","m6in.16xlarge","m6in.24xlarge","m6in.32xlarge","m6idn.large","m6idn.xlarge","m6idn.2xlarge","m6idn.4xlarge","m6idn.8xlarge","m6idn.12xlarge","m6idn.16xlarge","m6idn.24xlarge","m6idn.32xlarge","r6in.large","r6in.xlarge","r6in.2xlarge","r6in.4xlarge","r6in.8xlarge","r6in.12xlarge","r6in.16xlarge","r6in.24xlarge","r6in.32xlarge","r6idn.large","r6idn.xlarge","r6idn.2xlarge","r6idn.4xlarge","r6idn.8xlarge","r6idn.12xlarge","r6idn.16xlarge","r6idn.24xlarge","r6idn.32xlarge","c7g.metal","m7g.medium","m7g.large","m7g.xlarge","m7g.2xlarge","m7g.4xlarge","m7g.8xlarge","m7g.12xlarge","m7g.16xlarge","m7g.metal","r7g.medium","r7g.large","r7g.xlarge","r7g.2xlarge","r7g.4xlarge","r7g.8xlarge","r7g.12xlarge","r7g.16xlarge","r7g.metal","c6in.metal","m6in.metal","m6idn.metal","r6in.metal","r6idn.metal","inf2.xlarge","inf2.8xlarge","inf2.24xlarge","inf2.48xlarge","trn1n.32xlarge","i4g.large","i4g.xlarge","i4g.2xlarge","i4g.4xlarge","i4g.8xlarge","i4g.16xlarge","hpc7g.4xlarge","hpc7g.8xlarge","hpc7g.16xlarge","c7gn.medium","c7gn.large","c7gn.xlarge","c7gn.2xlarge","c7gn.4xlarge","c7gn.8xlarge","c7gn.12xlarge","c7gn.16xlarge","p5.48xlarge","m7i.large","m7i.xlarge","m7i.2xlarge","m7i.4xlarge","m7i.8xlarge","m7i.12xlarge","m7i.16xlarge","m7i.24xlarge","m7i.48xlarge","m7i-flex.large","m7i-flex.xlarge","m7i-flex.2xlarge","m7i-flex.4xlarge","m7i-flex.8xlarge","m7a.medium","m7a.large","m7a.xlarge","m7a.2xlarge","m7a.4xlarge","m7a.8xlarge","m7a.12xlarge","m7a.16xlarge","m7a.24xlarge","m7a.32xlarge","m7a.48xlarge","m7a.metal-48xl","hpc7a.12xlarge","hpc7a.24xlarge","hpc7a.48xlarge","hpc7a.96xlarge","c7gd.medium","c7gd.large","c7gd.xlarge","c7gd.2xlarge","c7gd.4xlarge","c7gd.8xlarge","c7gd.12xlarge","c7gd.16xlarge","m7gd.medium","m7gd.large","m7gd.xlarge","m7gd.2xlarge","m7gd.4xlarge","m7gd.8xlarge","m7gd.12xlarge","m7gd.16xlarge","r7gd.medium","r7gd.large","r7gd.xlarge","r7gd.2xlarge","r7gd.4xlarge","r7gd.8xlarge","r7gd.12xlarge","r7gd.16xlarge","r7a.medium","r7a.large","r7a.xlarge","r7a.2xlarge","r7a.4xlarge","r7a.8xlarge","r7a.12xlarge","r7a.16xlarge","r7a.24xlarge","r7a.32xlarge","r7a.48xlarge","c7i.large","c7i.xlarge","c7i.2xlarge","c7i.4xlarge","c7i.8xlarge","c7i.12xlarge","c7i.16xlarge","c7i.24xlarge","c7i.48xlarge","mac2-m2pro.metal","r7iz.large","r7iz.xlarge","r7iz.2xlarge","r7iz.4xlarge","r7iz.8xlarge","r7iz.12xlarge","r7iz.16xlarge","r7iz.32xlarge","c7a.medium","c7a.large","c7a.xlarge","c7a.2xlarge","c7a.4xlarge","c7a.8xlarge","c7a.12xlarge","c7a.16xlarge","c7a.24xlarge","c7a.32xlarge","c7a.48xlarge","c7a.metal-48xl","r7a.metal-48xl","r7i.large","r7i.xlarge","r7i.2xlarge","r7i.4xlarge","r7i.8xlarge","r7i.12xlarge","r7i.16xlarge","r7i.24xlarge","r7i.48xlarge","dl2q.24xlarge","mac2-m2.metal","i4i.12xlarge","i4i.24xlarge","c7i.metal-24xl","c7i.metal-48xl","m7i.metal-24xl","m7i.metal-48xl","r7i.metal-24xl","r7i.metal-48xl","r7iz.metal-16xl","r7iz.metal-32xl","c7gd.metal","m7gd.metal","r7gd.metal","g6.xlarge","g6.2xlarge","g6.4xlarge","g6.8xlarge","g6.12xlarge","g6.16xlarge","g6.24xlarge","g6.48xlarge","gr6.4xlarge","gr6.8xlarge","c7i-flex.large","c7i-flex.xlarge","c7i-flex.2xlarge","c7i-flex.4xlarge","c7i-flex.8xlarge","u7i-12tb.224xlarge","u7in-16tb.224xlarge","u7in-24tb.224xlarge","u7in-32tb.224xlarge","u7ib-12tb.224xlarge","c7gn.metal","r8g.medium","r8g.large","r8g.xlarge","r8g.2xlarge","r8g.4xlarge","r8g.8xlarge","r8g.12xlarge","r8g.16xlarge","r8g.24xlarge","r8g.48xlarge","r8g.metal-24xl","r8g.metal-48xl","mac2-m1ultra.metal","null"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The instance type we want to create and run","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCE_TYPE"},"CamelAwsEC2Operation":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#OPERATION"},"CamelAwsEC2InstanceMinCount":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The minimum number of instances we want to run.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCE_MIN_COUNT"},"CamelAwsEC2InstanceMaxCount":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of instances we want to run.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCE_MAX_COUNT"},"CamelAwsEC2InstanceMonitoring":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Define if we want the running instances to be monitored","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCE_MONITORING"},"CamelAwsEC2InstanceKernelId":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of the kernel.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCE_KERNEL_ID"},"CamelAwsEC2InstanceEbsOptimized":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Define if the creating instance is optimized for EBS I/O.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCE_EBS_OPTIMIZED"},"CamelAwsEC2InstanceSecurityGroups":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The security groups to associate to the instances","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCE_SECURITY_GROUPS"},"CamelAwsEC2InstancesIds":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A collection of instances IDS to execute start, stop, describe and terminate operations on.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCES_IDS"},"CamelAwsEC2InstancesKeyPair":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the key pair.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCES_KEY_PAIR"},"CamelAwsEC2InstancesClientToken":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCES_CLIENT_TOKEN"},"CamelAwsEC2InstancesPlacement":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.ec2.model.Placement","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The placement for the instance.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCES_PLACEMENT"},"CamelAwsEC2InstancesTags":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A collection of tags to add or remove from EC2 resources","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#INSTANCES_TAGS"},"CamelAwsEC2SubnetId":{"index":14,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of the subnet to launch the instance into.","constantName":"org.apache.camel.component.aws2.ec2.AWS2EC2Constants#SUBNET_ID"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Logical name"},"amazonEc2Client":{"index":1,"kind":"parameter","displayName":"Amazon Ec2 Client","group":"producer","label":"producer","required":false,"type":"object","javaType":"software.amazon.awssdk.services.ec2.Ec2Client","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"To use an existing configured AmazonEC2Client client"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.ec2.AWS2EC2Operations","enum":["createAndRunInstances","startInstances","stopInstances","terminateInstances","describeInstances","describeInstancesStatus","rebootInstances","monitorInstances","unmonitorInstances","createTags","deleteTags"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"The operation to perform. It can be createAndRunInstances, startInstances, stopInstances, terminateInstances, describeInstances, describeInstancesStatus, rebootInstances, monitorInstances, unmonitorInstances, createTags or deleteTags"},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"The region in which EC2 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":6,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":7,"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."},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the EC2 client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"producer,proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the EC2 client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"producer,proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the EC2 client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Set whether the EC2 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Set whether the EC2 client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ec2.AWS2EC2Configuration","configurationField":"configuration","description":"Set whether the EC2 client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in EC2."}}} , -{"component":{"kind":"component","name":"aws2-ecs","title":"AWS Elastic Container Service (ECS)","description":"Manage AWS ECS cluster instances.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.ecs.ECS2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-ecs","version":"4.8.1","scheme":"aws2-ecs","extendsScheme":"","syntax":"aws2-ecs:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsECSOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.ecs.ECS2Constants#OPERATION"},"CamelAwsECSMaxResults":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit number of results while listing clusters","constantName":"org.apache.camel.component.aws2.ecs.ECS2Constants#MAX_RESULTS"},"CamelAwsECSClusterName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cluster name","constantName":"org.apache.camel.component.aws2.ecs.ECS2Constants#CLUSTER_NAME"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.ecs.ECS2Operations","enum":["listClusters","describeCluster","createCluster","deleteCluster"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"The region in which the ECS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":5,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":6,"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."},"ecsClient":{"index":7,"kind":"parameter","displayName":"Ecs Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.ecs.EcsClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"To use an existing configured AWS ECS client"},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the ECS client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the ECS client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the ECS client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Set whether the ECS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Set whether the ECS client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Set whether the ECS client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in ECS."}}} +{"component":{"kind":"component","name":"aws2-ecs","title":"AWS Elastic Container Service (ECS)","description":"Manage AWS ECS cluster instances.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.ecs.ECS2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-ecs","version":"4.8.2","scheme":"aws2-ecs","extendsScheme":"","syntax":"aws2-ecs:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsECSOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.ecs.ECS2Constants#OPERATION"},"CamelAwsECSMaxResults":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit number of results while listing clusters","constantName":"org.apache.camel.component.aws2.ecs.ECS2Constants#MAX_RESULTS"},"CamelAwsECSClusterName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cluster name","constantName":"org.apache.camel.component.aws2.ecs.ECS2Constants#CLUSTER_NAME"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.ecs.ECS2Operations","enum":["listClusters","describeCluster","createCluster","deleteCluster"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"The region in which the ECS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":5,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":6,"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."},"ecsClient":{"index":7,"kind":"parameter","displayName":"Ecs Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.ecs.EcsClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"To use an existing configured AWS ECS client"},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the ECS client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the ECS client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the ECS client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Set whether the ECS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Set whether the ECS client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ecs.ECS2Configuration","configurationField":"configuration","description":"Set whether the ECS client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in ECS."}}} , -{"component":{"kind":"component","name":"aws2-eks","title":"AWS Elastic Kubernetes Service (EKS)","description":"Manage AWS EKS cluster instances.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.eks.EKS2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-eks","version":"4.8.1","scheme":"aws2-eks","extendsScheme":"","syntax":"aws2-eks:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsEKSOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.eks.EKS2Constants#OPERATION"},"CamelAwsEKSMaxResults":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit number of results while listing clusters","constantName":"org.apache.camel.component.aws2.eks.EKS2Constants#MAX_RESULTS"},"CamelAwsEKSDescription":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A key description to use while performing a createKey operation","constantName":"org.apache.camel.component.aws2.eks.EKS2Constants#DESCRIPTION"},"CamelAwsEKSClusterName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cluster name","constantName":"org.apache.camel.component.aws2.eks.EKS2Constants#CLUSTER_NAME"},"CamelAwsEKSRoleARN":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The role ARN to use while creating the cluster","constantName":"org.apache.camel.component.aws2.eks.EKS2Constants#ROLE_ARN"},"CamelAwsEKSVPCConfig":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.eks.model.VpcConfigRequest","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The VPC config for the creations of an EKS cluster","constantName":"org.apache.camel.component.aws2.eks.EKS2Constants#VPC_CONFIG"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.eks.EKS2Operations","enum":["listClusters","describeCluster","createCluster","deleteCluster"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":4,"kind":"parameter","displayName":"Profile Credentials Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"The region in which EKS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":6,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"index":7,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Set whether the EKS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":8,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Set whether the EKS client should expect to load credentials through a profile credentials provider."},"lazyStartProducer":{"index":9,"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."},"eksClient":{"index":10,"kind":"parameter","displayName":"Eks Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.eks.EksClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"To use an existing configured AWS EKS client"},"proxyHost":{"index":11,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the EKS client"},"proxyPort":{"index":12,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the EKS client"},"proxyProtocol":{"index":13,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the EKS client"},"accessKey":{"index":14,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":15,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":16,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":17,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Set whether the EKS client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in EKS."}}} +{"component":{"kind":"component","name":"aws2-eks","title":"AWS Elastic Kubernetes Service (EKS)","description":"Manage AWS EKS cluster instances.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.eks.EKS2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-eks","version":"4.8.2","scheme":"aws2-eks","extendsScheme":"","syntax":"aws2-eks:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsEKSOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.eks.EKS2Constants#OPERATION"},"CamelAwsEKSMaxResults":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit number of results while listing clusters","constantName":"org.apache.camel.component.aws2.eks.EKS2Constants#MAX_RESULTS"},"CamelAwsEKSDescription":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A key description to use while performing a createKey operation","constantName":"org.apache.camel.component.aws2.eks.EKS2Constants#DESCRIPTION"},"CamelAwsEKSClusterName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cluster name","constantName":"org.apache.camel.component.aws2.eks.EKS2Constants#CLUSTER_NAME"},"CamelAwsEKSRoleARN":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The role ARN to use while creating the cluster","constantName":"org.apache.camel.component.aws2.eks.EKS2Constants#ROLE_ARN"},"CamelAwsEKSVPCConfig":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.eks.model.VpcConfigRequest","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The VPC config for the creations of an EKS cluster","constantName":"org.apache.camel.component.aws2.eks.EKS2Constants#VPC_CONFIG"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.eks.EKS2Operations","enum":["listClusters","describeCluster","createCluster","deleteCluster"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":4,"kind":"parameter","displayName":"Profile Credentials Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"The region in which EKS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":6,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"index":7,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Set whether the EKS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":8,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Set whether the EKS client should expect to load credentials through a profile credentials provider."},"lazyStartProducer":{"index":9,"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."},"eksClient":{"index":10,"kind":"parameter","displayName":"Eks Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.eks.EksClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"To use an existing configured AWS EKS client"},"proxyHost":{"index":11,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the EKS client"},"proxyPort":{"index":12,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the EKS client"},"proxyProtocol":{"index":13,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the EKS client"},"accessKey":{"index":14,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":15,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":16,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":17,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eks.EKS2Configuration","configurationField":"configuration","description":"Set whether the EKS client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in EKS."}}} , -{"component":{"kind":"component","name":"aws2-eventbridge","title":"AWS Eventbridge","description":"Send events to AWS Eventbridge cluster instances.","deprecated":false,"firstVersion":"3.6.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.eventbridge.EventbridgeComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-eventbridge","version":"4.8.1","scheme":"aws2-eventbridge","extendsScheme":"","syntax":"aws2-eventbridge://eventbusNameOrArn","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsEventbridgeOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#OPERATION"},"CamelAwsEventbridgeRuleName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the rule.","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#RULE_NAME"},"CamelAwsEventbridgeRuleNamePrefix":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The prefix matching the rule name.","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#RULE_NAME_PREFIX"},"CamelAwsEventbridgeEventPattern":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event pattern.","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#EVENT_PATTERN"},"CamelAwsEventbridgeTargets":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The targets to update or add to the rule.","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#TARGETS"},"CamelAwsEventbridgeTargetsIds":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The IDs of the targets to remove from the rule.","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#TARGETS_IDS"},"CamelAwsEventbridgeTargetArn":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the target resource.","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#TARGET_ARN"},"CamelAwsEventbridgeResourcesArn":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Comma separated list of Amazon Resource Names (ARN) of the resources related to Event","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#EVENT_RESOURCES_ARN"},"CamelAwsEventbridgeSource":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The source related to Event","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#EVENT_SOURCE"},"CamelAwsEventbridgeDetailType":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The detail type related to Event","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#EVENT_DETAIL_TYPE"}},"properties":{"eventbusNameOrArn":{"index":0,"kind":"path","displayName":"Eventbus Name Or Arn","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Event bus name or ARN"},"eventPatternFile":{"index":1,"kind":"parameter","displayName":"Event Pattern File","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"EventPattern File"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.eventbridge.EventbridgeOperations","enum":["putRule","putTargets","removeTargets","deleteRule","enableRule","disableRule","describeRule","listRules","listTargetsByRule","listRuleNamesByTarget","putEvent"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"putRule","configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"The region in which the Eventbridge client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":6,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":7,"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."},"eventbridgeClient":{"index":8,"kind":"parameter","displayName":"Eventbridge Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.eventbridge.EventBridgeClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"To use an existing configured AWS Eventbridge client"},"proxyHost":{"index":9,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the Eventbridge client"},"proxyPort":{"index":10,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the Eventbridge client"},"proxyProtocol":{"index":11,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Eventbridge client"},"accessKey":{"index":12,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":13,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"If using a profile credentials provider this parameter will set the profile name"},"secretKey":{"index":14,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":15,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":16,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Set whether the Eventbridge client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":18,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Set whether the Eventbridge client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":19,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Set whether the Eventbridge client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Eventbridge."}}} +{"component":{"kind":"component","name":"aws2-eventbridge","title":"AWS Eventbridge","description":"Send events to AWS Eventbridge cluster instances.","deprecated":false,"firstVersion":"3.6.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.eventbridge.EventbridgeComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-eventbridge","version":"4.8.2","scheme":"aws2-eventbridge","extendsScheme":"","syntax":"aws2-eventbridge://eventbusNameOrArn","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsEventbridgeOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#OPERATION"},"CamelAwsEventbridgeRuleName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the rule.","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#RULE_NAME"},"CamelAwsEventbridgeRuleNamePrefix":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The prefix matching the rule name.","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#RULE_NAME_PREFIX"},"CamelAwsEventbridgeEventPattern":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event pattern.","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#EVENT_PATTERN"},"CamelAwsEventbridgeTargets":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The targets to update or add to the rule.","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#TARGETS"},"CamelAwsEventbridgeTargetsIds":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The IDs of the targets to remove from the rule.","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#TARGETS_IDS"},"CamelAwsEventbridgeTargetArn":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the target resource.","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#TARGET_ARN"},"CamelAwsEventbridgeResourcesArn":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Comma separated list of Amazon Resource Names (ARN) of the resources related to Event","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#EVENT_RESOURCES_ARN"},"CamelAwsEventbridgeSource":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The source related to Event","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#EVENT_SOURCE"},"CamelAwsEventbridgeDetailType":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The detail type related to Event","constantName":"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#EVENT_DETAIL_TYPE"}},"properties":{"eventbusNameOrArn":{"index":0,"kind":"path","displayName":"Eventbus Name Or Arn","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Event bus name or ARN"},"eventPatternFile":{"index":1,"kind":"parameter","displayName":"Event Pattern File","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"EventPattern File"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.eventbridge.EventbridgeOperations","enum":["putRule","putTargets","removeTargets","deleteRule","enableRule","disableRule","describeRule","listRules","listTargetsByRule","listRuleNamesByTarget","putEvent"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"putRule","configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"The region in which the Eventbridge client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":6,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":7,"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."},"eventbridgeClient":{"index":8,"kind":"parameter","displayName":"Eventbridge Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.eventbridge.EventBridgeClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"To use an existing configured AWS Eventbridge client"},"proxyHost":{"index":9,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"To define a proxy host when instantiating the Eventbridge client"},"proxyPort":{"index":10,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"To define a proxy port when instantiating the Eventbridge client"},"proxyProtocol":{"index":11,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Eventbridge client"},"accessKey":{"index":12,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":13,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"If using a profile credentials provider this parameter will set the profile name"},"secretKey":{"index":14,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":15,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":16,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Set whether the Eventbridge client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":18,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Set whether the Eventbridge client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":19,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration","configurationField":"configuration","description":"Set whether the Eventbridge client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Eventbridge."}}} , -{"component":{"kind":"component","name":"aws2-iam","title":"AWS Identity and Access Management (IAM)","description":"Manage AWS IAM instances.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.iam.IAM2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-iam","version":"4.8.1","scheme":"aws2-iam","extendsScheme":"","syntax":"aws2-iam:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsIAMOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.iam.IAM2Constants#OPERATION"},"CamelAwsIAMUsername":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The username for the user you want to manage","constantName":"org.apache.camel.component.aws2.iam.IAM2Constants#USERNAME"},"CamelAwsIAMAccessKeyID":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The accessKey you want to manage","constantName":"org.apache.camel.component.aws2.iam.IAM2Constants#ACCESS_KEY_ID"},"CamelAwsIAMAccessKeyStatus":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Status of the AccessKey you want to set, possible value are active and inactive","constantName":"org.apache.camel.component.aws2.iam.IAM2Constants#ACCESS_KEY_STATUS"},"CamelAwsIAMGroupName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of an AWS IAM Group","constantName":"org.apache.camel.component.aws2.iam.IAM2Constants#GROUP_NAME"},"CamelAwsIAMGroupPath":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The path of an AWS IAM Group","constantName":"org.apache.camel.component.aws2.iam.IAM2Constants#GROUP_PATH"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Logical name"},"iamClient":{"index":1,"kind":"parameter","displayName":"Iam Client","group":"producer","label":"","required":false,"type":"object","javaType":"software.amazon.awssdk.services.iam.IamClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"To use an existing configured AWS IAM client"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.iam.IAM2Operations","enum":["listAccessKeys","createUser","deleteUser","getUser","listUsers","createAccessKey","deleteAccessKey","updateAccessKey","createGroup","deleteGroup","listGroups","addUserToGroup","removeUserFromGroup"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"The operation to perform. You can configure a default operation on the component level, or the operation as part of the endpoint, or via a message header with the key CamelAwsIAMOperation."},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"aws-global","configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"The region in which IAM client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":6,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":7,"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."},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the IAM client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the IAM client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the IAM client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Set whether the IAM client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Set whether the IAM client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Set whether the IAM client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume a IAM role for doing operations in IAM."}}} +{"component":{"kind":"component","name":"aws2-iam","title":"AWS Identity and Access Management (IAM)","description":"Manage AWS IAM instances.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.iam.IAM2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-iam","version":"4.8.2","scheme":"aws2-iam","extendsScheme":"","syntax":"aws2-iam:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsIAMOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.iam.IAM2Constants#OPERATION"},"CamelAwsIAMUsername":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The username for the user you want to manage","constantName":"org.apache.camel.component.aws2.iam.IAM2Constants#USERNAME"},"CamelAwsIAMAccessKeyID":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The accessKey you want to manage","constantName":"org.apache.camel.component.aws2.iam.IAM2Constants#ACCESS_KEY_ID"},"CamelAwsIAMAccessKeyStatus":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Status of the AccessKey you want to set, possible value are active and inactive","constantName":"org.apache.camel.component.aws2.iam.IAM2Constants#ACCESS_KEY_STATUS"},"CamelAwsIAMGroupName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of an AWS IAM Group","constantName":"org.apache.camel.component.aws2.iam.IAM2Constants#GROUP_NAME"},"CamelAwsIAMGroupPath":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The path of an AWS IAM Group","constantName":"org.apache.camel.component.aws2.iam.IAM2Constants#GROUP_PATH"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Logical name"},"iamClient":{"index":1,"kind":"parameter","displayName":"Iam Client","group":"producer","label":"","required":false,"type":"object","javaType":"software.amazon.awssdk.services.iam.IamClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"To use an existing configured AWS IAM client"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.iam.IAM2Operations","enum":["listAccessKeys","createUser","deleteUser","getUser","listUsers","createAccessKey","deleteAccessKey","updateAccessKey","createGroup","deleteGroup","listGroups","addUserToGroup","removeUserFromGroup"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"The operation to perform. You can configure a default operation on the component level, or the operation as part of the endpoint, or via a message header with the key CamelAwsIAMOperation."},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"aws-global","configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"The region in which IAM client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":6,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":7,"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."},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the IAM client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the IAM client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the IAM client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Set whether the IAM client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Set whether the IAM client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.iam.IAM2Configuration","configurationField":"configuration","description":"Set whether the IAM client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume a IAM role for doing operations in IAM."}}} , -{"component":{"kind":"component","name":"aws2-kinesis","title":"AWS Kinesis","description":"Consume and produce records from and to AWS Kinesis Streams.","deprecated":false,"firstVersion":"3.2.0","label":"cloud,messaging","javaType":"org.apache.camel.component.aws2.kinesis.Kinesis2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-kinesis","version":"4.8.1","scheme":"aws2-kinesis","extendsScheme":"","syntax":"aws2-kinesis:streamName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAwsKinesisSequenceNumber":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sequence number of the record, as defined in http://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html#API_PutRecord_ResponseSyntaxResponse Syntax","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#SEQUENCE_NUMBER"},"CamelAwsKinesisApproximateArrivalTimestamp":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time AWS assigned as the arrival time of the record.","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#APPROX_ARRIVAL_TIME"},"CamelAwsKinesisPartitionKey":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Identifies which shard in the stream the data record is assigned to.","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#PARTITION_KEY"},"CamelMessageTimestamp":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#MESSAGE_TIMESTAMP"},"CamelKinesisDbResumeAction":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resume action to execute when resuming.","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#RESUME_ACTION"},"CamelAwsKinesisShardId":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The shard ID of the shard where the data record was placed.","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#SHARD_ID"}},"properties":{"streamName":{"index":0,"kind":"path","displayName":"Stream Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Name of the stream"},"cborEnabled":{"index":1,"kind":"parameter","displayName":"Cbor Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"This option will set the CBOR_ENABLED property during the execution"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"region":{"index":3,"kind":"parameter","displayName":"Region","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":4,"kind":"parameter","displayName":"Uri Endpoint Override","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"iteratorType":{"index":5,"kind":"parameter","displayName":"Iterator Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"software.amazon.awssdk.services.kinesis.model.ShardIteratorType","enum":["AT_SEQUENCE_NUMBER","AFTER_SEQUENCE_NUMBER","TRIM_HORIZON","LATEST","AT_TIMESTAMP","null"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRIM_HORIZON","configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Defines where in the Kinesis stream to start getting records"},"maxResultsPerRequest":{"index":6,"kind":"parameter","displayName":"Max Results Per Request","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Maximum number of records that will be fetched in each poll"},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"sequenceNumber":{"index":8,"kind":"parameter","displayName":"Sequence Number","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER"},"shardClosed":{"index":9,"kind":"parameter","displayName":"Shard Closed","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.kinesis.Kinesis2ShardClosedStrategyEnum","enum":["ignore","fail","silent"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ignore","configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Define what will be the behavior in case of shard closed. Possible value are ignore, silent and fail. In case of ignore a WARN message will be logged once and the consumer will not process new messages until restarted,in case of silent there will be no logging and the consumer will not process new messages until restarted,in case of fail a ReachedClosedStateException will be thrown"},"shardId":{"index":10,"kind":"parameter","displayName":"Shard Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Defines which shardId in the Kinesis stream to get records from"},"bridgeErrorHandler":{"index":11,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":12,"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":{"index":13,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":14,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"shardMonitorInterval":{"index":15,"kind":"parameter","displayName":"Shard Monitor Interval","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"The interval in milliseconds to wait between shard polling"},"lazyStartProducer":{"index":16,"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."},"amazonKinesisClient":{"index":17,"kind":"parameter","displayName":"Amazon Kinesis Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.kinesis.KinesisClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Amazon Kinesis client to use for all requests for this endpoint"},"asyncClient":{"index":18,"kind":"parameter","displayName":"Async Client","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If we want to a KinesisAsyncClient instance set it to true"},"cloudWatchAsyncClient":{"index":19,"kind":"parameter","displayName":"Cloud Watch Async Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If we want to a KCL Consumer, we can pass an instance of CloudWatchAsyncClient"},"dynamoDbAsyncClient":{"index":20,"kind":"parameter","displayName":"Dynamo Db Async Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If we want to a KCL Consumer, we can pass an instance of DynamoDbAsyncClient"},"kclDisableCloudwatchMetricsExport":{"index":21,"kind":"parameter","displayName":"Kcl Disable Cloudwatch Metrics Export","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If we want to use a KCL Consumer and disable the CloudWatch Metrics Export"},"useKclConsumers":{"index":22,"kind":"parameter","displayName":"Use Kcl Consumers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If we want to a KCL Consumer set it to true"},"proxyHost":{"index":23,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the Kinesis client"},"proxyPort":{"index":24,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the Kinesis client"},"proxyProtocol":{"index":25,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Kinesis client"},"backoffErrorThreshold":{"index":26,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":27,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":28,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":29,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":30,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":31,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":32,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":33,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":34,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":35,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":36,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":37,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":38,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":39,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":40,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":41,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If using a profile credentials provider this parameter will set the profile name."},"secretKey":{"index":42,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":43,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume a IAM role"},"trustAllCertificates":{"index":44,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":45,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":46,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Set whether the Kinesis client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":47,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Set whether the Kinesis client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Kinesis."}}} +{"component":{"kind":"component","name":"aws2-kinesis","title":"AWS Kinesis","description":"Consume and produce records from and to AWS Kinesis Streams.","deprecated":false,"firstVersion":"3.2.0","label":"cloud,messaging","javaType":"org.apache.camel.component.aws2.kinesis.Kinesis2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-kinesis","version":"4.8.2","scheme":"aws2-kinesis","extendsScheme":"","syntax":"aws2-kinesis:streamName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAwsKinesisSequenceNumber":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sequence number of the record, as defined in http://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html#API_PutRecord_ResponseSyntaxResponse Syntax","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#SEQUENCE_NUMBER"},"CamelAwsKinesisApproximateArrivalTimestamp":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time AWS assigned as the arrival time of the record.","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#APPROX_ARRIVAL_TIME"},"CamelAwsKinesisPartitionKey":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Identifies which shard in the stream the data record is assigned to.","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#PARTITION_KEY"},"CamelMessageTimestamp":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#MESSAGE_TIMESTAMP"},"CamelKinesisDbResumeAction":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resume action to execute when resuming.","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#RESUME_ACTION"},"CamelAwsKinesisShardId":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The shard ID of the shard where the data record was placed.","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#SHARD_ID"}},"properties":{"streamName":{"index":0,"kind":"path","displayName":"Stream Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Name of the stream"},"cborEnabled":{"index":1,"kind":"parameter","displayName":"Cbor Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"This option will set the CBOR_ENABLED property during the execution"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"region":{"index":3,"kind":"parameter","displayName":"Region","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":4,"kind":"parameter","displayName":"Uri Endpoint Override","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"iteratorType":{"index":5,"kind":"parameter","displayName":"Iterator Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"software.amazon.awssdk.services.kinesis.model.ShardIteratorType","enum":["AT_SEQUENCE_NUMBER","AFTER_SEQUENCE_NUMBER","TRIM_HORIZON","LATEST","AT_TIMESTAMP","null"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRIM_HORIZON","configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Defines where in the Kinesis stream to start getting records"},"maxResultsPerRequest":{"index":6,"kind":"parameter","displayName":"Max Results Per Request","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Maximum number of records that will be fetched in each poll"},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"sequenceNumber":{"index":8,"kind":"parameter","displayName":"Sequence Number","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER"},"shardClosed":{"index":9,"kind":"parameter","displayName":"Shard Closed","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.kinesis.Kinesis2ShardClosedStrategyEnum","enum":["ignore","fail","silent"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ignore","configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Define what will be the behavior in case of shard closed. Possible value are ignore, silent and fail. In case of ignore a WARN message will be logged once and the consumer will not process new messages until restarted,in case of silent there will be no logging and the consumer will not process new messages until restarted,in case of fail a ReachedClosedStateException will be thrown"},"shardId":{"index":10,"kind":"parameter","displayName":"Shard Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Defines which shardId in the Kinesis stream to get records from"},"bridgeErrorHandler":{"index":11,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":12,"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":{"index":13,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":14,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"shardMonitorInterval":{"index":15,"kind":"parameter","displayName":"Shard Monitor Interval","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"The interval in milliseconds to wait between shard polling"},"lazyStartProducer":{"index":16,"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."},"amazonKinesisClient":{"index":17,"kind":"parameter","displayName":"Amazon Kinesis Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.kinesis.KinesisClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Amazon Kinesis client to use for all requests for this endpoint"},"asyncClient":{"index":18,"kind":"parameter","displayName":"Async Client","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If we want to a KinesisAsyncClient instance set it to true"},"cloudWatchAsyncClient":{"index":19,"kind":"parameter","displayName":"Cloud Watch Async Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If we want to a KCL Consumer, we can pass an instance of CloudWatchAsyncClient"},"dynamoDbAsyncClient":{"index":20,"kind":"parameter","displayName":"Dynamo Db Async Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If we want to a KCL Consumer, we can pass an instance of DynamoDbAsyncClient"},"kclDisableCloudwatchMetricsExport":{"index":21,"kind":"parameter","displayName":"Kcl Disable Cloudwatch Metrics Export","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If we want to use a KCL Consumer and disable the CloudWatch Metrics Export"},"useKclConsumers":{"index":22,"kind":"parameter","displayName":"Use Kcl Consumers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If we want to a KCL Consumer set it to true"},"proxyHost":{"index":23,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the Kinesis client"},"proxyPort":{"index":24,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the Kinesis client"},"proxyProtocol":{"index":25,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Kinesis client"},"backoffErrorThreshold":{"index":26,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":27,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":28,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":29,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":30,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":31,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":32,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":33,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":34,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":35,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":36,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":37,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":38,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":39,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":40,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":41,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If using a profile credentials provider this parameter will set the profile name."},"secretKey":{"index":42,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":43,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume a IAM role"},"trustAllCertificates":{"index":44,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":45,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":46,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Set whether the Kinesis client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":47,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Set whether the Kinesis client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Kinesis."}}} , -{"component":{"kind":"component","name":"aws2-kinesis-firehose","title":"AWS Kinesis Firehose","description":"Produce data to AWS Kinesis Firehose streams.","deprecated":false,"firstVersion":"3.2.0","label":"cloud,messaging","javaType":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-kinesis","version":"4.8.1","scheme":"aws2-kinesis-firehose","extendsScheme":"","syntax":"aws2-kinesis-firehose:streamName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsKinesisFirehoseRecordId":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The record ID, as defined in http://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecord.html#API_PutRecord_ResponseSyntaxResponse Syntax","constantName":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Constants#RECORD_ID"},"CamelAwsKinesisFirehoseOperation":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Constants#KINESIS_FIREHOSE_OPERATION"},"CamelAwsKinesisFirehoseDeliveryStreamName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the delivery stream.","constantName":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Constants#KINESIS_FIREHOSE_STREAM_NAME"}},"properties":{"streamName":{"index":0,"kind":"path","displayName":"Stream Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Name of the stream"},"cborEnabled":{"index":1,"kind":"parameter","displayName":"Cbor Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"This option will set the CBOR_ENABLED property during the execution"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"uriEndpointOverride":{"index":3,"kind":"parameter","displayName":"Uri Endpoint Override","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Operations","enum":["sendBatchRecord","createDeliveryStream","deleteDeliveryStream","describeDeliveryStream","updateDestination"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"The operation to do in case the user don't want to send only a record"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"useDefaultCredentialsProvider":{"index":6,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Set whether the Kinesis Firehose client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"lazyStartProducer":{"index":7,"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."},"amazonKinesisFirehoseClient":{"index":8,"kind":"parameter","displayName":"Amazon Kinesis Firehose Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.firehose.FirehoseClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Amazon Kinesis Firehose client to use for all requests for this endpoint"},"proxyHost":{"index":9,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the Kinesis Firehose client"},"proxyPort":{"index":10,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the Kinesis Firehose client"},"proxyProtocol":{"index":11,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Kinesis Firehose client"},"accessKey":{"index":12,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":13,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"If using a profile credentials provider this parameter will set the profile name."},"secretKey":{"index":14,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":15,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume a IAM role"},"trustAllCertificates":{"index":16,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Set whether the Kinesis Firehose client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Set whether the Kinesis Firehose client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Kinesis Firehose."}}} +{"component":{"kind":"component","name":"aws2-kinesis-firehose","title":"AWS Kinesis Firehose","description":"Produce data to AWS Kinesis Firehose streams.","deprecated":false,"firstVersion":"3.2.0","label":"cloud,messaging","javaType":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-kinesis","version":"4.8.2","scheme":"aws2-kinesis-firehose","extendsScheme":"","syntax":"aws2-kinesis-firehose:streamName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsKinesisFirehoseRecordId":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The record ID, as defined in http://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecord.html#API_PutRecord_ResponseSyntaxResponse Syntax","constantName":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Constants#RECORD_ID"},"CamelAwsKinesisFirehoseOperation":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Constants#KINESIS_FIREHOSE_OPERATION"},"CamelAwsKinesisFirehoseDeliveryStreamName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the delivery stream.","constantName":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Constants#KINESIS_FIREHOSE_STREAM_NAME"}},"properties":{"streamName":{"index":0,"kind":"path","displayName":"Stream Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Name of the stream"},"cborEnabled":{"index":1,"kind":"parameter","displayName":"Cbor Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"This option will set the CBOR_ENABLED property during the execution"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"uriEndpointOverride":{"index":3,"kind":"parameter","displayName":"Uri Endpoint Override","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Operations","enum":["sendBatchRecord","createDeliveryStream","deleteDeliveryStream","describeDeliveryStream","updateDestination"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"The operation to do in case the user don't want to send only a record"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"useDefaultCredentialsProvider":{"index":6,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Set whether the Kinesis Firehose client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"lazyStartProducer":{"index":7,"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."},"amazonKinesisFirehoseClient":{"index":8,"kind":"parameter","displayName":"Amazon Kinesis Firehose Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.firehose.FirehoseClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Amazon Kinesis Firehose client to use for all requests for this endpoint"},"proxyHost":{"index":9,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the Kinesis Firehose client"},"proxyPort":{"index":10,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the Kinesis Firehose client"},"proxyProtocol":{"index":11,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Kinesis Firehose client"},"accessKey":{"index":12,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":13,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"If using a profile credentials provider this parameter will set the profile name."},"secretKey":{"index":14,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":15,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume a IAM role"},"trustAllCertificates":{"index":16,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Set whether the Kinesis Firehose client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration","configurationField":"configuration","description":"Set whether the Kinesis Firehose client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Kinesis Firehose."}}} , -{"component":{"kind":"component","name":"aws2-kms","title":"AWS Key Management Service (KMS)","description":"Manage keys stored in AWS KMS instances.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.kms.KMS2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-kms","version":"4.8.1","scheme":"aws2-kms","extendsScheme":"","syntax":"aws2-kms:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsKMSOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.kms.KMS2Constants#OPERATION"},"CamelAwsKMSLimit":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit number of keys to return while performing a listKeys operation","constantName":"org.apache.camel.component.aws2.kms.KMS2Constants#LIMIT"},"CamelAwsKMSDescription":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A key description to use while performing a createKey operation","constantName":"org.apache.camel.component.aws2.kms.KMS2Constants#DESCRIPTION"},"CamelAwsKMSKeyId":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key Id","constantName":"org.apache.camel.component.aws2.kms.KMS2Constants#KEY_ID"},"CamelAwsKMSPendingWindowInDays":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The waiting period, specified in number of days.","constantName":"org.apache.camel.component.aws2.kms.KMS2Constants#PENDING_WINDOW_IN_DAYS"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.kms.KMS2Operations","enum":["listKeys","createKey","disableKey","scheduleKeyDeletion","describeKey","enableKey"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"The region in which EKS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":5,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":6,"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."},"kmsClient":{"index":7,"kind":"parameter","displayName":"Kms Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.kms.KmsClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"To use an existing configured AWS KMS client"},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the KMS client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the KMS client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the KMS client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Set whether the KMS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Set whether the KMS client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Set whether the KMS client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume a IAM role for doing operations in KMS."}}} +{"component":{"kind":"component","name":"aws2-kms","title":"AWS Key Management Service (KMS)","description":"Manage keys stored in AWS KMS instances.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.kms.KMS2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-kms","version":"4.8.2","scheme":"aws2-kms","extendsScheme":"","syntax":"aws2-kms:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsKMSOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.kms.KMS2Constants#OPERATION"},"CamelAwsKMSLimit":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit number of keys to return while performing a listKeys operation","constantName":"org.apache.camel.component.aws2.kms.KMS2Constants#LIMIT"},"CamelAwsKMSDescription":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A key description to use while performing a createKey operation","constantName":"org.apache.camel.component.aws2.kms.KMS2Constants#DESCRIPTION"},"CamelAwsKMSKeyId":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key Id","constantName":"org.apache.camel.component.aws2.kms.KMS2Constants#KEY_ID"},"CamelAwsKMSPendingWindowInDays":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The waiting period, specified in number of days.","constantName":"org.apache.camel.component.aws2.kms.KMS2Constants#PENDING_WINDOW_IN_DAYS"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.kms.KMS2Operations","enum":["listKeys","createKey","disableKey","scheduleKeyDeletion","describeKey","enableKey"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"The region in which EKS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":5,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":6,"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."},"kmsClient":{"index":7,"kind":"parameter","displayName":"Kms Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.kms.KmsClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"To use an existing configured AWS KMS client"},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the KMS client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the KMS client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the KMS client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Set whether the KMS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Set whether the KMS client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kms.KMS2Configuration","configurationField":"configuration","description":"Set whether the KMS client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume a IAM role for doing operations in KMS."}}} , -{"component":{"kind":"component","name":"aws2-lambda","title":"AWS Lambda","description":"Manage and invoke AWS Lambda functions.","deprecated":false,"firstVersion":"3.2.0","label":"cloud,serverless","javaType":"org.apache.camel.component.aws2.lambda.Lambda2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-lambda","version":"4.8.1","scheme":"aws2-lambda","extendsScheme":"","syntax":"aws2-lambda:function","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsLambdaOperation":{"index":0,"kind":"header","displayName":"","group":"all","label":"all","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform. Override operation passed as query parameter","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#OPERATION"},"CamelAwsLambdaS3Bucket":{"index":1,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#S3_BUCKET"},"CamelAwsLambdaS3Key":{"index":2,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon S3 object (the deployment package) key name you want to upload.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#S3_KEY"},"CamelAwsLambdaS3ObjectVersion":{"index":3,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon S3 object (the deployment package) version you want to upload.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#S3_OBJECT_VERSION"},"CamelAwsLambdaZipFile":{"index":4,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local path of the zip file (the deployment package). Content of zip file can also be put in Message body.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#ZIP_FILE"},"CamelAwsLambdaDescription":{"index":5,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user-provided description.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#DESCRIPTION"},"CamelAwsLambdaRole":{"index":6,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#ROLE"},"CamelAwsLambdaRuntime":{"index":7,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The runtime environment for the Lambda function you are uploading. (nodejs, nodejs4.3, nodejs6.10, java8, python2.7, python3.6, dotnetcore1.0, odejs4.3-edge)","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#RUNTIME"},"CamelAwsLambdaHandler":{"index":8,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The function within your code that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function. For Java, it can be package.class-name::handler or package.class-name.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#HANDLER"},"CamelAwsLambdaTargetArn":{"index":9,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#TARGET_ARN"},"CamelAwsLambdaMemorySize":{"index":10,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#MEMORY_SIZE"},"CamelAwsLambdaKMSKeyArn":{"index":11,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If not provided, AWS Lambda will use a default service key.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#KMS_KEY_ARN"},"CamelAwsLambdaEnvironmentVariables":{"index":12,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key-value pairs that represent your environment's configuration settings.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#ENVIRONMENT_VARIABLES"},"CamelAwsLambdaPublish":{"index":13,"kind":"header","displayName":"","group":"createFunction updateFunction","label":"createFunction updateFunction","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#PUBLISH"},"CamelAwsLambdaTimeout":{"index":14,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The function execution time at which Lambda should terminate the function. The default is 3 seconds.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#TIMEOUT"},"CamelAwsLambdaTags":{"index":15,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of tags (key-value pairs) assigned to the new function.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#TAGS"},"CamelAwsLambdaTracingConfig":{"index":16,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Your function's tracing settings (Active or PassThrough).","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#TRACING_CONFIG"},"CamelAwsLambdaSecurityGroupIds":{"index":17,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If your Lambda function accesses resources in a VPC, a list of one or more security groups IDs in your VPC.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#SECURITY_GROUP_IDS"},"CamelAwsLambdaSubnetIds":{"index":18,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If your Lambda function accesses resources in a VPC, a list of one or more subnet IDs in your VPC.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#SUBNET_IDS"},"CamelAwsLambdaEventSourceArn":{"index":19,"kind":"header","displayName":"","group":"createEventSourceMapping","label":"createEventSourceMapping","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the event source.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#EVENT_SOURCE_ARN"},"CamelAwsLambdaEventSourceBatchSize":{"index":20,"kind":"header","displayName":"","group":"createEventSourceMapping","label":"createEventSourceMapping","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#EVENT_SOURCE_BATCH_SIZE"},"CamelAwsLambdaEventSourceUuid":{"index":21,"kind":"header","displayName":"","group":"deleteEventSourceMapping","label":"deleteEventSourceMapping","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The identifier of the event source mapping.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#EVENT_SOURCE_UUID"},"CamelAwsLambdaResourceArn":{"index":22,"kind":"header","displayName":"","group":"listTags tagResource untagResource","label":"listTags tagResource untagResource","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The function's Amazon Resource Name (ARN).","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#RESOURCE_ARN"},"CamelAwsLambdaResourceTags":{"index":23,"kind":"header","displayName":"","group":"tagResource","label":"tagResource","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A list of tags to apply to the function.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#RESOURCE_TAGS"},"CamelAwsLambdaResourceTagKeys":{"index":24,"kind":"header","displayName":"","group":"untagResource","label":"untagResource","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A list of tag keys to remove from the function.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#RESOURCE_TAG_KEYS"},"CamelAwsLambdaVersionDescription":{"index":25,"kind":"header","displayName":"","group":"publishVersion","label":"publishVersion","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A description for the version to override the description in the function configuration.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#VERSION_DESCRIPTION"},"CamelAwsLambdaVersionRevisionId":{"index":26,"kind":"header","displayName":"","group":"publishVersion","label":"publishVersion","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only update the function if the revision ID matches the ID that's specified.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#VERSION_REVISION_ID"},"CamelAwsLambdaFunctionVersion":{"index":27,"kind":"header","displayName":"","group":"createAlias listAliases","label":"createAlias listAliases","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The function version to set in the alias","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#FUNCTION_VERSION"},"CamelAwsLambdaAliasFunctionName":{"index":28,"kind":"header","displayName":"","group":"createAlias deleteAlias getAlias","label":"createAlias deleteAlias getAlias","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The function name of the alias","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#FUNCTION_ALIAS_NAME"},"CamelAwsLambdaAliasFunctionDescription":{"index":29,"kind":"header","displayName":"","group":"createAlias","label":"createAlias","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The function description to set in the alias","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#FUNCTION_ALIAS_DESCRIPTION"}},"properties":{"function":{"index":0,"kind":"path","displayName":"Function","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the Lambda function."},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.lambda.Lambda2Operations","enum":["listFunctions","getFunction","createAlias","deleteAlias","getAlias","listAliases","createFunction","deleteFunction","invokeFunction","updateFunction","createEventSourceMapping","deleteEventSourceMapping","listEventSourceMapping","listTags","tagResource","untagResource","publishVersion","listVersions"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"invokeFunction","configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"The operation to perform. It can be listFunctions, getFunction, createFunction, deleteFunction or invokeFunction"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"The region in which the Lambda client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":5,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":6,"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."},"awsLambdaClient":{"index":7,"kind":"parameter","displayName":"Aws Lambda Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.lambda.LambdaClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"To use an existing configured AwsLambdaClient client"},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the Lambda client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the Lambda client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Lambda client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Set whether the Lambda client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Set whether the Lambda client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Set whether the Lambda client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Lambda."}}} +{"component":{"kind":"component","name":"aws2-lambda","title":"AWS Lambda","description":"Manage and invoke AWS Lambda functions.","deprecated":false,"firstVersion":"3.2.0","label":"cloud,serverless","javaType":"org.apache.camel.component.aws2.lambda.Lambda2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-lambda","version":"4.8.2","scheme":"aws2-lambda","extendsScheme":"","syntax":"aws2-lambda:function","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsLambdaOperation":{"index":0,"kind":"header","displayName":"","group":"all","label":"all","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform. Override operation passed as query parameter","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#OPERATION"},"CamelAwsLambdaS3Bucket":{"index":1,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#S3_BUCKET"},"CamelAwsLambdaS3Key":{"index":2,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon S3 object (the deployment package) key name you want to upload.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#S3_KEY"},"CamelAwsLambdaS3ObjectVersion":{"index":3,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon S3 object (the deployment package) version you want to upload.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#S3_OBJECT_VERSION"},"CamelAwsLambdaZipFile":{"index":4,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local path of the zip file (the deployment package). Content of zip file can also be put in Message body.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#ZIP_FILE"},"CamelAwsLambdaDescription":{"index":5,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user-provided description.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#DESCRIPTION"},"CamelAwsLambdaRole":{"index":6,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#ROLE"},"CamelAwsLambdaRuntime":{"index":7,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The runtime environment for the Lambda function you are uploading. (nodejs, nodejs4.3, nodejs6.10, java8, python2.7, python3.6, dotnetcore1.0, odejs4.3-edge)","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#RUNTIME"},"CamelAwsLambdaHandler":{"index":8,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The function within your code that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function. For Java, it can be package.class-name::handler or package.class-name.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#HANDLER"},"CamelAwsLambdaTargetArn":{"index":9,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#TARGET_ARN"},"CamelAwsLambdaMemorySize":{"index":10,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#MEMORY_SIZE"},"CamelAwsLambdaKMSKeyArn":{"index":11,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If not provided, AWS Lambda will use a default service key.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#KMS_KEY_ARN"},"CamelAwsLambdaEnvironmentVariables":{"index":12,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key-value pairs that represent your environment's configuration settings.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#ENVIRONMENT_VARIABLES"},"CamelAwsLambdaPublish":{"index":13,"kind":"header","displayName":"","group":"createFunction updateFunction","label":"createFunction updateFunction","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#PUBLISH"},"CamelAwsLambdaTimeout":{"index":14,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The function execution time at which Lambda should terminate the function. The default is 3 seconds.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#TIMEOUT"},"CamelAwsLambdaTags":{"index":15,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of tags (key-value pairs) assigned to the new function.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#TAGS"},"CamelAwsLambdaTracingConfig":{"index":16,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Your function's tracing settings (Active or PassThrough).","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#TRACING_CONFIG"},"CamelAwsLambdaSecurityGroupIds":{"index":17,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If your Lambda function accesses resources in a VPC, a list of one or more security groups IDs in your VPC.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#SECURITY_GROUP_IDS"},"CamelAwsLambdaSubnetIds":{"index":18,"kind":"header","displayName":"","group":"createFunction","label":"createFunction","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If your Lambda function accesses resources in a VPC, a list of one or more subnet IDs in your VPC.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#SUBNET_IDS"},"CamelAwsLambdaEventSourceArn":{"index":19,"kind":"header","displayName":"","group":"createEventSourceMapping","label":"createEventSourceMapping","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the event source.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#EVENT_SOURCE_ARN"},"CamelAwsLambdaEventSourceBatchSize":{"index":20,"kind":"header","displayName":"","group":"createEventSourceMapping","label":"createEventSourceMapping","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#EVENT_SOURCE_BATCH_SIZE"},"CamelAwsLambdaEventSourceUuid":{"index":21,"kind":"header","displayName":"","group":"deleteEventSourceMapping","label":"deleteEventSourceMapping","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The identifier of the event source mapping.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#EVENT_SOURCE_UUID"},"CamelAwsLambdaResourceArn":{"index":22,"kind":"header","displayName":"","group":"listTags tagResource untagResource","label":"listTags tagResource untagResource","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The function's Amazon Resource Name (ARN).","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#RESOURCE_ARN"},"CamelAwsLambdaResourceTags":{"index":23,"kind":"header","displayName":"","group":"tagResource","label":"tagResource","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A list of tags to apply to the function.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#RESOURCE_TAGS"},"CamelAwsLambdaResourceTagKeys":{"index":24,"kind":"header","displayName":"","group":"untagResource","label":"untagResource","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A list of tag keys to remove from the function.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#RESOURCE_TAG_KEYS"},"CamelAwsLambdaVersionDescription":{"index":25,"kind":"header","displayName":"","group":"publishVersion","label":"publishVersion","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A description for the version to override the description in the function configuration.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#VERSION_DESCRIPTION"},"CamelAwsLambdaVersionRevisionId":{"index":26,"kind":"header","displayName":"","group":"publishVersion","label":"publishVersion","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only update the function if the revision ID matches the ID that's specified.","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#VERSION_REVISION_ID"},"CamelAwsLambdaFunctionVersion":{"index":27,"kind":"header","displayName":"","group":"createAlias listAliases","label":"createAlias listAliases","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The function version to set in the alias","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#FUNCTION_VERSION"},"CamelAwsLambdaAliasFunctionName":{"index":28,"kind":"header","displayName":"","group":"createAlias deleteAlias getAlias","label":"createAlias deleteAlias getAlias","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The function name of the alias","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#FUNCTION_ALIAS_NAME"},"CamelAwsLambdaAliasFunctionDescription":{"index":29,"kind":"header","displayName":"","group":"createAlias","label":"createAlias","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The function description to set in the alias","constantName":"org.apache.camel.component.aws2.lambda.Lambda2Constants#FUNCTION_ALIAS_DESCRIPTION"}},"properties":{"function":{"index":0,"kind":"path","displayName":"Function","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the Lambda function."},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.lambda.Lambda2Operations","enum":["listFunctions","getFunction","createAlias","deleteAlias","getAlias","listAliases","createFunction","deleteFunction","invokeFunction","updateFunction","createEventSourceMapping","deleteEventSourceMapping","listEventSourceMapping","listTags","tagResource","untagResource","publishVersion","listVersions"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"invokeFunction","configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"The operation to perform. It can be listFunctions, getFunction, createFunction, deleteFunction or invokeFunction"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"The region in which the Lambda client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":5,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":6,"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."},"awsLambdaClient":{"index":7,"kind":"parameter","displayName":"Aws Lambda Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.lambda.LambdaClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"To use an existing configured AwsLambdaClient client"},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the Lambda client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the Lambda client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Lambda client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Set whether the Lambda client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Set whether the Lambda client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.lambda.Lambda2Configuration","configurationField":"configuration","description":"Set whether the Lambda client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Lambda."}}} , -{"component":{"kind":"component","name":"aws2-mq","title":"AWS MQ","description":"Send messages to AWS MQ.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,messaging","javaType":"org.apache.camel.component.aws2.mq.MQ2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-mq","version":"4.8.1","scheme":"aws2-mq","extendsScheme":"","syntax":"aws2-mq:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsMQOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#OPERATION"},"CamelAwsMQMaxResults":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of results that must be retrieved from listBrokers operation","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#MAX_RESULTS"},"CamelAwsMQBrokerName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The broker name","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_NAME"},"CamelAwsMQBrokerEngine":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Broker Engine for MQ.","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_ENGINE"},"CamelAwsMQBrokerEngineVersion":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Broker Engine Version for MQ. Currently you can choose between 5.15.6 and 5.15.0 of ACTIVEMQ","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_ENGINE_VERSION"},"CamelAwsMQBrokerID":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The broker id","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_ID"},"CamelAwsMQConfigurationID":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.mq.model.ConfigurationId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A list of information about the configuration.","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#CONFIGURATION_ID"},"CamelAwsMQBrokerDeploymentMode":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment mode for the broker in the createBroker operation","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_DEPLOYMENT_MODE"},"CamelAwsMQBrokerInstanceType":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The instance type for the MQ machine in the createBroker operation","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_INSTANCE_TYPE"},"CamelAwsMQBrokerUsers":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of users for MQ","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_USERS"},"CamelAwsMQBrokerPubliclyAccessible":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"If the MQ instance must be publicly available or not.","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_PUBLICLY_ACCESSIBLE"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.mq.MQ2Operations","enum":["listBrokers","createBroker","deleteBroker","rebootBroker","updateBroker","describeBroker"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"The operation to perform. It can be listBrokers, createBroker, deleteBroker"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"The region in which MQ client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":5,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":6,"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."},"amazonMqClient":{"index":7,"kind":"parameter","displayName":"Amazon Mq Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.mq.MqClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"To use a existing configured AmazonMQClient client"},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the MQ client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the MQ client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the MQ client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Set whether the MQ client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Set whether the MQ client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Set whether the MQ client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in MQ."}}} +{"component":{"kind":"component","name":"aws2-mq","title":"AWS MQ","description":"Send messages to AWS MQ.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,messaging","javaType":"org.apache.camel.component.aws2.mq.MQ2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-mq","version":"4.8.2","scheme":"aws2-mq","extendsScheme":"","syntax":"aws2-mq:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsMQOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#OPERATION"},"CamelAwsMQMaxResults":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of results that must be retrieved from listBrokers operation","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#MAX_RESULTS"},"CamelAwsMQBrokerName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The broker name","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_NAME"},"CamelAwsMQBrokerEngine":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Broker Engine for MQ.","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_ENGINE"},"CamelAwsMQBrokerEngineVersion":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Broker Engine Version for MQ. Currently you can choose between 5.15.6 and 5.15.0 of ACTIVEMQ","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_ENGINE_VERSION"},"CamelAwsMQBrokerID":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The broker id","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_ID"},"CamelAwsMQConfigurationID":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.mq.model.ConfigurationId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A list of information about the configuration.","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#CONFIGURATION_ID"},"CamelAwsMQBrokerDeploymentMode":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment mode for the broker in the createBroker operation","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_DEPLOYMENT_MODE"},"CamelAwsMQBrokerInstanceType":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The instance type for the MQ machine in the createBroker operation","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_INSTANCE_TYPE"},"CamelAwsMQBrokerUsers":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of users for MQ","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_USERS"},"CamelAwsMQBrokerPubliclyAccessible":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"If the MQ instance must be publicly available or not.","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_PUBLICLY_ACCESSIBLE"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.mq.MQ2Operations","enum":["listBrokers","createBroker","deleteBroker","rebootBroker","updateBroker","describeBroker"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"The operation to perform. It can be listBrokers, createBroker, deleteBroker"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"The region in which MQ client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":5,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":6,"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."},"amazonMqClient":{"index":7,"kind":"parameter","displayName":"Amazon Mq Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.mq.MqClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"To use a existing configured AmazonMQClient client"},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the MQ client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the MQ client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the MQ client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Set whether the MQ client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Set whether the MQ client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Set whether the MQ client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in MQ."}}} , -{"component":{"kind":"component","name":"aws2-msk","title":"AWS Managed Streaming for Apache Kafka (MSK)","description":"Manage AWS MSK instances.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.msk.MSK2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-msk","version":"4.8.1","scheme":"aws2-msk","extendsScheme":"","syntax":"aws2-msk:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsMSKOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.msk.MSK2Constants#OPERATION"},"CamelAwsMSKClusterFilter":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cluster name filter for list operation","constantName":"org.apache.camel.component.aws2.msk.MSK2Constants#CLUSTERS_FILTER"},"CamelAwsMSKClusterName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cluster name for list and create operation","constantName":"org.apache.camel.component.aws2.msk.MSK2Constants#CLUSTER_NAME"},"CamelAwsMSKClusterArn":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cluster arn for delete operation","constantName":"org.apache.camel.component.aws2.msk.MSK2Constants#CLUSTER_ARN"},"CamelAwsMSKClusterKafkaVersion":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Kafka for the cluster during create operation","constantName":"org.apache.camel.component.aws2.msk.MSK2Constants#CLUSTER_KAFKA_VERSION"},"CamelAwsMSKBrokerNodesNumber":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of nodes for the cluster during create operation","constantName":"org.apache.camel.component.aws2.msk.MSK2Constants#BROKER_NODES_NUMBER"},"CamelAwsMSKBrokerNodesGroupInfo":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.kafka.model.BrokerNodeGroupInfo","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Broker nodes group info to provide during the create operation","constantName":"org.apache.camel.component.aws2.msk.MSK2Constants#BROKER_NODES_GROUP_INFO"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.msk.MSK2Operations","enum":["listClusters","createCluster","deleteCluster","describeCluster"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"The region in which the MSK client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":5,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":6,"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."},"mskClient":{"index":7,"kind":"parameter","displayName":"Msk Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.kafka.KafkaClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"To use an existing configured AWS MSK client"},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the MSK client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the MSK client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the MSK client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Set whether the Kafka client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Set whether the MSK client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Set whether the MSK client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in MSK."}}} +{"component":{"kind":"component","name":"aws2-msk","title":"AWS Managed Streaming for Apache Kafka (MSK)","description":"Manage AWS MSK instances.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.msk.MSK2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-msk","version":"4.8.2","scheme":"aws2-msk","extendsScheme":"","syntax":"aws2-msk:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsMSKOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.msk.MSK2Constants#OPERATION"},"CamelAwsMSKClusterFilter":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cluster name filter for list operation","constantName":"org.apache.camel.component.aws2.msk.MSK2Constants#CLUSTERS_FILTER"},"CamelAwsMSKClusterName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cluster name for list and create operation","constantName":"org.apache.camel.component.aws2.msk.MSK2Constants#CLUSTER_NAME"},"CamelAwsMSKClusterArn":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cluster arn for delete operation","constantName":"org.apache.camel.component.aws2.msk.MSK2Constants#CLUSTER_ARN"},"CamelAwsMSKClusterKafkaVersion":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Kafka for the cluster during create operation","constantName":"org.apache.camel.component.aws2.msk.MSK2Constants#CLUSTER_KAFKA_VERSION"},"CamelAwsMSKBrokerNodesNumber":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of nodes for the cluster during create operation","constantName":"org.apache.camel.component.aws2.msk.MSK2Constants#BROKER_NODES_NUMBER"},"CamelAwsMSKBrokerNodesGroupInfo":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.kafka.model.BrokerNodeGroupInfo","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Broker nodes group info to provide during the create operation","constantName":"org.apache.camel.component.aws2.msk.MSK2Constants#BROKER_NODES_GROUP_INFO"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.msk.MSK2Operations","enum":["listClusters","createCluster","deleteCluster","describeCluster"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"The region in which the MSK client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":5,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":6,"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."},"mskClient":{"index":7,"kind":"parameter","displayName":"Msk Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.kafka.KafkaClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"To use an existing configured AWS MSK client"},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the MSK client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the MSK client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the MSK client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":14,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":15,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Set whether the Kafka client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":17,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Set whether the MSK client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.msk.MSK2Configuration","configurationField":"configuration","description":"Set whether the MSK client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in MSK."}}} , -{"component":{"kind":"component","name":"aws2-redshift-data","title":"AWS RedshiftData","description":"Perform operations on AWS Redshift using Redshift Data API.","deprecated":false,"firstVersion":"4.1.0","label":"cloud,serverless,database,bigdata","javaType":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-redshift","version":"4.8.1","scheme":"aws2-redshift-data","extendsScheme":"","syntax":"aws2-redshift-data:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsRedshiftDataOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#OPERATION"},"CamelAwsRedshiftDataClusterIdentifier":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cluster identifier.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#CLUSTER_IDENTIFIER"},"CamelAwsRedshiftDataSecretArn":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name or ARN of the secret that enables access to the database.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#SECRET_ARN"},"CamelAwsRedshiftDataDatabase":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the database.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#DATABASE"},"CamelAwsRedshiftDataWorkGroupName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The serverless workgroup name or Amazon Resource Name (ARN).","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#WORKGROUP_NAME"},"CamelAwsRedshiftDataDatabasesMaxResults":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of databases to return in the response.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#LIST_DATABASES_MAX_RESULTS"},"CamelAwsRedshiftDataDbUser":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The database user name.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#DB_USER"},"CamelAwsRedshiftDataConnectedDatabase":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A database name.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#CONNECTED_DATABASE"},"CamelAwsRedshiftDataSchemaPattern":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A pattern to filter results by schema name.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#SCHEMA_PATTERN"},"CamelAwsRedshiftDataSchemasMaxResults":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of schemas to return in the response.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#LIST_SCHEMAS_MAX_RESULTS"},"CamelAwsRedshiftDataStatementsMaxResults":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of SQL statements to return in the response.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#LIST_STATEMENTS_MAX_RESULTS"},"CamelAwsRedshiftDataStatementName":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the SQL statement specified as input to BatchExecuteStatement or ExecuteStatement to identify the query.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#STATEMENT_NAME"},"CamelAwsRedshiftDataStatus":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The status of the SQL statement to list.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#STATUS"},"CamelAwsRedshiftDataRoleLevel":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A value that filters which statements to return in the response.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#ROLE_LEVEL"},"CamelAwsRedshiftDataTablesMaxResults":{"index":14,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of tables to return in the response.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#LIST_TABLES_MAX_RESULTS"},"CamelAwsRedshiftDataTablePattern":{"index":15,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A pattern to filter results by table name.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#TABLE_PATTERN"},"CamelAwsRedshiftDataTable":{"index":16,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the table.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#TABLE"},"CamelAwsRedshiftDataSchema":{"index":17,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The schema that contains the table.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#SCHEMA"},"CamelAwsRedshiftDataDescribeTableMaxResults":{"index":18,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of tables to return in the response.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#DESCRIBE_TABLE_MAX_RESULTS"},"CamelAwsRedshiftDataStatementId":{"index":19,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the statement","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#STATEMENT_ID"},"CamelAwsRedshiftDataWithEvent":{"index":20,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#WITH_EVENT"},"CamelAwsRedshiftDataClientToken":{"index":21,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#CLIENT_TOKEN"},"CamelAwsRedshiftDataSqlStatement":{"index":22,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SQL statement text to run.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#SQL_STATEMENT"},"CamelAwsRedshiftDataSqlParameterList":{"index":23,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parameters for the SQL statement.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#SQL_PARAMETER_LIST"},"CamelAwsRedshiftDataSqlStatementList":{"index":24,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The List of SQL statements text to run.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#SQL_STATEMENT_LIST"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Operations","enum":["listDatabases","listSchemas","listStatements","listTables","describeTable","executeStatement","batchExecuteStatement","cancelStatement","describeStatement","getStatementResult"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"The operation to perform. It can be batchExecuteStatement, cancelStatement, describeStatement, describeTable, executeStatement, getStatementResult, listDatabases, listSchemas, listStatements or listTables"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":4,"kind":"parameter","displayName":"Profile Credentials Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"The region in which RedshiftData client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"trustAllCertificates":{"index":6,"kind":"parameter","displayName":"Trust All Certificates","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"uriEndpointOverride":{"index":7,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"index":8,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Set whether the RedshiftData client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":9,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Set whether the RedshiftData client should expect to load credentials through a profile credentials provider."},"lazyStartProducer":{"index":10,"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."},"awsRedshiftDataClient":{"index":11,"kind":"parameter","displayName":"Aws Redshift Data Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.redshiftdata.RedshiftDataClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"To use an existing configured AwsRedshiftDataClient client"},"proxyHost":{"index":12,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the RedshiftData client"},"proxyPort":{"index":13,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the RedshiftData client"},"proxyProtocol":{"index":14,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the RedshiftData client"},"accessKey":{"index":15,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":16,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":17,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Set whether the Redshift client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Redshift."}}} +{"component":{"kind":"component","name":"aws2-redshift-data","title":"AWS RedshiftData","description":"Perform operations on AWS Redshift using Redshift Data API.","deprecated":false,"firstVersion":"4.1.0","label":"cloud,serverless,database,bigdata","javaType":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-redshift","version":"4.8.2","scheme":"aws2-redshift-data","extendsScheme":"","syntax":"aws2-redshift-data:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsRedshiftDataOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#OPERATION"},"CamelAwsRedshiftDataClusterIdentifier":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cluster identifier.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#CLUSTER_IDENTIFIER"},"CamelAwsRedshiftDataSecretArn":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name or ARN of the secret that enables access to the database.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#SECRET_ARN"},"CamelAwsRedshiftDataDatabase":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the database.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#DATABASE"},"CamelAwsRedshiftDataWorkGroupName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The serverless workgroup name or Amazon Resource Name (ARN).","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#WORKGROUP_NAME"},"CamelAwsRedshiftDataDatabasesMaxResults":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of databases to return in the response.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#LIST_DATABASES_MAX_RESULTS"},"CamelAwsRedshiftDataDbUser":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The database user name.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#DB_USER"},"CamelAwsRedshiftDataConnectedDatabase":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A database name.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#CONNECTED_DATABASE"},"CamelAwsRedshiftDataSchemaPattern":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A pattern to filter results by schema name.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#SCHEMA_PATTERN"},"CamelAwsRedshiftDataSchemasMaxResults":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of schemas to return in the response.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#LIST_SCHEMAS_MAX_RESULTS"},"CamelAwsRedshiftDataStatementsMaxResults":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of SQL statements to return in the response.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#LIST_STATEMENTS_MAX_RESULTS"},"CamelAwsRedshiftDataStatementName":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the SQL statement specified as input to BatchExecuteStatement or ExecuteStatement to identify the query.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#STATEMENT_NAME"},"CamelAwsRedshiftDataStatus":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The status of the SQL statement to list.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#STATUS"},"CamelAwsRedshiftDataRoleLevel":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A value that filters which statements to return in the response.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#ROLE_LEVEL"},"CamelAwsRedshiftDataTablesMaxResults":{"index":14,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of tables to return in the response.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#LIST_TABLES_MAX_RESULTS"},"CamelAwsRedshiftDataTablePattern":{"index":15,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A pattern to filter results by table name.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#TABLE_PATTERN"},"CamelAwsRedshiftDataTable":{"index":16,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the table.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#TABLE"},"CamelAwsRedshiftDataSchema":{"index":17,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The schema that contains the table.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#SCHEMA"},"CamelAwsRedshiftDataDescribeTableMaxResults":{"index":18,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of tables to return in the response.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#DESCRIBE_TABLE_MAX_RESULTS"},"CamelAwsRedshiftDataStatementId":{"index":19,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the statement","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#STATEMENT_ID"},"CamelAwsRedshiftDataWithEvent":{"index":20,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#WITH_EVENT"},"CamelAwsRedshiftDataClientToken":{"index":21,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#CLIENT_TOKEN"},"CamelAwsRedshiftDataSqlStatement":{"index":22,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SQL statement text to run.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#SQL_STATEMENT"},"CamelAwsRedshiftDataSqlParameterList":{"index":23,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parameters for the SQL statement.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#SQL_PARAMETER_LIST"},"CamelAwsRedshiftDataSqlStatementList":{"index":24,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The List of SQL statements text to run.","constantName":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Constants#SQL_STATEMENT_LIST"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Operations","enum":["listDatabases","listSchemas","listStatements","listTables","describeTable","executeStatement","batchExecuteStatement","cancelStatement","describeStatement","getStatementResult"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"The operation to perform. It can be batchExecuteStatement, cancelStatement, describeStatement, describeTable, executeStatement, getStatementResult, listDatabases, listSchemas, listStatements or listTables"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":4,"kind":"parameter","displayName":"Profile Credentials Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"The region in which RedshiftData client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"trustAllCertificates":{"index":6,"kind":"parameter","displayName":"Trust All Certificates","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"uriEndpointOverride":{"index":7,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"index":8,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Set whether the RedshiftData client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":9,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Set whether the RedshiftData client should expect to load credentials through a profile credentials provider."},"lazyStartProducer":{"index":10,"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."},"awsRedshiftDataClient":{"index":11,"kind":"parameter","displayName":"Aws Redshift Data Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.redshiftdata.RedshiftDataClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"To use an existing configured AwsRedshiftDataClient client"},"proxyHost":{"index":12,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the RedshiftData client"},"proxyPort":{"index":13,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the RedshiftData client"},"proxyProtocol":{"index":14,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the RedshiftData client"},"accessKey":{"index":15,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":16,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":17,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.redshift.data.RedshiftData2Configuration","configurationField":"configuration","description":"Set whether the Redshift client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Redshift."}}} , -{"component":{"kind":"component","name":"aws2-s3","title":"AWS S3 Storage Service","description":"Store and retrieve objects from AWS S3 Storage Service.","deprecated":false,"firstVersion":"3.2.0","label":"cloud,file","javaType":"org.apache.camel.component.aws2.s3.AWS2S3Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-s3","version":"4.8.1","scheme":"aws2-s3","extendsScheme":"","syntax":"aws2-s3://bucketNameOrArn","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAwsS3BucketName":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bucket Name (can be dynamic using the simple language in the producer) which this object will be stored or which will be used for the current operation or in which this object is contained.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#BUCKET_NAME"},"CamelAwsS3ProducedBucketName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The computed bucket name that was used by the producer such as to get or put an s3 object","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#PRODUCED_BUCKET_NAME"},"CamelAwsS3BucketDestinationName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bucket Destination Name which will be used for the current operation","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#BUCKET_DESTINATION_NAME"},"CamelAwsS3ContentControl":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#CACHE_CONTROL"},"CamelAwsS3ContentDisposition":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The optional Content-Disposition HTTP header, which specifies presentational information such as the recommended filename for the object to be saved as.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#CONTENT_DISPOSITION"},"CamelAwsS3ContentEncoding":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The optional Content-Encoding HTTP header specifying what content encodings have been applied to the object and what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type field.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#CONTENT_ENCODING"},"CamelAwsS3ContentLength":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Content-Length HTTP header indicating the size of the associated object in bytes.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#CONTENT_LENGTH"},"CamelAwsS3ContentMD5":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864. This data is used as a message integrity check to verify that the data received by Amazon S3 is the same data that the caller sent.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#CONTENT_MD5"},"CamelAwsS3ContentType":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Content-Type HTTP header, which indicates the type of content stored in the associated object. The value of this header is a standard MIME type.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#CONTENT_TYPE"},"CamelAwsS3ETag":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) The ETag value for the newly uploaded object. (consumer) The hex encoded 128-bit MD5 digest of the associated object according to RFC 1864. This data is used as an integrity check to verify that the data received by the caller is the same data that was sent by Amazon S3.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#E_TAG"},"CamelAwsS3Key":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key (can be dynamic using the simple language in the producer) under which this object is stored or will be stored or which will be used for the current operation","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#KEY"},"CamelAwsS3ProducedKey":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The computed key that was used for retrieving this object","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#PRODUCED_KEY"},"CamelAwsS3DestinationKey":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Destination key which will be used for the current operation","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#DESTINATION_KEY"},"CamelAwsS3LastModified":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of the Last-Modified header, indicating the date and time at which Amazon S3 last recorded a modification to the associated object.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#LAST_MODIFIED"},"CamelAwsS3StorageClass":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The storage class of this object.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#STORAGE_CLASS"},"CamelAwsS3VersionId":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) The optional version ID of the newly uploaded object. (consumer) The version ID of the associated Amazon S3 object if available. Version IDs are only assigned to objects when an object is uploaded to an Amazon S3 bucket that has object versioning enabled.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#VERSION_ID"},"CamelAwsS3CannedAcl":{"index":16,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The canned acl that will be applied to the object. see software.amazon.awssdk.services.s3.model.ObjectCannedACL for allowed values.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#CANNED_ACL"},"CamelAwsS3Acl":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"software.amazon.awssdk.services.s3.model.BucketCannedACL","enum":["private","public-read","public-read-write","authenticated-read","null"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A well constructed Amazon S3 Access Control List object.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#ACL"},"CamelAwsS3Operation":{"index":18,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform. Permitted values are copyObject, deleteObject, listBuckets, deleteBucket, listObjects","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#S3_OPERATION"},"CamelAwsS3ServerSideEncryption":{"index":19,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#SERVER_SIDE_ENCRYPTION"},"CamelAwsS3ExpirationTime":{"index":20,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#EXPIRATION_TIME"},"CamelAwsS3ReplicationStatus":{"index":21,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"software.amazon.awssdk.services.s3.model.ReplicationStatus","enum":["COMPLETE","PENDING","FAILED","REPLICA","COMPLETED","null"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#REPLICATION_STATUS"},"CamelAwsS3RangeStart":{"index":22,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The position of the first byte to get","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#RANGE_START"},"CamelAwsS3RangeEnd":{"index":23,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The position of the last byte to get","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#RANGE_END"},"CamelAwsS3DowloadLinkExpirationTime":{"index":24,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The expiration time of the download link in milliseconds","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#DOWNLOAD_LINK_EXPIRATION_TIME"},"CamelAwsS3DownloadLinkBrowserCompatible":{"index":25,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Whether the download link is browser compatible","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#DOWNLOAD_LINK_BROWSER_COMPATIBLE"},"CamelAwsS3DownloadLinkHttpRequestHeaders":{"index":26,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The headers that are needed by the service (not needed when BrowserCompatible is true)","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#DOWNLOAD_LINK_HTTP_REQUEST_HEADERS"},"CamelAwsS3DownloadLinkSignedPayload":{"index":27,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request payload that is needed by the service (not needed when BrowserCompatible is true)","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#DOWNLOAD_LINK_SIGNED_PAYLOAD"},"CamelAwsS3Metadata":{"index":28,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A map of metadata to be stored or stored with the object in S3. More details about metadata https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingMetadata.htmlhere.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#METADATA"},"CamelMessageTimestamp":{"index":29,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#MESSAGE_TIMESTAMP"},"CamelAwsS3Prefix":{"index":30,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only list objects we are interested in","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#PREFIX"},"CamelAwsS3Delimiter":{"index":31,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only list objects we are interested in","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#DELIMITER"}},"properties":{"bucketNameOrArn":{"index":0,"kind":"path","displayName":"Bucket Name Or Arn","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Bucket name or ARN"},"autoCreateBucket":{"index":1,"kind":"parameter","displayName":"Auto Create Bucket","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled, and it will create the destinationBucket if it doesn't exist already."},"delimiter":{"index":2,"kind":"parameter","displayName":"Delimiter","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in."},"forcePathStyle":{"index":3,"kind":"parameter","displayName":"Force Path Style","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Set whether the S3 client should use path-style URL instead of virtual-hosted-style"},"ignoreBody":{"index":4,"kind":"parameter","displayName":"Ignore Body","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If it is true, the S3 Object Body will be ignored completely if it is set to false, the S3 Object will be put in the body. Setting this to true will override any behavior defined by includeBody option."},"overrideEndpoint":{"index":5,"kind":"parameter","displayName":"Override Endpoint","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":6,"kind":"parameter","displayName":"Pojo Request","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"policy":{"index":7,"kind":"parameter","displayName":"Policy","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method."},"prefix":{"index":8,"kind":"parameter","displayName":"Prefix","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in."},"region":{"index":9,"kind":"parameter","displayName":"Region","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The region in which the S3 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":10,"kind":"parameter","displayName":"Uri Endpoint Override","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"customerAlgorithm":{"index":11,"kind":"parameter","displayName":"Customer Algorithm","group":"common (advanced)","label":"common,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define the customer algorithm to use in case CustomerKey is enabled"},"customerKeyId":{"index":12,"kind":"parameter","displayName":"Customer Key Id","group":"common (advanced)","label":"common,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define the id of the Customer key to use in case CustomerKey is enabled"},"customerKeyMD5":{"index":13,"kind":"parameter","displayName":"Customer Key MD5","group":"common (advanced)","label":"common,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define the MD5 of Customer key to use in case CustomerKey is enabled"},"deleteAfterRead":{"index":14,"kind":"parameter","displayName":"Delete After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Delete objects from S3 after they have been retrieved. The deleting is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieved over and over again in the polls. Therefore, you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the AWS2S3Constants#BUCKET_NAME and AWS2S3Constants#KEY headers, or only the AWS2S3Constants#KEY header."},"destinationBucket":{"index":15,"kind":"parameter","displayName":"Destination Bucket","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define the destination bucket where an object must be moved when moveAfterRead is set to true."},"destinationBucketPrefix":{"index":16,"kind":"parameter","displayName":"Destination Bucket Prefix","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define the destination bucket prefix to use when an object must be moved, and moveAfterRead is set to true."},"destinationBucketSuffix":{"index":17,"kind":"parameter","displayName":"Destination Bucket Suffix","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define the destination bucket suffix to use when an object must be moved, and moveAfterRead is set to true."},"doneFileName":{"index":18,"kind":"parameter","displayName":"Done File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If provided, Camel will only consume files if a done file exists."},"fileName":{"index":19,"kind":"parameter","displayName":"File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"To get the object from the bucket with the given file name"},"includeBody":{"index":20,"kind":"parameter","displayName":"Include Body","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If it is true, the S3Object exchange will be consumed and put into the body and closed. If false, the S3Object stream will be put raw into the body and the headers will be set with the S3 object metadata. This option is strongly related to the autocloseBody option. In case of setting includeBody to true because the S3Object stream will be consumed then it will also be closed, while in case of includeBody false then it will be up to the caller to close the S3Object stream. However, setting autocloseBody to true when includeBody is false it will schedule to close the S3Object stream automatically on exchange completion."},"includeFolders":{"index":21,"kind":"parameter","displayName":"Include Folders","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those"},"maxConnections":{"index":22,"kind":"parameter","displayName":"Max Connections","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60,"description":"Set the maxConnections parameter in the S3 client configuration"},"maxMessagesPerPoll":{"index":23,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"description":"Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited."},"moveAfterRead":{"index":24,"kind":"parameter","displayName":"Move After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Move objects from S3 bucket to a different bucket after they have been retrieved. To accomplish the operation, the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved."},"sendEmptyMessageWhenIdle":{"index":25,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"autocloseBody":{"index":26,"kind":"parameter","displayName":"Autoclose Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If this option is true and includeBody is false, then the S3Object.close() method will be called on exchange completion. This option is strongly related to includeBody option. In case of setting includeBody to false and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically."},"bridgeErrorHandler":{"index":27,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":28,"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":{"index":29,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"inProgressRepository":{"index":30,"kind":"parameter","displayName":"In Progress Repository","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."},"pollStrategy":{"index":31,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"batchMessageNumber":{"index":32,"kind":"parameter","displayName":"Batch Message Number","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The number of messages composing a batch in streaming upload mode"},"batchSize":{"index":33,"kind":"parameter","displayName":"Batch Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000000,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The batch size (in bytes) in streaming upload mode"},"bufferSize":{"index":34,"kind":"parameter","displayName":"Buffer Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000000,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The buffer size (in bytes) in streaming upload mode"},"deleteAfterWrite":{"index":35,"kind":"parameter","displayName":"Delete After Write","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Delete file object after the S3 file has been uploaded"},"keyName":{"index":36,"kind":"parameter","displayName":"Key Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Setting the key name for an element in the bucket through endpoint parameter"},"multiPartUpload":{"index":37,"kind":"parameter","displayName":"Multi Part Upload","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If it is true, camel will upload the file with multipart format. The part size is decided by the partSize option. Camel will only do multipart uploads for files that are larger than the part-size thresholds. Files that are smaller will be uploaded in a single operation."},"namingStrategy":{"index":38,"kind":"parameter","displayName":"Naming Strategy","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.s3.stream.AWSS3NamingStrategyEnum","enum":["progressive","random"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"progressive","configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The naming strategy to use in streaming upload mode"},"operation":{"index":39,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.s3.AWS2S3Operations","enum":["copyObject","listObjects","deleteObject","deleteBucket","listBuckets","getObject","getObjectRange","createDownloadLink"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The operation to do in case the user don't want to do only an upload"},"partSize":{"index":40,"kind":"parameter","displayName":"Part Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":26214400,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Set up the partSize which is used in multipart upload, the default size is 25M. Camel will only do multipart uploads for files that are larger than the part-size thresholds. Files that are smaller will be uploaded in a single operation."},"restartingPolicy":{"index":41,"kind":"parameter","displayName":"Restarting Policy","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.s3.stream.AWSS3RestartingPolicyEnum","enum":["override","lastPart"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"override","configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The restarting policy to use in streaming upload mode"},"storageClass":{"index":42,"kind":"parameter","displayName":"Storage Class","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request."},"streamingUploadMode":{"index":43,"kind":"parameter","displayName":"Streaming Upload Mode","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"When stream mode is true, the upload to bucket will be done in streaming"},"streamingUploadTimeout":{"index":44,"kind":"parameter","displayName":"Streaming Upload Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"While streaming upload mode is true, this option set the timeout to complete upload"},"awsKMSKeyId":{"index":45,"kind":"parameter","displayName":"Aws KMSKey Id","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define the id of KMS key to use in case KMS is enabled"},"lazyStartProducer":{"index":46,"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."},"useAwsKMS":{"index":47,"kind":"parameter","displayName":"Use Aws KMS","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define if KMS must be used or not"},"useCustomerKey":{"index":48,"kind":"parameter","displayName":"Use Customer Key","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define if Customer Key must be used or not"},"useSSES3":{"index":49,"kind":"parameter","displayName":"Use SSES3","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define if SSE S3 must be used or not"},"amazonS3Client":{"index":50,"kind":"parameter","displayName":"Amazon S3 Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.s3.S3Client","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Reference to a com.amazonaws.services.s3.AmazonS3 in the registry."},"amazonS3Presigner":{"index":51,"kind":"parameter","displayName":"Amazon S3 Presigner","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.s3.presigner.S3Presigner","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"An S3 Presigner for Request, used mainly in createDownloadLink operation"},"proxyHost":{"index":52,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the SQS client"},"proxyPort":{"index":53,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Specify a proxy port to be used inside the client definition."},"proxyProtocol":{"index":54,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the S3 client"},"backoffErrorThreshold":{"index":55,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":56,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":57,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":58,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":59,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":60,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":61,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":62,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":63,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":64,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":65,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":66,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":67,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":68,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":69,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":70,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":71,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":72,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":73,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":74,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Set whether the S3 client should expect to load credentials through a default credentials provider."},"useProfileCredentialsProvider":{"index":75,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Set whether the S3 client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":76,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Set whether the S3 client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in S3."}}} +{"component":{"kind":"component","name":"aws2-s3","title":"AWS S3 Storage Service","description":"Store and retrieve objects from AWS S3 Storage Service.","deprecated":false,"firstVersion":"3.2.0","label":"cloud,file","javaType":"org.apache.camel.component.aws2.s3.AWS2S3Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-s3","version":"4.8.2","scheme":"aws2-s3","extendsScheme":"","syntax":"aws2-s3://bucketNameOrArn","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAwsS3BucketName":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bucket Name (can be dynamic using the simple language in the producer) which this object will be stored or which will be used for the current operation or in which this object is contained.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#BUCKET_NAME"},"CamelAwsS3ProducedBucketName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The computed bucket name that was used by the producer such as to get or put an s3 object","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#PRODUCED_BUCKET_NAME"},"CamelAwsS3BucketDestinationName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bucket Destination Name which will be used for the current operation","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#BUCKET_DESTINATION_NAME"},"CamelAwsS3ContentControl":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#CACHE_CONTROL"},"CamelAwsS3ContentDisposition":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The optional Content-Disposition HTTP header, which specifies presentational information such as the recommended filename for the object to be saved as.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#CONTENT_DISPOSITION"},"CamelAwsS3ContentEncoding":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The optional Content-Encoding HTTP header specifying what content encodings have been applied to the object and what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type field.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#CONTENT_ENCODING"},"CamelAwsS3ContentLength":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Content-Length HTTP header indicating the size of the associated object in bytes.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#CONTENT_LENGTH"},"CamelAwsS3ContentMD5":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864. This data is used as a message integrity check to verify that the data received by Amazon S3 is the same data that the caller sent.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#CONTENT_MD5"},"CamelAwsS3ContentType":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Content-Type HTTP header, which indicates the type of content stored in the associated object. The value of this header is a standard MIME type.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#CONTENT_TYPE"},"CamelAwsS3ETag":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) The ETag value for the newly uploaded object. (consumer) The hex encoded 128-bit MD5 digest of the associated object according to RFC 1864. This data is used as an integrity check to verify that the data received by the caller is the same data that was sent by Amazon S3.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#E_TAG"},"CamelAwsS3Key":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key (can be dynamic using the simple language in the producer) under which this object is stored or will be stored or which will be used for the current operation","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#KEY"},"CamelAwsS3ProducedKey":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The computed key that was used for retrieving this object","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#PRODUCED_KEY"},"CamelAwsS3DestinationKey":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Destination key which will be used for the current operation","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#DESTINATION_KEY"},"CamelAwsS3LastModified":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of the Last-Modified header, indicating the date and time at which Amazon S3 last recorded a modification to the associated object.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#LAST_MODIFIED"},"CamelAwsS3StorageClass":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The storage class of this object.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#STORAGE_CLASS"},"CamelAwsS3VersionId":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) The optional version ID of the newly uploaded object. (consumer) The version ID of the associated Amazon S3 object if available. Version IDs are only assigned to objects when an object is uploaded to an Amazon S3 bucket that has object versioning enabled.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#VERSION_ID"},"CamelAwsS3CannedAcl":{"index":16,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The canned acl that will be applied to the object. see software.amazon.awssdk.services.s3.model.ObjectCannedACL for allowed values.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#CANNED_ACL"},"CamelAwsS3Acl":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"software.amazon.awssdk.services.s3.model.BucketCannedACL","enum":["private","public-read","public-read-write","authenticated-read","null"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A well constructed Amazon S3 Access Control List object.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#ACL"},"CamelAwsS3Operation":{"index":18,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform. Permitted values are copyObject, deleteObject, listBuckets, deleteBucket, listObjects","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#S3_OPERATION"},"CamelAwsS3ServerSideEncryption":{"index":19,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#SERVER_SIDE_ENCRYPTION"},"CamelAwsS3ExpirationTime":{"index":20,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#EXPIRATION_TIME"},"CamelAwsS3ReplicationStatus":{"index":21,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"software.amazon.awssdk.services.s3.model.ReplicationStatus","enum":["COMPLETE","PENDING","FAILED","REPLICA","COMPLETED","null"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#REPLICATION_STATUS"},"CamelAwsS3RangeStart":{"index":22,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The position of the first byte to get","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#RANGE_START"},"CamelAwsS3RangeEnd":{"index":23,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The position of the last byte to get","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#RANGE_END"},"CamelAwsS3DowloadLinkExpirationTime":{"index":24,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The expiration time of the download link in milliseconds","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#DOWNLOAD_LINK_EXPIRATION_TIME"},"CamelAwsS3DownloadLinkBrowserCompatible":{"index":25,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Whether the download link is browser compatible","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#DOWNLOAD_LINK_BROWSER_COMPATIBLE"},"CamelAwsS3DownloadLinkHttpRequestHeaders":{"index":26,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The headers that are needed by the service (not needed when BrowserCompatible is true)","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#DOWNLOAD_LINK_HTTP_REQUEST_HEADERS"},"CamelAwsS3DownloadLinkSignedPayload":{"index":27,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request payload that is needed by the service (not needed when BrowserCompatible is true)","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#DOWNLOAD_LINK_SIGNED_PAYLOAD"},"CamelAwsS3Metadata":{"index":28,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A map of metadata to be stored or stored with the object in S3. More details about metadata https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingMetadata.htmlhere.","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#METADATA"},"CamelMessageTimestamp":{"index":29,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#MESSAGE_TIMESTAMP"},"CamelAwsS3Prefix":{"index":30,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only list objects we are interested in","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#PREFIX"},"CamelAwsS3Delimiter":{"index":31,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only list objects we are interested in","constantName":"org.apache.camel.component.aws2.s3.AWS2S3Constants#DELIMITER"}},"properties":{"bucketNameOrArn":{"index":0,"kind":"path","displayName":"Bucket Name Or Arn","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Bucket name or ARN"},"autoCreateBucket":{"index":1,"kind":"parameter","displayName":"Auto Create Bucket","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled, and it will create the destinationBucket if it doesn't exist already."},"delimiter":{"index":2,"kind":"parameter","displayName":"Delimiter","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in."},"forcePathStyle":{"index":3,"kind":"parameter","displayName":"Force Path Style","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Set whether the S3 client should use path-style URL instead of virtual-hosted-style"},"ignoreBody":{"index":4,"kind":"parameter","displayName":"Ignore Body","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If it is true, the S3 Object Body will be ignored completely if it is set to false, the S3 Object will be put in the body. Setting this to true will override any behavior defined by includeBody option."},"overrideEndpoint":{"index":5,"kind":"parameter","displayName":"Override Endpoint","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":6,"kind":"parameter","displayName":"Pojo Request","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"policy":{"index":7,"kind":"parameter","displayName":"Policy","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method."},"prefix":{"index":8,"kind":"parameter","displayName":"Prefix","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in."},"region":{"index":9,"kind":"parameter","displayName":"Region","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The region in which the S3 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":10,"kind":"parameter","displayName":"Uri Endpoint Override","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"customerAlgorithm":{"index":11,"kind":"parameter","displayName":"Customer Algorithm","group":"common (advanced)","label":"common,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define the customer algorithm to use in case CustomerKey is enabled"},"customerKeyId":{"index":12,"kind":"parameter","displayName":"Customer Key Id","group":"common (advanced)","label":"common,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define the id of the Customer key to use in case CustomerKey is enabled"},"customerKeyMD5":{"index":13,"kind":"parameter","displayName":"Customer Key MD5","group":"common (advanced)","label":"common,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define the MD5 of Customer key to use in case CustomerKey is enabled"},"deleteAfterRead":{"index":14,"kind":"parameter","displayName":"Delete After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Delete objects from S3 after they have been retrieved. The deleting is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieved over and over again in the polls. Therefore, you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the AWS2S3Constants#BUCKET_NAME and AWS2S3Constants#KEY headers, or only the AWS2S3Constants#KEY header."},"destinationBucket":{"index":15,"kind":"parameter","displayName":"Destination Bucket","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define the destination bucket where an object must be moved when moveAfterRead is set to true."},"destinationBucketPrefix":{"index":16,"kind":"parameter","displayName":"Destination Bucket Prefix","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define the destination bucket prefix to use when an object must be moved, and moveAfterRead is set to true."},"destinationBucketSuffix":{"index":17,"kind":"parameter","displayName":"Destination Bucket Suffix","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define the destination bucket suffix to use when an object must be moved, and moveAfterRead is set to true."},"doneFileName":{"index":18,"kind":"parameter","displayName":"Done File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If provided, Camel will only consume files if a done file exists."},"fileName":{"index":19,"kind":"parameter","displayName":"File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"To get the object from the bucket with the given file name"},"includeBody":{"index":20,"kind":"parameter","displayName":"Include Body","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If it is true, the S3Object exchange will be consumed and put into the body and closed. If false, the S3Object stream will be put raw into the body and the headers will be set with the S3 object metadata. This option is strongly related to the autocloseBody option. In case of setting includeBody to true because the S3Object stream will be consumed then it will also be closed, while in case of includeBody false then it will be up to the caller to close the S3Object stream. However, setting autocloseBody to true when includeBody is false it will schedule to close the S3Object stream automatically on exchange completion."},"includeFolders":{"index":21,"kind":"parameter","displayName":"Include Folders","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those"},"maxConnections":{"index":22,"kind":"parameter","displayName":"Max Connections","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60,"description":"Set the maxConnections parameter in the S3 client configuration"},"maxMessagesPerPoll":{"index":23,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"description":"Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited."},"moveAfterRead":{"index":24,"kind":"parameter","displayName":"Move After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Move objects from S3 bucket to a different bucket after they have been retrieved. To accomplish the operation, the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved."},"sendEmptyMessageWhenIdle":{"index":25,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"autocloseBody":{"index":26,"kind":"parameter","displayName":"Autoclose Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If this option is true and includeBody is false, then the S3Object.close() method will be called on exchange completion. This option is strongly related to includeBody option. In case of setting includeBody to false and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically."},"bridgeErrorHandler":{"index":27,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":28,"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":{"index":29,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"inProgressRepository":{"index":30,"kind":"parameter","displayName":"In Progress Repository","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."},"pollStrategy":{"index":31,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"batchMessageNumber":{"index":32,"kind":"parameter","displayName":"Batch Message Number","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The number of messages composing a batch in streaming upload mode"},"batchSize":{"index":33,"kind":"parameter","displayName":"Batch Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000000,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The batch size (in bytes) in streaming upload mode"},"bufferSize":{"index":34,"kind":"parameter","displayName":"Buffer Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000000,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The buffer size (in bytes) in streaming upload mode"},"deleteAfterWrite":{"index":35,"kind":"parameter","displayName":"Delete After Write","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Delete file object after the S3 file has been uploaded"},"keyName":{"index":36,"kind":"parameter","displayName":"Key Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Setting the key name for an element in the bucket through endpoint parameter"},"multiPartUpload":{"index":37,"kind":"parameter","displayName":"Multi Part Upload","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If it is true, camel will upload the file with multipart format. The part size is decided by the partSize option. Camel will only do multipart uploads for files that are larger than the part-size thresholds. Files that are smaller will be uploaded in a single operation."},"namingStrategy":{"index":38,"kind":"parameter","displayName":"Naming Strategy","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.s3.stream.AWSS3NamingStrategyEnum","enum":["progressive","random"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"progressive","configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The naming strategy to use in streaming upload mode"},"operation":{"index":39,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.s3.AWS2S3Operations","enum":["copyObject","listObjects","deleteObject","deleteBucket","listBuckets","getObject","getObjectRange","createDownloadLink"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The operation to do in case the user don't want to do only an upload"},"partSize":{"index":40,"kind":"parameter","displayName":"Part Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":26214400,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Set up the partSize which is used in multipart upload, the default size is 25M. Camel will only do multipart uploads for files that are larger than the part-size thresholds. Files that are smaller will be uploaded in a single operation."},"restartingPolicy":{"index":41,"kind":"parameter","displayName":"Restarting Policy","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.s3.stream.AWSS3RestartingPolicyEnum","enum":["override","lastPart"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"override","configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The restarting policy to use in streaming upload mode"},"storageClass":{"index":42,"kind":"parameter","displayName":"Storage Class","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request."},"streamingUploadMode":{"index":43,"kind":"parameter","displayName":"Streaming Upload Mode","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"When stream mode is true, the upload to bucket will be done in streaming"},"streamingUploadTimeout":{"index":44,"kind":"parameter","displayName":"Streaming Upload Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"While streaming upload mode is true, this option set the timeout to complete upload"},"awsKMSKeyId":{"index":45,"kind":"parameter","displayName":"Aws KMSKey Id","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define the id of KMS key to use in case KMS is enabled"},"lazyStartProducer":{"index":46,"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."},"useAwsKMS":{"index":47,"kind":"parameter","displayName":"Use Aws KMS","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define if KMS must be used or not"},"useCustomerKey":{"index":48,"kind":"parameter","displayName":"Use Customer Key","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define if Customer Key must be used or not"},"useSSES3":{"index":49,"kind":"parameter","displayName":"Use SSES3","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Define if SSE S3 must be used or not"},"amazonS3Client":{"index":50,"kind":"parameter","displayName":"Amazon S3 Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.s3.S3Client","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Reference to a com.amazonaws.services.s3.AmazonS3 in the registry."},"amazonS3Presigner":{"index":51,"kind":"parameter","displayName":"Amazon S3 Presigner","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.s3.presigner.S3Presigner","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"An S3 Presigner for Request, used mainly in createDownloadLink operation"},"proxyHost":{"index":52,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the SQS client"},"proxyPort":{"index":53,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Specify a proxy port to be used inside the client definition."},"proxyProtocol":{"index":54,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the S3 client"},"backoffErrorThreshold":{"index":55,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":56,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":57,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":58,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":59,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":60,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":61,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":62,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":63,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":64,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":65,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":66,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":67,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":68,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":69,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":70,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":71,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":72,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":73,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":74,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Set whether the S3 client should expect to load credentials through a default credentials provider."},"useProfileCredentialsProvider":{"index":75,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Set whether the S3 client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":76,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.s3.AWS2S3Configuration","configurationField":"configuration","description":"Set whether the S3 client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in S3."}}} , -{"component":{"kind":"component","name":"aws2-ses","title":"AWS Simple Email Service (SES)","description":"Send e-mails through AWS SES service.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,mail","javaType":"org.apache.camel.component.aws2.ses.Ses2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-ses","version":"4.8.1","scheme":"aws2-ses","extendsScheme":"","syntax":"aws2-ses:from","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsSesFrom":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sender's email address.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#FROM"},"CamelAwsSesMessageId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SES message ID.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#MESSAGE_ID"},"CamelAwsSesReplyToAddresses":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The reply-to email address(es) for the message. Use comma to separate multiple values.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#REPLY_TO_ADDRESSES"},"CamelAwsSesReturnPath":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The email address to which bounce notifications are to be forwarded.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#RETURN_PATH"},"CamelAwsSesSubject":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The subject of the message.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#SUBJECT"},"CamelAwsSesTo":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of comma separated destination email address.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#TO"},"CamelAwsSesCc":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of comma separated destination carbon copy (cc) email address.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#CC"},"CamelAwsSesBcc":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of comma separated destination blind carbon copy (bcc) email address.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#BCC"},"CamelAwsSesHtmlEmail":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag to show if email content is HTML.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#HTML_EMAIL"},"CamelAwsSesConfigurationSet":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"TThe configuration set to send.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#CONFIGURATION_SET"}},"properties":{"from":{"index":0,"kind":"path","displayName":"From","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"The sender's email address."},"bcc":{"index":1,"kind":"parameter","displayName":"Bcc","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"List of comma-separated destination blind carbon copy (bcc) email address. Can be overridden with 'CamelAwsSesBcc' header."},"cc":{"index":2,"kind":"parameter","displayName":"Cc","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"List of comma-separated destination carbon copy (cc) email address. Can be overridden with 'CamelAwsSesCc' header."},"configurationSet":{"index":3,"kind":"parameter","displayName":"Configuration Set","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set the configuration set to send with every request. Override it with 'CamelAwsSesConfigurationSet' header."},"overrideEndpoint":{"index":4,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"The region in which SES client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"replyToAddresses":{"index":6,"kind":"parameter","displayName":"Reply To Addresses","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"List of comma separated reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header."},"returnPath":{"index":7,"kind":"parameter","displayName":"Return Path","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header."},"subject":{"index":8,"kind":"parameter","displayName":"Subject","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"The subject which is used if the message header 'CamelAwsSesSubject' is not present."},"to":{"index":9,"kind":"parameter","displayName":"To","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"List of comma separated destination email address. Can be overridden with 'CamelAwsSesTo' header."},"uriEndpointOverride":{"index":10,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":11,"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."},"amazonSESClient":{"index":12,"kind":"parameter","displayName":"Amazon SESClient","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.ses.SesClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"To use the AmazonSimpleEmailService as the client"},"proxyHost":{"index":13,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the SES client"},"proxyPort":{"index":14,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the SES client"},"proxyProtocol":{"index":15,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the SES client"},"accessKey":{"index":16,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":17,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":18,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":19,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":20,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":21,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set whether the Ses client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":22,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set whether the SES client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":23,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set whether the SES client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in SES."}}} +{"component":{"kind":"component","name":"aws2-ses","title":"AWS Simple Email Service (SES)","description":"Send e-mails through AWS SES service.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,mail","javaType":"org.apache.camel.component.aws2.ses.Ses2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-ses","version":"4.8.2","scheme":"aws2-ses","extendsScheme":"","syntax":"aws2-ses:from","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsSesFrom":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sender's email address.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#FROM"},"CamelAwsSesMessageId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SES message ID.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#MESSAGE_ID"},"CamelAwsSesReplyToAddresses":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The reply-to email address(es) for the message. Use comma to separate multiple values.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#REPLY_TO_ADDRESSES"},"CamelAwsSesReturnPath":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The email address to which bounce notifications are to be forwarded.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#RETURN_PATH"},"CamelAwsSesSubject":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The subject of the message.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#SUBJECT"},"CamelAwsSesTo":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of comma separated destination email address.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#TO"},"CamelAwsSesCc":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of comma separated destination carbon copy (cc) email address.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#CC"},"CamelAwsSesBcc":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of comma separated destination blind carbon copy (bcc) email address.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#BCC"},"CamelAwsSesHtmlEmail":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag to show if email content is HTML.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#HTML_EMAIL"},"CamelAwsSesConfigurationSet":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"TThe configuration set to send.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#CONFIGURATION_SET"}},"properties":{"from":{"index":0,"kind":"path","displayName":"From","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"The sender's email address."},"bcc":{"index":1,"kind":"parameter","displayName":"Bcc","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"List of comma-separated destination blind carbon copy (bcc) email address. Can be overridden with 'CamelAwsSesBcc' header."},"cc":{"index":2,"kind":"parameter","displayName":"Cc","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"List of comma-separated destination carbon copy (cc) email address. Can be overridden with 'CamelAwsSesCc' header."},"configurationSet":{"index":3,"kind":"parameter","displayName":"Configuration Set","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set the configuration set to send with every request. Override it with 'CamelAwsSesConfigurationSet' header."},"overrideEndpoint":{"index":4,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"The region in which SES client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"replyToAddresses":{"index":6,"kind":"parameter","displayName":"Reply To Addresses","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"List of comma separated reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header."},"returnPath":{"index":7,"kind":"parameter","displayName":"Return Path","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header."},"subject":{"index":8,"kind":"parameter","displayName":"Subject","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"The subject which is used if the message header 'CamelAwsSesSubject' is not present."},"to":{"index":9,"kind":"parameter","displayName":"To","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"List of comma separated destination email address. Can be overridden with 'CamelAwsSesTo' header."},"uriEndpointOverride":{"index":10,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":11,"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."},"amazonSESClient":{"index":12,"kind":"parameter","displayName":"Amazon SESClient","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.ses.SesClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"To use the AmazonSimpleEmailService as the client"},"proxyHost":{"index":13,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the SES client"},"proxyPort":{"index":14,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the SES client"},"proxyProtocol":{"index":15,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the SES client"},"accessKey":{"index":16,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":17,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":18,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":19,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":20,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":21,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set whether the Ses client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":22,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set whether the SES client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":23,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set whether the SES client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in SES."}}} , -{"component":{"kind":"component","name":"aws2-sns","title":"AWS Simple Notification System (SNS)","description":"Send messages to AWS Simple Notification Topic.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,messaging,mobile","javaType":"org.apache.camel.component.aws2.sns.Sns2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-sns","version":"4.8.1","scheme":"aws2-sns","extendsScheme":"","syntax":"aws2-sns:topicNameOrArn","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsSnsMessageId":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SNS message ID.","constantName":"org.apache.camel.component.aws2.sns.Sns2Constants#MESSAGE_ID"},"CamelAwsSnsSubject":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SNS message subject. If not set, the subject from the SnsConfiguration is used.","constantName":"org.apache.camel.component.aws2.sns.Sns2Constants#SUBJECT"},"CamelAwsSnsMessageStructure":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message structure to use such as json.","constantName":"org.apache.camel.component.aws2.sns.Sns2Constants#MESSAGE_STRUCTURE"}},"properties":{"topicNameOrArn":{"index":0,"kind":"path","displayName":"Topic Name Or Arn","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Topic name or ARN"},"autoCreateTopic":{"index":1,"kind":"parameter","displayName":"Auto Create Topic","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Setting the auto-creation of the topic"},"headerFilterStrategy":{"index":2,"kind":"parameter","displayName":"Header Filter Strategy","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to map headers to/from Camel."},"kmsMasterKeyId":{"index":3,"kind":"parameter","displayName":"Kms Master Key Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK."},"messageDeduplicationIdStrategy":{"index":4,"kind":"parameter","displayName":"Message Deduplication Id Strategy","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["useExchangeId","useContentBasedDeduplication"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"useExchangeId","configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Only for FIFO Topic. Strategy for setting the messageDeduplicationId on the message. It can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message."},"messageGroupIdStrategy":{"index":5,"kind":"parameter","displayName":"Message Group Id Strategy","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["useConstant","useExchangeId","usePropertyValue"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Only for FIFO Topic. Strategy for setting the messageGroupId on the message. It can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsSnsMessageGroupId will be used."},"messageStructure":{"index":6,"kind":"parameter","displayName":"Message Structure","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The message structure to use such as json"},"overrideEndpoint":{"index":7,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"policy":{"index":8,"kind":"parameter","displayName":"Policy","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The policy for this topic. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"queueArn":{"index":9,"kind":"parameter","displayName":"Queue Arn","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The ARN endpoint to subscribe to"},"region":{"index":10,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The region in which the SNS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"serverSideEncryptionEnabled":{"index":11,"kind":"parameter","displayName":"Server Side Encryption Enabled","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Define if Server Side Encryption is enabled or not on the topic"},"subject":{"index":12,"kind":"parameter","displayName":"Subject","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The subject which is used if the message header 'CamelAwsSnsSubject' is not present."},"subscribeSNStoSQS":{"index":13,"kind":"parameter","displayName":"Subscribe SNSto SQS","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Define if the subscription between SNS Topic and SQS must be done or not"},"uriEndpointOverride":{"index":14,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":15,"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."},"amazonSNSClient":{"index":16,"kind":"parameter","displayName":"Amazon SNSClient","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.sns.SnsClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"To use the AmazonSNS as the client"},"proxyHost":{"index":17,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the SNS client"},"proxyPort":{"index":18,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the SNS client"},"proxyProtocol":{"index":19,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the SNS client"},"accessKey":{"index":20,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":21,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":22,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":23,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":24,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":25,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Set whether the SNS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":26,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Set whether the SNS client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":27,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Set whether the SNS client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in SNS."}}} +{"component":{"kind":"component","name":"aws2-sns","title":"AWS Simple Notification System (SNS)","description":"Send messages to AWS Simple Notification Topic.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,messaging,mobile","javaType":"org.apache.camel.component.aws2.sns.Sns2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-sns","version":"4.8.2","scheme":"aws2-sns","extendsScheme":"","syntax":"aws2-sns:topicNameOrArn","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsSnsMessageId":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SNS message ID.","constantName":"org.apache.camel.component.aws2.sns.Sns2Constants#MESSAGE_ID"},"CamelAwsSnsSubject":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SNS message subject. If not set, the subject from the SnsConfiguration is used.","constantName":"org.apache.camel.component.aws2.sns.Sns2Constants#SUBJECT"},"CamelAwsSnsMessageStructure":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message structure to use such as json.","constantName":"org.apache.camel.component.aws2.sns.Sns2Constants#MESSAGE_STRUCTURE"}},"properties":{"topicNameOrArn":{"index":0,"kind":"path","displayName":"Topic Name Or Arn","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Topic name or ARN"},"autoCreateTopic":{"index":1,"kind":"parameter","displayName":"Auto Create Topic","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Setting the auto-creation of the topic"},"headerFilterStrategy":{"index":2,"kind":"parameter","displayName":"Header Filter Strategy","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to map headers to/from Camel."},"kmsMasterKeyId":{"index":3,"kind":"parameter","displayName":"Kms Master Key Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK."},"messageDeduplicationIdStrategy":{"index":4,"kind":"parameter","displayName":"Message Deduplication Id Strategy","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["useExchangeId","useContentBasedDeduplication"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"useExchangeId","configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Only for FIFO Topic. Strategy for setting the messageDeduplicationId on the message. It can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message."},"messageGroupIdStrategy":{"index":5,"kind":"parameter","displayName":"Message Group Id Strategy","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["useConstant","useExchangeId","usePropertyValue"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Only for FIFO Topic. Strategy for setting the messageGroupId on the message. It can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsSnsMessageGroupId will be used."},"messageStructure":{"index":6,"kind":"parameter","displayName":"Message Structure","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The message structure to use such as json"},"overrideEndpoint":{"index":7,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"policy":{"index":8,"kind":"parameter","displayName":"Policy","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The policy for this topic. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"queueArn":{"index":9,"kind":"parameter","displayName":"Queue Arn","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The ARN endpoint to subscribe to"},"region":{"index":10,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The region in which the SNS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"serverSideEncryptionEnabled":{"index":11,"kind":"parameter","displayName":"Server Side Encryption Enabled","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Define if Server Side Encryption is enabled or not on the topic"},"subject":{"index":12,"kind":"parameter","displayName":"Subject","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"The subject which is used if the message header 'CamelAwsSnsSubject' is not present."},"subscribeSNStoSQS":{"index":13,"kind":"parameter","displayName":"Subscribe SNSto SQS","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Define if the subscription between SNS Topic and SQS must be done or not"},"uriEndpointOverride":{"index":14,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":15,"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."},"amazonSNSClient":{"index":16,"kind":"parameter","displayName":"Amazon SNSClient","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.sns.SnsClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"To use the AmazonSNS as the client"},"proxyHost":{"index":17,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the SNS client"},"proxyPort":{"index":18,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the SNS client"},"proxyProtocol":{"index":19,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the SNS client"},"accessKey":{"index":20,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":21,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":22,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":23,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":24,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":25,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Set whether the SNS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":26,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Set whether the SNS client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":27,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sns.Sns2Configuration","configurationField":"configuration","description":"Set whether the SNS client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in SNS."}}} , -{"component":{"kind":"component","name":"aws2-sqs","title":"AWS Simple Queue Service (SQS)","description":"Send and receive messages to/from AWS SQS.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,messaging","javaType":"org.apache.camel.component.aws2.sqs.Sqs2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-sqs","version":"4.8.1","scheme":"aws2-sqs","extendsScheme":"","syntax":"aws2-sqs:queueNameOrArn","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAwsSqsAttributes":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A map of the attributes requested in ReceiveMessage to their respective values.","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#ATTRIBUTES"},"CamelAwsSqsMessageAttributes":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SQS message attributes.","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#MESSAGE_ATTRIBUTES"},"CamelAwsSqsMD5OfBody":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The MD5 checksum of the Amazon SQS message.","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#MD5_OF_BODY"},"CamelAwsSqsMessageId":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SQS message ID.","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#MESSAGE_ID"},"CamelAwsSqsReceiptHandle":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SQS message receipt handle.","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#RECEIPT_HANDLE"},"CamelAwsSqsDelaySeconds":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The delay seconds that the Amazon SQS message can be see by others.","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#DELAY_HEADER"},"CamelAwsSqsPrefix":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A string to use for filtering the list results.","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#SQS_QUEUE_PREFIX"},"CamelAwsSqsOperation":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#SQS_OPERATION"}},"properties":{"queueNameOrArn":{"index":0,"kind":"path","displayName":"Queue Name Or Arn","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Queue name or ARN"},"amazonAWSHost":{"index":1,"kind":"parameter","displayName":"Amazon AWSHost","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"amazonaws.com","configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The hostname of the Amazon AWS cloud."},"autoCreateQueue":{"index":2,"kind":"parameter","displayName":"Auto Create Queue","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Setting the auto-creation of the queue"},"headerFilterStrategy":{"index":3,"kind":"parameter","displayName":"Header Filter Strategy","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to map headers to/from Camel."},"overrideEndpoint":{"index":4,"kind":"parameter","displayName":"Override Endpoint","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"protocol":{"index":5,"kind":"parameter","displayName":"Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https","configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The underlying protocol used to communicate with SQS"},"queueOwnerAWSAccountId":{"index":6,"kind":"parameter","displayName":"Queue Owner AWSAccount Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Specify the queue owner aws account id when you need to connect the queue with a different account owner."},"region":{"index":7,"kind":"parameter","displayName":"Region","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The region in which SQS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":8,"kind":"parameter","displayName":"Uri Endpoint Override","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"attributeNames":{"index":9,"kind":"parameter","displayName":"Attribute Names","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"A list of attribute names to receive when consuming. Multiple names can be separated by comma."},"concurrentConsumers":{"index":10,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Allows you to use multiple threads to poll the sqs queue to increase throughput"},"concurrentRequestLimit":{"index":11,"kind":"parameter","displayName":"Concurrent Request Limit","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":50,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The maximum number of concurrent receive request send to AWS in single consumer polling."},"defaultVisibilityTimeout":{"index":12,"kind":"parameter","displayName":"Default Visibility Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The default visibility timeout (in seconds)"},"deleteAfterRead":{"index":13,"kind":"parameter","displayName":"Delete After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Delete message from SQS after it has been read"},"deleteIfFiltered":{"index":14,"kind":"parameter","displayName":"Delete If Filtered","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Whether to send the DeleteMessage to the SQS queue if the exchange has property with key Sqs2Constants#SQS_DELETE_FILTERED (CamelAwsSqsDeleteFiltered) set to true."},"extendMessageVisibility":{"index":15,"kind":"parameter","displayName":"Extend Message Visibility","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"If enabled, then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs."},"kmsDataKeyReusePeriodSeconds":{"index":16,"kind":"parameter","displayName":"Kms Data Key Reuse Period Seconds","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes)."},"kmsMasterKeyId":{"index":17,"kind":"parameter","displayName":"Kms Master Key Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK."},"maxMessagesPerPoll":{"index":18,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited."},"messageAttributeNames":{"index":19,"kind":"parameter","displayName":"Message Attribute Names","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"A list of message attribute names to receive when consuming. Multiple names can be separated by comma."},"sendEmptyMessageWhenIdle":{"index":20,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"serverSideEncryptionEnabled":{"index":21,"kind":"parameter","displayName":"Server Side Encryption Enabled","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Define if Server Side Encryption is enabled or not on the queue"},"sortAttributeName":{"index":22,"kind":"parameter","displayName":"Sort Attribute Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The name of the message attribute used for sorting the messages. When specified, the messages polled by the consumer will be sorted by this attribute. This configuration may be of importance when you configure maxMessagesPerPoll parameter exceeding 10. In such cases, the messages will be fetched concurrently so the ordering is not guaranteed."},"visibilityTimeout":{"index":23,"kind":"parameter","displayName":"Visibility Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only makes sense if it's different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently."},"waitTimeSeconds":{"index":24,"kind":"parameter","displayName":"Wait Time Seconds","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response."},"bridgeErrorHandler":{"index":25,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":26,"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":{"index":27,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":28,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"batchSeparator":{"index":29,"kind":"parameter","displayName":"Batch Separator","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":",","configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Set the separator when passing a String to send batch message operation"},"delaySeconds":{"index":30,"kind":"parameter","displayName":"Delay Seconds","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Delay sending messages for a number of seconds."},"messageDeduplicationIdStrategy":{"index":31,"kind":"parameter","displayName":"Message Deduplication Id Strategy","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["useExchangeId","useContentBasedDeduplication"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"useExchangeId","configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. It can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message."},"messageGroupIdStrategy":{"index":32,"kind":"parameter","displayName":"Message Group Id Strategy","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["useConstant","useExchangeId","usePropertyValue"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Only for FIFO queues. Strategy for setting the messageGroupId on the message. It can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used."},"messageHeaderExceededLimit":{"index":33,"kind":"parameter","displayName":"Message Header Exceeded Limit","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["WARN","WARN_ONCE","IGNORE","FAIL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"What to do if sending to AWS SQS has more messages than AWS allows (currently only maximum 10 message headers are allowed). WARN will log a WARN about the limit is for each additional header, so the message can be sent to AWS. WARN_ONCE will only log one time a WARN about the limit is hit, and drop additional headers, so the message can be sent to AWS. IGNORE will ignore (no logging) and drop additional headers, so the message can be sent to AWS. FAIL will cause an exception to be thrown and the message is not sent to AWS."},"operation":{"index":34,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.sqs.Sqs2Operations","enum":["sendBatchMessage","deleteMessage","listQueues","purgeQueue","deleteQueue"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The operation to do in case the user don't want to send only a message"},"lazyStartProducer":{"index":35,"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."},"amazonSQSClient":{"index":36,"kind":"parameter","displayName":"Amazon SQSClient","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.sqs.SqsClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"To use the AmazonSQS client"},"delayQueue":{"index":37,"kind":"parameter","displayName":"Delay Queue","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Define if you want to apply delaySeconds option to the queue or on single messages"},"proxyHost":{"index":38,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the SQS client"},"proxyPort":{"index":39,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the SQS client"},"proxyProtocol":{"index":40,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the SQS client"},"maximumMessageSize":{"index":41,"kind":"parameter","displayName":"Maximum Message Size","group":"queue","label":"queue","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The maximumMessageSize (in bytes) an SQS message can contain for this queue."},"messageRetentionPeriod":{"index":42,"kind":"parameter","displayName":"Message Retention Period","group":"queue","label":"queue","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue."},"policy":{"index":43,"kind":"parameter","displayName":"Policy","group":"queue","label":"queue","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The policy for this queue. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"queueUrl":{"index":44,"kind":"parameter","displayName":"Queue Url","group":"queue","label":"queue","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used to connect to a mock implementation of SQS, for testing purposes."},"receiveMessageWaitTimeSeconds":{"index":45,"kind":"parameter","displayName":"Receive Message Wait Time Seconds","group":"queue","label":"queue","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait."},"redrivePolicy":{"index":46,"kind":"parameter","displayName":"Redrive Policy","group":"queue","label":"queue","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Specify the policy that send message to DeadLetter queue. See detail at Amazon docs."},"backoffErrorThreshold":{"index":47,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":48,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":49,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":50,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":51,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":52,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":53,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":54,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":55,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":56,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":57,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":58,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":59,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":60,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":61,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":62,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":63,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":64,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":65,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":66,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Set whether the SQS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":67,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Set whether the SQS client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":68,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Set whether the SQS client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in SQS."}}} +{"component":{"kind":"component","name":"aws2-sqs","title":"AWS Simple Queue Service (SQS)","description":"Send and receive messages to/from AWS SQS.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,messaging","javaType":"org.apache.camel.component.aws2.sqs.Sqs2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-sqs","version":"4.8.2","scheme":"aws2-sqs","extendsScheme":"","syntax":"aws2-sqs:queueNameOrArn","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAwsSqsAttributes":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A map of the attributes requested in ReceiveMessage to their respective values.","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#ATTRIBUTES"},"CamelAwsSqsMessageAttributes":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SQS message attributes.","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#MESSAGE_ATTRIBUTES"},"CamelAwsSqsMD5OfBody":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The MD5 checksum of the Amazon SQS message.","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#MD5_OF_BODY"},"CamelAwsSqsMessageId":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SQS message ID.","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#MESSAGE_ID"},"CamelAwsSqsReceiptHandle":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SQS message receipt handle.","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#RECEIPT_HANDLE"},"CamelAwsSqsDelaySeconds":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The delay seconds that the Amazon SQS message can be see by others.","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#DELAY_HEADER"},"CamelAwsSqsPrefix":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A string to use for filtering the list results.","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#SQS_QUEUE_PREFIX"},"CamelAwsSqsOperation":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.sqs.Sqs2Constants#SQS_OPERATION"}},"properties":{"queueNameOrArn":{"index":0,"kind":"path","displayName":"Queue Name Or Arn","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Queue name or ARN"},"amazonAWSHost":{"index":1,"kind":"parameter","displayName":"Amazon AWSHost","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"amazonaws.com","configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The hostname of the Amazon AWS cloud."},"autoCreateQueue":{"index":2,"kind":"parameter","displayName":"Auto Create Queue","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Setting the auto-creation of the queue"},"headerFilterStrategy":{"index":3,"kind":"parameter","displayName":"Header Filter Strategy","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to map headers to/from Camel."},"overrideEndpoint":{"index":4,"kind":"parameter","displayName":"Override Endpoint","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"protocol":{"index":5,"kind":"parameter","displayName":"Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https","configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The underlying protocol used to communicate with SQS"},"queueOwnerAWSAccountId":{"index":6,"kind":"parameter","displayName":"Queue Owner AWSAccount Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Specify the queue owner aws account id when you need to connect the queue with a different account owner."},"region":{"index":7,"kind":"parameter","displayName":"Region","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The region in which SQS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":8,"kind":"parameter","displayName":"Uri Endpoint Override","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"attributeNames":{"index":9,"kind":"parameter","displayName":"Attribute Names","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"A list of attribute names to receive when consuming. Multiple names can be separated by comma."},"concurrentConsumers":{"index":10,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Allows you to use multiple threads to poll the sqs queue to increase throughput"},"concurrentRequestLimit":{"index":11,"kind":"parameter","displayName":"Concurrent Request Limit","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":50,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The maximum number of concurrent receive request send to AWS in single consumer polling."},"defaultVisibilityTimeout":{"index":12,"kind":"parameter","displayName":"Default Visibility Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The default visibility timeout (in seconds)"},"deleteAfterRead":{"index":13,"kind":"parameter","displayName":"Delete After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Delete message from SQS after it has been read"},"deleteIfFiltered":{"index":14,"kind":"parameter","displayName":"Delete If Filtered","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Whether to send the DeleteMessage to the SQS queue if the exchange has property with key Sqs2Constants#SQS_DELETE_FILTERED (CamelAwsSqsDeleteFiltered) set to true."},"extendMessageVisibility":{"index":15,"kind":"parameter","displayName":"Extend Message Visibility","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"If enabled, then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs."},"kmsDataKeyReusePeriodSeconds":{"index":16,"kind":"parameter","displayName":"Kms Data Key Reuse Period Seconds","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes)."},"kmsMasterKeyId":{"index":17,"kind":"parameter","displayName":"Kms Master Key Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK."},"maxMessagesPerPoll":{"index":18,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited."},"messageAttributeNames":{"index":19,"kind":"parameter","displayName":"Message Attribute Names","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"A list of message attribute names to receive when consuming. Multiple names can be separated by comma."},"sendEmptyMessageWhenIdle":{"index":20,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"serverSideEncryptionEnabled":{"index":21,"kind":"parameter","displayName":"Server Side Encryption Enabled","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Define if Server Side Encryption is enabled or not on the queue"},"sortAttributeName":{"index":22,"kind":"parameter","displayName":"Sort Attribute Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The name of the message attribute used for sorting the messages. When specified, the messages polled by the consumer will be sorted by this attribute. This configuration may be of importance when you configure maxMessagesPerPoll parameter exceeding 10. In such cases, the messages will be fetched concurrently so the ordering is not guaranteed."},"visibilityTimeout":{"index":23,"kind":"parameter","displayName":"Visibility Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only makes sense if it's different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently."},"waitTimeSeconds":{"index":24,"kind":"parameter","displayName":"Wait Time Seconds","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response."},"bridgeErrorHandler":{"index":25,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":26,"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":{"index":27,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":28,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"batchSeparator":{"index":29,"kind":"parameter","displayName":"Batch Separator","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":",","configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Set the separator when passing a String to send batch message operation"},"delaySeconds":{"index":30,"kind":"parameter","displayName":"Delay Seconds","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Delay sending messages for a number of seconds."},"messageDeduplicationIdStrategy":{"index":31,"kind":"parameter","displayName":"Message Deduplication Id Strategy","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["useExchangeId","useContentBasedDeduplication"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"useExchangeId","configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. It can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message."},"messageGroupIdStrategy":{"index":32,"kind":"parameter","displayName":"Message Group Id Strategy","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["useConstant","useExchangeId","usePropertyValue"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Only for FIFO queues. Strategy for setting the messageGroupId on the message. It can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used."},"messageHeaderExceededLimit":{"index":33,"kind":"parameter","displayName":"Message Header Exceeded Limit","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["WARN","WARN_ONCE","IGNORE","FAIL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"What to do if sending to AWS SQS has more messages than AWS allows (currently only maximum 10 message headers are allowed). WARN will log a WARN about the limit is for each additional header, so the message can be sent to AWS. WARN_ONCE will only log one time a WARN about the limit is hit, and drop additional headers, so the message can be sent to AWS. IGNORE will ignore (no logging) and drop additional headers, so the message can be sent to AWS. FAIL will cause an exception to be thrown and the message is not sent to AWS."},"operation":{"index":34,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.sqs.Sqs2Operations","enum":["sendBatchMessage","deleteMessage","listQueues","purgeQueue","deleteQueue"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The operation to do in case the user don't want to send only a message"},"lazyStartProducer":{"index":35,"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."},"amazonSQSClient":{"index":36,"kind":"parameter","displayName":"Amazon SQSClient","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.sqs.SqsClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"To use the AmazonSQS client"},"delayQueue":{"index":37,"kind":"parameter","displayName":"Delay Queue","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Define if you want to apply delaySeconds option to the queue or on single messages"},"proxyHost":{"index":38,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the SQS client"},"proxyPort":{"index":39,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the SQS client"},"proxyProtocol":{"index":40,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the SQS client"},"maximumMessageSize":{"index":41,"kind":"parameter","displayName":"Maximum Message Size","group":"queue","label":"queue","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The maximumMessageSize (in bytes) an SQS message can contain for this queue."},"messageRetentionPeriod":{"index":42,"kind":"parameter","displayName":"Message Retention Period","group":"queue","label":"queue","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue."},"policy":{"index":43,"kind":"parameter","displayName":"Policy","group":"queue","label":"queue","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"The policy for this queue. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"queueUrl":{"index":44,"kind":"parameter","displayName":"Queue Url","group":"queue","label":"queue","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used to connect to a mock implementation of SQS, for testing purposes."},"receiveMessageWaitTimeSeconds":{"index":45,"kind":"parameter","displayName":"Receive Message Wait Time Seconds","group":"queue","label":"queue","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait."},"redrivePolicy":{"index":46,"kind":"parameter","displayName":"Redrive Policy","group":"queue","label":"queue","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Specify the policy that send message to DeadLetter queue. See detail at Amazon docs."},"backoffErrorThreshold":{"index":47,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":48,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":49,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":50,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":51,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":52,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":53,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":54,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":55,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":56,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":57,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":58,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":59,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":60,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":61,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":62,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":63,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":64,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":65,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":66,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Set whether the SQS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":67,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Set whether the SQS client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":68,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sqs.Sqs2Configuration","configurationField":"configuration","description":"Set whether the SQS client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in SQS."}}} , -{"component":{"kind":"component","name":"aws2-step-functions","title":"AWS StepFunctions","description":"Manage and invoke AWS Step functions.","deprecated":false,"firstVersion":"4.0.0","label":"cloud,serverless","javaType":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-step-functions","version":"4.8.1","scheme":"aws2-step-functions","extendsScheme":"","syntax":"aws2-step-functions:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsStepFunctionsOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#OPERATION"},"CamelAwsStepFunctionsStateMachineName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the state machine","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#STATE_MACHINE_NAME"},"CamelAwsStepFunctionsStateMachineDefinition":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon States Language definition of the state machine","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#STATE_MACHINE_DEFINITION"},"CamelAwsStepFunctionsStateMachineType":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Determines whether a Standard or Express state machine is created","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#STATE_MACHINE_TYPE"},"CamelAwsStepFunctionsStateMachineRoleArn":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the IAM role to use for this state machine.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#STATE_MACHINE_ROLE_ARN"},"CamelAwsStepFunctionsStateMachineArn":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of state machine.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#STATE_MACHINE_ARN"},"CamelAwsStepFunctionsStateMachinesMaxResults":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit number of results while listing state machines","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#STATE_MACHINES_MAX_RESULTS"},"CamelAwsStepFunctionsActivityName":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the state machine activity","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#ACTIVITY_NAME"},"CamelAwsStepFunctionsActivityArn":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ARN of the state machine activity","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#ACTIVITY_ARN"},"CamelAwsStepFunctionsActivitiesMaxResults":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit number of results while listing state machines","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#ACTIVITIES_MAX_RESULTS"},"CamelAwsStepFunctionsExecutionArn":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the execution.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTION_ARN"},"CamelAwsStepFunctionsExecutionName":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Optional name of the execution.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTION_NAME"},"CamelAwsStepFunctionsExecutionInput":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The string that contains the JSON input data for the execution.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTION_INPUT"},"CamelAwsStepFunctionsExecutionTraceHeader":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Passes the X-Ray trace header.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTION_TRACE_HEADER"},"CamelAwsStepFunctionsExecutionHistoryMaxResults":{"index":14,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit number of results while listing execution history","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTION_HISTORY_MAX_RESULTS"},"CamelAwsStepFunctionsExecutionHistoryIncludeExecutionData":{"index":15,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"You can select whether execution data (input or output of a history event) is returned.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTION_HISTORY_INCLUDE_EXECUTION_DATA"},"CamelAwsStepFunctionsExecutionHistoryReverseOrder":{"index":16,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Lists events in descending order of their timeStamp.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTION_HISTORY_REVERSE_ORDER"},"CamelAwsStepFunctionsExecutionMaxResults":{"index":17,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit number of results while listing executions","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTIONS_MAX_RESULTS"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Operations","enum":["createStateMachine","deleteStateMachine","updateStateMachine","describeStateMachine","listStateMachines","createActivity","deleteActivity","describeActivity","getActivityTask","listActivities","startExecution","startSyncExecution","stopExecution","describeExecution","listExecutions","getExecutionHistory"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"The operation to perform. It can be listFunctions, getFunction, createFunction, deleteFunction or invokeFunction"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":4,"kind":"parameter","displayName":"Profile Credentials Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"The region in which StepFunctions client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"trustAllCertificates":{"index":6,"kind":"parameter","displayName":"Trust All Certificates","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"uriEndpointOverride":{"index":7,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"index":8,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Set whether the StepFunctions client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":9,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Set whether the StepFunctions client should expect to load credentials through a profile credentials provider."},"lazyStartProducer":{"index":10,"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."},"awsSfnClient":{"index":11,"kind":"parameter","displayName":"Aws Sfn Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.sfn.SfnClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"To use an existing configured AwsStepFunctionsClient client"},"proxyHost":{"index":12,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the StepFunctions client"},"proxyPort":{"index":13,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the StepFunctions client"},"proxyProtocol":{"index":14,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the StepFunctions client"},"accessKey":{"index":15,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":16,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":17,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Set whether the Step Functions client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Step Functions."}}} +{"component":{"kind":"component","name":"aws2-step-functions","title":"AWS StepFunctions","description":"Manage and invoke AWS Step functions.","deprecated":false,"firstVersion":"4.0.0","label":"cloud,serverless","javaType":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-step-functions","version":"4.8.2","scheme":"aws2-step-functions","extendsScheme":"","syntax":"aws2-step-functions:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsStepFunctionsOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#OPERATION"},"CamelAwsStepFunctionsStateMachineName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the state machine","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#STATE_MACHINE_NAME"},"CamelAwsStepFunctionsStateMachineDefinition":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon States Language definition of the state machine","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#STATE_MACHINE_DEFINITION"},"CamelAwsStepFunctionsStateMachineType":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Determines whether a Standard or Express state machine is created","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#STATE_MACHINE_TYPE"},"CamelAwsStepFunctionsStateMachineRoleArn":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the IAM role to use for this state machine.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#STATE_MACHINE_ROLE_ARN"},"CamelAwsStepFunctionsStateMachineArn":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of state machine.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#STATE_MACHINE_ARN"},"CamelAwsStepFunctionsStateMachinesMaxResults":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit number of results while listing state machines","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#STATE_MACHINES_MAX_RESULTS"},"CamelAwsStepFunctionsActivityName":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the state machine activity","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#ACTIVITY_NAME"},"CamelAwsStepFunctionsActivityArn":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ARN of the state machine activity","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#ACTIVITY_ARN"},"CamelAwsStepFunctionsActivitiesMaxResults":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit number of results while listing state machines","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#ACTIVITIES_MAX_RESULTS"},"CamelAwsStepFunctionsExecutionArn":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the execution.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTION_ARN"},"CamelAwsStepFunctionsExecutionName":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Optional name of the execution.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTION_NAME"},"CamelAwsStepFunctionsExecutionInput":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The string that contains the JSON input data for the execution.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTION_INPUT"},"CamelAwsStepFunctionsExecutionTraceHeader":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Passes the X-Ray trace header.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTION_TRACE_HEADER"},"CamelAwsStepFunctionsExecutionHistoryMaxResults":{"index":14,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit number of results while listing execution history","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTION_HISTORY_MAX_RESULTS"},"CamelAwsStepFunctionsExecutionHistoryIncludeExecutionData":{"index":15,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"You can select whether execution data (input or output of a history event) is returned.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTION_HISTORY_INCLUDE_EXECUTION_DATA"},"CamelAwsStepFunctionsExecutionHistoryReverseOrder":{"index":16,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Lists events in descending order of their timeStamp.","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTION_HISTORY_REVERSE_ORDER"},"CamelAwsStepFunctionsExecutionMaxResults":{"index":17,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit number of results while listing executions","constantName":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Constants#EXECUTIONS_MAX_RESULTS"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Operations","enum":["createStateMachine","deleteStateMachine","updateStateMachine","describeStateMachine","listStateMachines","createActivity","deleteActivity","describeActivity","getActivityTask","listActivities","startExecution","startSyncExecution","stopExecution","describeExecution","listExecutions","getExecutionHistory"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"The operation to perform. It can be listFunctions, getFunction, createFunction, deleteFunction or invokeFunction"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":4,"kind":"parameter","displayName":"Profile Credentials Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"The region in which StepFunctions client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"trustAllCertificates":{"index":6,"kind":"parameter","displayName":"Trust All Certificates","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"uriEndpointOverride":{"index":7,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"index":8,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Set whether the StepFunctions client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":9,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Set whether the StepFunctions client should expect to load credentials through a profile credentials provider."},"lazyStartProducer":{"index":10,"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."},"awsSfnClient":{"index":11,"kind":"parameter","displayName":"Aws Sfn Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.sfn.SfnClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"To use an existing configured AwsStepFunctionsClient client"},"proxyHost":{"index":12,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the StepFunctions client"},"proxyPort":{"index":13,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the StepFunctions client"},"proxyProtocol":{"index":14,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the StepFunctions client"},"accessKey":{"index":15,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":16,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":17,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"useSessionCredentials":{"index":18,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.stepfunctions.StepFunctions2Configuration","configurationField":"configuration","description":"Set whether the Step Functions client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Step Functions."}}} , -{"component":{"kind":"component","name":"aws2-sts","title":"AWS Security Token Service (STS)","description":"Manage AWS STS cluster instances.","deprecated":false,"firstVersion":"3.5.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.sts.STS2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-sts","version":"4.8.1","scheme":"aws2-sts","extendsScheme":"","syntax":"aws2-sts:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsStsOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.sts.STS2Constants#OPERATION"},"CamelAwsStsRoleArn":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the role to assume.","constantName":"org.apache.camel.component.aws2.sts.STS2Constants#ROLE_ARN"},"CamelAwsStsRoleSessionName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"An identifier for the assumed role session.","constantName":"org.apache.camel.component.aws2.sts.STS2Constants#ROLE_SESSION_NAME"},"CamelAwsStsFederatedName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the federated user.","constantName":"org.apache.camel.component.aws2.sts.STS2Constants#FEDERATED_NAME"},"CamelAwsStsAssumeRoleDurationSeconds":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The duration, in seconds, of the role session. It could go from 900 seconds, to 1 to 12 hours (dependent on administrator settings. The default if not specified is 3600 seconds.","constantName":"org.apache.camel.component.aws2.sts.STS2Constants#ASSUME_ROLE_DURATION_SECONDS"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.sts.STS2Operations","enum":["assumeRole","getSessionToken","getFederationToken"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"assumeRole","configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"aws-global","configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"The region in which the STS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":5,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":6,"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."},"stsClient":{"index":7,"kind":"parameter","displayName":"Sts Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.sts.StsClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"To use an existing configured AWS STS client"},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the STS client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the STS client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the STS client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"trustAllCertificates":{"index":14,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":15,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"Set whether the STS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"Set whether the STS client should expect to load credentials through a profile credentials provider."}}} +{"component":{"kind":"component","name":"aws2-sts","title":"AWS Security Token Service (STS)","description":"Manage AWS STS cluster instances.","deprecated":false,"firstVersion":"3.5.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.sts.STS2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-sts","version":"4.8.2","scheme":"aws2-sts","extendsScheme":"","syntax":"aws2-sts:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsStsOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.sts.STS2Constants#OPERATION"},"CamelAwsStsRoleArn":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the role to assume.","constantName":"org.apache.camel.component.aws2.sts.STS2Constants#ROLE_ARN"},"CamelAwsStsRoleSessionName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"An identifier for the assumed role session.","constantName":"org.apache.camel.component.aws2.sts.STS2Constants#ROLE_SESSION_NAME"},"CamelAwsStsFederatedName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the federated user.","constantName":"org.apache.camel.component.aws2.sts.STS2Constants#FEDERATED_NAME"},"CamelAwsStsAssumeRoleDurationSeconds":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The duration, in seconds, of the role session. It could go from 900 seconds, to 1 to 12 hours (dependent on administrator settings. The default if not specified is 3600 seconds.","constantName":"org.apache.camel.component.aws2.sts.STS2Constants#ASSUME_ROLE_DURATION_SECONDS"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.sts.STS2Operations","enum":["assumeRole","getSessionToken","getFederationToken"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"assumeRole","configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":2,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":4,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"aws-global","configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"The region in which the STS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"uriEndpointOverride":{"index":5,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":6,"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."},"stsClient":{"index":7,"kind":"parameter","displayName":"Sts Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.sts.StsClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"To use an existing configured AWS STS client"},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the STS client"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the STS client"},"proxyProtocol":{"index":10,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the STS client"},"accessKey":{"index":11,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":12,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":13,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"trustAllCertificates":{"index":14,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":15,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"Set whether the STS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":16,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"Set whether the STS client should expect to load credentials through a profile credentials provider."}}} , -{"component":{"kind":"component","name":"aws2-timestream","title":"AWS Timestream","description":"Write records and execute queries on AWS time-series database","deprecated":false,"firstVersion":"4.1.0","label":"cloud,database","javaType":"org.apache.camel.component.aws2.timestream.Timestream2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-timestream","version":"4.8.1","scheme":"aws2-timestream","extendsScheme":"","syntax":"aws2-timestream:clientType:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsTimestreamOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#OPERATION"},"CamelAwsTimestreamRecord":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamwrite.model.Record","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Represents a time-series data point being written into Timestream","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#RECORD"},"CamelAwsTimestreamRecordList":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of Records","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#RECORD_LIST"},"CamelAwsTimestreamTaskStatus":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Status of Batch Load Task","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#TASK_STATUS"},"CamelAwsTimestreamTaskId":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of the batch load task to resume.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#TASK_ID"},"CamelAwsTimestreamDatabaseName":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of Database","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#DATABASE_NAME"},"CamelAwsTimestreamTableName":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of Table","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#TABLE_NAME"},"CamelAwsTimestreamTargetDatabaseName":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of Target Database","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#TARGET_DATABASE_NAME"},"CamelAwsTimestreamTargetTableName":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of Target Table","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#TARGET_TABLE_NAME"},"CamelAwsTimestreamRecordVersion":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Record version","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#RECORD_VERSION"},"CamelAwsTimestreamDataModelConfiguration":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamwrite.model.DataModelConfiguration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Configuration of Data Model","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#DATA_MODEL_CONFIGURATION"},"CamelAwsTimestreamDataSourceConfiguration":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamwrite.model.DataSourceConfiguration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Configuration of Data Source","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#DATA_SOURCE_CONFIGURATION"},"CamelAwsTimestreamReportConfiguration":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamwrite.model.ReportConfiguration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reporting Configuration","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#REPORT_CONFIGURATION"},"CamelAwsTimestreamTableSchema":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamwrite.model.Schema","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestream Table Schema","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#SCHEMA"},"CamelAwsTimestreamRetentionProperties":{"index":14,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamwrite.model.RetentionProperties","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestream Table Retention Properties","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#RETENTION_PROPERTIES"},"CamelAwsTimestreamMagneticStoreWriteProperties":{"index":15,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamwrite.model.MagneticStoreWriteProperties","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestream Table Magentic Store Write properties","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#MAGNETIC_STORE_WRITE_PROPERTIES"},"CamelAwsTimestreamTimeColumn":{"index":16,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of Time column","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#TIME_COLUMN"},"CamelAwsTimestreamMeasureColumnName":{"index":17,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the measure column.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#MEASURE_NAME_COLUMN"},"CamelAwsTimestreamDimensionMappingList":{"index":18,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This is to allow mapping column(s) from the query result to the dimension in the destination table.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#DIMENSION_MAPPING_LIST"},"CamelAwsTimestreamMultiMeasureMappings":{"index":19,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamquery.model.MultiMeasureMappings","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Multi-measure mappings.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#MULTI_MEASURE_MAPPINGS"},"CamelAwsTimestreamMixedMeasureMappingList":{"index":20,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies how to map measures to multi-measure records.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#MIXED_MEASURE_MAPPING_LIST"},"CamelAwsTimestreamScheduledQueryName":{"index":21,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of scheduled query","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#SCHEDULED_QUERY_NAME"},"CamelAwsTimestreamScheduledQueryArn":{"index":22,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Arn of scheduled query","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#SCHEDULED_QUERY_ARN"},"CamelAwsTimestreamScheduledQueryState":{"index":23,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"State of scheduled query","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#SCHEDULED_QUERY_STATE"},"CamelAwsTimestreamScheduledQueryInvocationTime":{"index":24,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Instant","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Invocation Time for scheduled query execution","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#SCHEDULED_QUERY_INVOCATION_TIME"},"CamelAwsTimestreamQueryString":{"index":25,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query string to run.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#QUERY_STRING"},"CamelAwsTimestreamQueryId":{"index":26,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of query.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#QUERY_ID"},"CamelAwsTimestreamQueryValidateOnly":{"index":27,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Validates the prepared query, but does not store for later execution","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#QUERY_VALIDATE_ONLY"},"CamelAwsTimestreamQueryMaxRows":{"index":28,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The total number of rows to be returned in the Query output.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#QUERY_MAX_ROWS"},"CamelAwsTimestreamMaxResults":{"index":29,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Max Results to be returned in output","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#MAX_RESULTS"},"CamelAwsTimestreamScheduleExpression":{"index":30,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The schedule expression for the query.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#SCHEDULE_EXPRESSION"},"CamelAwsTimestreamNotificationTopicArn":{"index":31,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Notification Topic Arn for the scheduled query.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#NOTIFICATION_TOPIC_ARN"},"CamelAwsTimestreamErrorReportS3BucketName":{"index":32,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"S3 Bucket name for error reporting.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#ERROR_REPORT_S3_BUCKET_NAME"},"CamelAwsTimestreamErrorReportS3ObjectKeyPrefix":{"index":33,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"S3 object key prefix for error reporting.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#ERROR_REPORT_S3_OBJECT_KEY_PREFIX"},"CamelAwsTimestreamErrorReportS3EncryptionOption":{"index":34,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"S3 encryption option for error reporting.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#ERROR_REPORT_S3_ENCRYPTION_OPTION"},"CamelAwsTimestreamScheduledQueryExecutionRoleArn":{"index":35,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"he ARN for the IAM role that Timestream will assume when running the scheduled query.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#SCHEDULED_QUERY_EXECUTION_ROLE_ARN"},"CamelAwsTimestreamClientToken":{"index":36,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Using a ClientToken makes the call to CreateScheduledQuery idempotent","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#CLIENT_TOKEN"},"CamelAwsTimestreamKmsKeyId":{"index":37,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon KMS key used to encrypt the scheduled query resource, at-rest.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#KMS_KEY_ID"}},"properties":{"clientType":{"index":0,"kind":"path","displayName":"Client Type","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.timestream.Timestream2ClientType","enum":["write","query"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Type of client - write/query"},"label":{"index":1,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.timestream.Timestream2Operations","enum":["describeEndpoints","createBatchLoadTask","describeBatchLoadTask","resumeBatchLoadTask","listBatchLoadTasks","createDatabase","deleteDatabase","describeDatabase","updateDatabase","listDatabases","createTable","deleteTable","describeTable","updateTable","listTables","writeRecords","createScheduledQuery","deleteScheduledQuery","executeScheduledQuery","updateScheduledQuery","describeScheduledQuery","listScheduledQueries","prepareQuery","query","cancelQuery"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"The operation to perform. It can be describeEndpoints,createBatchLoadTask,describeBatchLoadTask, resumeBatchLoadTask,listBatchLoadTasks,createDatabase,deleteDatabase,describeDatabase,updateDatabase, listDatabases,createTable,deleteTable,describeTable,updateTable,listTables,writeRecords, createScheduledQuery,deleteScheduledQuery,executeScheduledQuery,updateScheduledQuery, describeScheduledQuery,listScheduledQueries,prepareQuery,query,cancelQuery"},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":5,"kind":"parameter","displayName":"Profile Credentials Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":6,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"The region in which the Timestream client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"trustAllCertificates":{"index":7,"kind":"parameter","displayName":"Trust All Certificates","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"uriEndpointOverride":{"index":8,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"index":9,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Set whether the Timestream client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":10,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Set whether the Timestream client should expect to load credentials through a profile credentials provider."},"lazyStartProducer":{"index":11,"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."},"awsTimestreamQueryClient":{"index":12,"kind":"parameter","displayName":"Aws Timestream Query Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.timestreamquery.TimestreamQueryClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"To use an existing configured AwsTimestreamQueryClient client"},"awsTimestreamWriteClient":{"index":13,"kind":"parameter","displayName":"Aws Timestream Write Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.timestreamwrite.TimestreamWriteClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"To use an existing configured AwsTimestreamWriteClient client"},"proxyHost":{"index":14,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the Timestream client"},"proxyPort":{"index":15,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the Timestream client"},"proxyProtocol":{"index":16,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Timestream client"},"accessKey":{"index":17,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":18,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"}}} +{"component":{"kind":"component","name":"aws2-timestream","title":"AWS Timestream","description":"Write records and execute queries on AWS time-series database","deprecated":false,"firstVersion":"4.1.0","label":"cloud,database","javaType":"org.apache.camel.component.aws2.timestream.Timestream2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-timestream","version":"4.8.2","scheme":"aws2-timestream","extendsScheme":"","syntax":"aws2-timestream:clientType:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsTimestreamOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#OPERATION"},"CamelAwsTimestreamRecord":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamwrite.model.Record","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Represents a time-series data point being written into Timestream","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#RECORD"},"CamelAwsTimestreamRecordList":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of Records","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#RECORD_LIST"},"CamelAwsTimestreamTaskStatus":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Status of Batch Load Task","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#TASK_STATUS"},"CamelAwsTimestreamTaskId":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of the batch load task to resume.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#TASK_ID"},"CamelAwsTimestreamDatabaseName":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of Database","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#DATABASE_NAME"},"CamelAwsTimestreamTableName":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of Table","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#TABLE_NAME"},"CamelAwsTimestreamTargetDatabaseName":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of Target Database","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#TARGET_DATABASE_NAME"},"CamelAwsTimestreamTargetTableName":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of Target Table","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#TARGET_TABLE_NAME"},"CamelAwsTimestreamRecordVersion":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Record version","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#RECORD_VERSION"},"CamelAwsTimestreamDataModelConfiguration":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamwrite.model.DataModelConfiguration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Configuration of Data Model","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#DATA_MODEL_CONFIGURATION"},"CamelAwsTimestreamDataSourceConfiguration":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamwrite.model.DataSourceConfiguration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Configuration of Data Source","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#DATA_SOURCE_CONFIGURATION"},"CamelAwsTimestreamReportConfiguration":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamwrite.model.ReportConfiguration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reporting Configuration","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#REPORT_CONFIGURATION"},"CamelAwsTimestreamTableSchema":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamwrite.model.Schema","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestream Table Schema","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#SCHEMA"},"CamelAwsTimestreamRetentionProperties":{"index":14,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamwrite.model.RetentionProperties","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestream Table Retention Properties","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#RETENTION_PROPERTIES"},"CamelAwsTimestreamMagneticStoreWriteProperties":{"index":15,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamwrite.model.MagneticStoreWriteProperties","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestream Table Magentic Store Write properties","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#MAGNETIC_STORE_WRITE_PROPERTIES"},"CamelAwsTimestreamTimeColumn":{"index":16,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of Time column","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#TIME_COLUMN"},"CamelAwsTimestreamMeasureColumnName":{"index":17,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the measure column.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#MEASURE_NAME_COLUMN"},"CamelAwsTimestreamDimensionMappingList":{"index":18,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This is to allow mapping column(s) from the query result to the dimension in the destination table.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#DIMENSION_MAPPING_LIST"},"CamelAwsTimestreamMultiMeasureMappings":{"index":19,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.timestreamquery.model.MultiMeasureMappings","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Multi-measure mappings.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#MULTI_MEASURE_MAPPINGS"},"CamelAwsTimestreamMixedMeasureMappingList":{"index":20,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies how to map measures to multi-measure records.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#MIXED_MEASURE_MAPPING_LIST"},"CamelAwsTimestreamScheduledQueryName":{"index":21,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of scheduled query","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#SCHEDULED_QUERY_NAME"},"CamelAwsTimestreamScheduledQueryArn":{"index":22,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Arn of scheduled query","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#SCHEDULED_QUERY_ARN"},"CamelAwsTimestreamScheduledQueryState":{"index":23,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"State of scheduled query","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#SCHEDULED_QUERY_STATE"},"CamelAwsTimestreamScheduledQueryInvocationTime":{"index":24,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Instant","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Invocation Time for scheduled query execution","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#SCHEDULED_QUERY_INVOCATION_TIME"},"CamelAwsTimestreamQueryString":{"index":25,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query string to run.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#QUERY_STRING"},"CamelAwsTimestreamQueryId":{"index":26,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of query.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#QUERY_ID"},"CamelAwsTimestreamQueryValidateOnly":{"index":27,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Validates the prepared query, but does not store for later execution","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#QUERY_VALIDATE_ONLY"},"CamelAwsTimestreamQueryMaxRows":{"index":28,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The total number of rows to be returned in the Query output.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#QUERY_MAX_ROWS"},"CamelAwsTimestreamMaxResults":{"index":29,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Max Results to be returned in output","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#MAX_RESULTS"},"CamelAwsTimestreamScheduleExpression":{"index":30,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The schedule expression for the query.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#SCHEDULE_EXPRESSION"},"CamelAwsTimestreamNotificationTopicArn":{"index":31,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Notification Topic Arn for the scheduled query.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#NOTIFICATION_TOPIC_ARN"},"CamelAwsTimestreamErrorReportS3BucketName":{"index":32,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"S3 Bucket name for error reporting.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#ERROR_REPORT_S3_BUCKET_NAME"},"CamelAwsTimestreamErrorReportS3ObjectKeyPrefix":{"index":33,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"S3 object key prefix for error reporting.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#ERROR_REPORT_S3_OBJECT_KEY_PREFIX"},"CamelAwsTimestreamErrorReportS3EncryptionOption":{"index":34,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"S3 encryption option for error reporting.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#ERROR_REPORT_S3_ENCRYPTION_OPTION"},"CamelAwsTimestreamScheduledQueryExecutionRoleArn":{"index":35,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"he ARN for the IAM role that Timestream will assume when running the scheduled query.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#SCHEDULED_QUERY_EXECUTION_ROLE_ARN"},"CamelAwsTimestreamClientToken":{"index":36,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Using a ClientToken makes the call to CreateScheduledQuery idempotent","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#CLIENT_TOKEN"},"CamelAwsTimestreamKmsKeyId":{"index":37,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon KMS key used to encrypt the scheduled query resource, at-rest.","constantName":"org.apache.camel.component.aws2.timestream.Timestream2Constants#KMS_KEY_ID"}},"properties":{"clientType":{"index":0,"kind":"path","displayName":"Client Type","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.timestream.Timestream2ClientType","enum":["write","query"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Type of client - write/query"},"label":{"index":1,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.timestream.Timestream2Operations","enum":["describeEndpoints","createBatchLoadTask","describeBatchLoadTask","resumeBatchLoadTask","listBatchLoadTasks","createDatabase","deleteDatabase","describeDatabase","updateDatabase","listDatabases","createTable","deleteTable","describeTable","updateTable","listTables","writeRecords","createScheduledQuery","deleteScheduledQuery","executeScheduledQuery","updateScheduledQuery","describeScheduledQuery","listScheduledQueries","prepareQuery","query","cancelQuery"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"The operation to perform. It can be describeEndpoints,createBatchLoadTask,describeBatchLoadTask, resumeBatchLoadTask,listBatchLoadTasks,createDatabase,deleteDatabase,describeDatabase,updateDatabase, listDatabases,createTable,deleteTable,describeTable,updateTable,listTables,writeRecords, createScheduledQuery,deleteScheduledQuery,executeScheduledQuery,updateScheduledQuery, describeScheduledQuery,listScheduledQueries,prepareQuery,query,cancelQuery"},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"profileCredentialsName":{"index":5,"kind":"parameter","displayName":"Profile Credentials Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"region":{"index":6,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"The region in which the Timestream client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"trustAllCertificates":{"index":7,"kind":"parameter","displayName":"Trust All Certificates","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"uriEndpointOverride":{"index":8,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"index":9,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Set whether the Timestream client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":10,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Set whether the Timestream client should expect to load credentials through a profile credentials provider."},"lazyStartProducer":{"index":11,"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."},"awsTimestreamQueryClient":{"index":12,"kind":"parameter","displayName":"Aws Timestream Query Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.timestreamquery.TimestreamQueryClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"To use an existing configured AwsTimestreamQueryClient client"},"awsTimestreamWriteClient":{"index":13,"kind":"parameter","displayName":"Aws Timestream Write Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.timestreamwrite.TimestreamWriteClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"To use an existing configured AwsTimestreamWriteClient client"},"proxyHost":{"index":14,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the Timestream client"},"proxyPort":{"index":15,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the Timestream client"},"proxyProtocol":{"index":16,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Timestream client"},"accessKey":{"index":17,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"index":18,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.timestream.Timestream2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"}}} , -{"component":{"kind":"component","name":"aws2-translate","title":"AWS Translate","description":"Translate texts using AWS Translate and AWS SDK version 2.x.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.translate.Translate2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-translate","version":"4.8.1","scheme":"aws2-translate","extendsScheme":"","syntax":"aws2-translate:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsTranslateSourceLanguage":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The text source language","constantName":"org.apache.camel.component.aws2.translate.Translate2Constants#SOURCE_LANGUAGE"},"CamelAwsTranslateTargetLanguage":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The text target language","constantName":"org.apache.camel.component.aws2.translate.Translate2Constants#TARGET_LANGUAGE"},"CamelAwsTranslateTerminologyNames":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The terminologies to use","constantName":"org.apache.camel.component.aws2.translate.Translate2Constants#TERMINOLOGY_NAMES"},"CamelAwsTranslateOperation":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.translate.Translate2Constants#OPERATION"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Logical name"},"autodetectSourceLanguage":{"index":1,"kind":"parameter","displayName":"Autodetect Source Language","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Being able to autodetect the source language"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.translate.Translate2Operations","enum":["translateText"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"translateText","configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"The region in which the Translate client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"sourceLanguage":{"index":6,"kind":"parameter","displayName":"Source Language","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Source language to use"},"targetLanguage":{"index":7,"kind":"parameter","displayName":"Target Language","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Target language to use"},"uriEndpointOverride":{"index":8,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":9,"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."},"translateClient":{"index":10,"kind":"parameter","displayName":"Translate Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.translate.TranslateClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"To use an existing configured AWS Translate client"},"proxyHost":{"index":11,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the Translate client"},"proxyPort":{"index":12,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the Translate client"},"proxyProtocol":{"index":13,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Translate client"},"accessKey":{"index":14,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":15,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":16,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":17,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":18,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":19,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Set whether the Translate client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":20,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Set whether the Translate client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":21,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Set whether the Translate client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Translate."}}} +{"component":{"kind":"component","name":"aws2-translate","title":"AWS Translate","description":"Translate texts using AWS Translate and AWS SDK version 2.x.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.translate.Translate2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-translate","version":"4.8.2","scheme":"aws2-translate","extendsScheme":"","syntax":"aws2-translate:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAwsTranslateSourceLanguage":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The text source language","constantName":"org.apache.camel.component.aws2.translate.Translate2Constants#SOURCE_LANGUAGE"},"CamelAwsTranslateTargetLanguage":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The text target language","constantName":"org.apache.camel.component.aws2.translate.Translate2Constants#TARGET_LANGUAGE"},"CamelAwsTranslateTerminologyNames":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The terminologies to use","constantName":"org.apache.camel.component.aws2.translate.Translate2Constants#TERMINOLOGY_NAMES"},"CamelAwsTranslateOperation":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation we want to perform","constantName":"org.apache.camel.component.aws2.translate.Translate2Constants#OPERATION"}},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Logical name"},"autodetectSourceLanguage":{"index":1,"kind":"parameter","displayName":"Autodetect Source Language","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Being able to autodetect the source language"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.translate.Translate2Operations","enum":["translateText"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"translateText","configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"The operation to perform"},"overrideEndpoint":{"index":3,"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ap-south-2","ap-south-1","eu-south-1","eu-south-2","us-gov-east-1","me-central-1","il-central-1","ca-central-1","eu-central-1","us-iso-west-1","eu-central-2","eu-isoe-west-1","us-west-1","us-west-2","af-south-1","eu-north-1","eu-west-3","eu-west-2","eu-west-1","ap-northeast-3","ap-northeast-2","ap-northeast-1","me-south-1","sa-east-1","ap-east-1","cn-north-1","ca-west-1","us-gov-west-1","ap-southeast-1","ap-southeast-2","us-iso-east-1","ap-southeast-3","ap-southeast-4","us-east-1","us-east-2","cn-northwest-1","us-isob-east-1","aws-global","aws-cn-global","aws-us-gov-global","aws-iso-global","aws-iso-b-global"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"The region in which the Translate client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"sourceLanguage":{"index":6,"kind":"parameter","displayName":"Source Language","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Source language to use"},"targetLanguage":{"index":7,"kind":"parameter","displayName":"Target Language","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Target language to use"},"uriEndpointOverride":{"index":8,"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"lazyStartProducer":{"index":9,"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."},"translateClient":{"index":10,"kind":"parameter","displayName":"Translate Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"software.amazon.awssdk.services.translate.TranslateClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"To use an existing configured AWS Translate client"},"proxyHost":{"index":11,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the Translate client"},"proxyPort":{"index":12,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the Translate client"},"proxyProtocol":{"index":13,"kind":"parameter","displayName":"Proxy Protocol","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Translate client"},"accessKey":{"index":14,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"profileCredentialsName":{"index":15,"kind":"parameter","displayName":"Profile Credentials Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"If using a profile credentials provider, this parameter will set the profile name"},"secretKey":{"index":16,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"},"sessionToken":{"index":17,"kind":"parameter","displayName":"Session Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Amazon AWS Session Token used when the user needs to assume an IAM role"},"trustAllCertificates":{"index":18,"kind":"parameter","displayName":"Trust All Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"useDefaultCredentialsProvider":{"index":19,"kind":"parameter","displayName":"Use Default Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Set whether the Translate client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"useProfileCredentialsProvider":{"index":20,"kind":"parameter","displayName":"Use Profile Credentials Provider","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Set whether the Translate client should expect to load credentials through a profile credentials provider."},"useSessionCredentials":{"index":21,"kind":"parameter","displayName":"Use Session Credentials","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.translate.Translate2Configuration","configurationField":"configuration","description":"Set whether the Translate client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Translate."}}} , -{"component":{"kind":"component","name":"azure-cosmosdb","title":"Azure CosmosDB","description":"To read and write records to the CosmosDB database on Azure cloud platform.","deprecated":false,"firstVersion":"3.10.0","label":"cloud,database","javaType":"org.apache.camel.component.azure.cosmosdb.CosmosDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-azure-cosmosdb","version":"4.8.1","scheme":"azure-cosmosdb","extendsScheme":"","syntax":"azure-cosmosdb:databaseName/containerName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"databaseName":{"index":0,"kind":"path","displayName":"Database Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"The name of the Cosmos database that component should connect to. In case you are producing data and have createDatabaseIfNotExists=true, the component will automatically auto create a Cosmos database."},"containerName":{"index":1,"kind":"path","displayName":"Container Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"The name of the Cosmos container that component should connect to. In case you are producing data and have createContainerIfNotExists=true, the component will automatically auto create a Cosmos container."},"clientTelemetryEnabled":{"index":2,"kind":"parameter","displayName":"Client Telemetry Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the flag to enable client telemetry which will periodically collect database operations aggregation statistics, system information like cpu/memory and send it to cosmos monitoring service, which will be helpful during debugging. DEFAULT value is false indicating this is an opt-in feature, by default no telemetry collection."},"connectionSharingAcrossClientsEnabled":{"index":3,"kind":"parameter","displayName":"Connection Sharing Across Clients Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Enables connections sharing across multiple Cosmos Clients. The default is false. When you have multiple instances of Cosmos Client in the same JVM interacting with multiple Cosmos accounts, enabling this allows connection sharing in Direct mode if possible between instances of Cosmos Client. Please note, when setting this option, the connection configuration (e.g., socket timeout config, idle timeout config) of the first instantiated client will be used for all other client instances."},"consistencyLevel":{"index":4,"kind":"parameter","displayName":"Consistency Level","group":"common","label":"common","required":false,"type":"object","javaType":"com.azure.cosmos.ConsistencyLevel","enum":["Strong","BoundedStaleness","Session","Eventual","ConsistentPrefix"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SESSION","configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the consistency levels supported for Azure Cosmos DB client operations in the Azure Cosmos DB service. The requested ConsistencyLevel must match or be weaker than that provisioned for the database account. Consistency levels by order of strength are STRONG, BOUNDED_STALENESS, SESSION and EVENTUAL. Refer to consistency level documentation for additional details: https://docs.microsoft.com/en-us/azure/cosmos-db/consistency-levels"},"containerPartitionKeyPath":{"index":5,"kind":"parameter","displayName":"Container Partition Key Path","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the container partition key path."},"contentResponseOnWriteEnabled":{"index":6,"kind":"parameter","displayName":"Content Response On Write Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations on CosmosItem. In Consumer, it is enabled by default because of the ChangeFeed in the consumer that needs this flag to be enabled, and thus it shouldn't be overridden. In Producer, it is advised to disable it since it reduces the network overhead"},"cosmosAsyncClient":{"index":7,"kind":"parameter","displayName":"Cosmos Async Client","group":"common","label":"common","required":false,"type":"object","javaType":"com.azure.cosmos.CosmosAsyncClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Inject an external CosmosAsyncClient into the component which provides a client-side logical representation of the Azure Cosmos DB service. This asynchronous client is used to configure and execute requests against the service."},"createContainerIfNotExists":{"index":8,"kind":"parameter","displayName":"Create Container If Not Exists","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets if the component should create the Cosmos container automatically in case it doesn't exist in the Cosmos database"},"createDatabaseIfNotExists":{"index":9,"kind":"parameter","displayName":"Create Database If Not Exists","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets if the component should create the Cosmos database automatically in case it doesn't exist in the Cosmos account"},"databaseEndpoint":{"index":10,"kind":"parameter","displayName":"Database Endpoint","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the Azure Cosmos database endpoint the component will connect to."},"multipleWriteRegionsEnabled":{"index":11,"kind":"parameter","displayName":"Multiple Write Regions Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the flag to enable writes on any regions for geo-replicated database accounts in the Azure Cosmos DB service. When the value of this property is true, the SDK will direct write operations to available writable regions of geo-replicated database account. Writable regions are ordered by PreferredRegions property. Setting the property value to true has no effect until EnableMultipleWriteRegions in DatabaseAccount is also set to true. DEFAULT value is true indicating that writes are directed to available writable regions of geo-replicated database account."},"preferredRegions":{"index":12,"kind":"parameter","displayName":"Preferred Regions","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the comma separated preferred regions for geo-replicated database accounts. For example, East US as the preferred region. When EnableEndpointDiscovery is true and PreferredRegions is non-empty, the SDK will prefer to use the regions in the container in the order they are specified to perform operations."},"readRequestsFallbackEnabled":{"index":13,"kind":"parameter","displayName":"Read Requests Fallback Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets whether to allow for reads to go to multiple regions configured on an account of Azure Cosmos DB service. DEFAULT value is true. If this property is not set, the default is true for all Consistency Levels other than Bounded Staleness, The default is false for Bounded Staleness. 1. endpointDiscoveryEnabled is true 2. the Azure Cosmos DB account has more than one region"},"throughputProperties":{"index":14,"kind":"parameter","displayName":"Throughput Properties","group":"common","label":"common","required":false,"type":"object","javaType":"com.azure.cosmos.models.ThroughputProperties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets throughput of the resources in the Azure Cosmos DB service."},"changeFeedProcessorOptions":{"index":15,"kind":"parameter","displayName":"Change Feed Processor Options","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.azure.cosmos.models.ChangeFeedProcessorOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the ChangeFeedProcessorOptions to be used. Unless specifically set the default values that will be used are: maximum items per page or FeedResponse: 100 lease renew interval: 17 seconds lease acquire interval: 13 seconds lease expiration interval: 60 seconds feed poll delay: 5 seconds maximum scale count: unlimited"},"createLeaseContainerIfNotExists":{"index":16,"kind":"parameter","displayName":"Create Lease Container If Not Exists","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets if the component should create Cosmos lease container for the consumer automatically in case it doesn't exist in Cosmos database"},"createLeaseDatabaseIfNotExists":{"index":17,"kind":"parameter","displayName":"Create Lease Database If Not Exists","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets if the component should create the Cosmos lease database for the consumer automatically in case it doesn't exist in the Cosmos account"},"hostName":{"index":18,"kind":"parameter","displayName":"Host 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.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the hostname. The host: a host is an application instance that uses the change feed processor to listen for changes. Multiple instances with the same lease configuration can run in parallel, but each instance should have a different instance name. If not specified, this will be a generated random hostname."},"leaseContainerName":{"index":19,"kind":"parameter","displayName":"Lease Container Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel-lease","configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the lease container which acts as a state storage and coordinates processing the change feed across multiple workers. The lease container can be stored in the same account as the monitored container or in a separate account. It will be auto-created if createLeaseContainerIfNotExists is set to true."},"leaseDatabaseName":{"index":20,"kind":"parameter","displayName":"Lease Database 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.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the lease database where the leaseContainerName will be stored. If it is not specified, this component will store the lease container in the same database that is specified in databaseName. It will be auto-created if createLeaseDatabaseIfNotExists is set to true."},"bridgeErrorHandler":{"index":21,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":22,"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":{"index":23,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"itemId":{"index":24,"kind":"parameter","displayName":"Item Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the itemId in case needed for operation on item like delete, replace"},"itemPartitionKey":{"index":25,"kind":"parameter","displayName":"Item Partition Key","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets partition key. Represents a partition key value in the Azure Cosmos DB database service. A partition key identifies the partition where the item is stored in."},"operation":{"index":26,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.azure.cosmosdb.CosmosDbOperationsDefinition","enum":["listDatabases","createDatabase","queryDatabases","deleteDatabase","createContainer","replaceDatabaseThroughput","listContainers","queryContainers","deleteContainer","replaceContainerThroughput","createItem","upsertItem","deleteItem","replaceItem","readItem","readAllItems","queryItems"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"listDatabases","configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"The CosmosDB operation that can be used with this component on the producer."},"query":{"index":27,"kind":"parameter","displayName":"Query","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"An SQL query to execute on a given resources. To learn more about Cosmos SQL API, check this link {link https://docs.microsoft.com/en-us/azure/cosmos-db/sql-query-getting-started}"},"queryRequestOptions":{"index":28,"kind":"parameter","displayName":"Query Request Options","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.azure.cosmos.models.CosmosQueryRequestOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Set additional QueryRequestOptions that can be used with queryItems, queryContainers, queryDatabases, listDatabases, listItems, listContainers operations"},"lazyStartProducer":{"index":29,"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."},"indexingPolicy":{"index":30,"kind":"parameter","displayName":"Indexing Policy","group":" advanced","label":"common, advanced","required":false,"type":"object","javaType":"com.azure.cosmos.models.IndexingPolicy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"The CosmosDB Indexing Policy that will be set in case of container creation, this option is related to createLeaseContainerIfNotExists and it will be taken into account when the latter is true."},"accountKey":{"index":31,"kind":"parameter","displayName":"Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets either a master or readonly key used to perform authentication for accessing resource."},"credentialType":{"index":32,"kind":"parameter","displayName":"Credential Type","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.azure.cosmosdb.CredentialType","enum":["SHARED_ACCOUNT_KEY","AZURE_IDENTITY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SHARED_ACCOUNT_KEY","configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"}}} +{"component":{"kind":"component","name":"azure-cosmosdb","title":"Azure CosmosDB","description":"To read and write records to the CosmosDB database on Azure cloud platform.","deprecated":false,"firstVersion":"3.10.0","label":"cloud,database","javaType":"org.apache.camel.component.azure.cosmosdb.CosmosDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-azure-cosmosdb","version":"4.8.2","scheme":"azure-cosmosdb","extendsScheme":"","syntax":"azure-cosmosdb:databaseName/containerName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"databaseName":{"index":0,"kind":"path","displayName":"Database Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"The name of the Cosmos database that component should connect to. In case you are producing data and have createDatabaseIfNotExists=true, the component will automatically auto create a Cosmos database."},"containerName":{"index":1,"kind":"path","displayName":"Container Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"The name of the Cosmos container that component should connect to. In case you are producing data and have createContainerIfNotExists=true, the component will automatically auto create a Cosmos container."},"clientTelemetryEnabled":{"index":2,"kind":"parameter","displayName":"Client Telemetry Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the flag to enable client telemetry which will periodically collect database operations aggregation statistics, system information like cpu/memory and send it to cosmos monitoring service, which will be helpful during debugging. DEFAULT value is false indicating this is an opt-in feature, by default no telemetry collection."},"connectionSharingAcrossClientsEnabled":{"index":3,"kind":"parameter","displayName":"Connection Sharing Across Clients Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Enables connections sharing across multiple Cosmos Clients. The default is false. When you have multiple instances of Cosmos Client in the same JVM interacting with multiple Cosmos accounts, enabling this allows connection sharing in Direct mode if possible between instances of Cosmos Client. Please note, when setting this option, the connection configuration (e.g., socket timeout config, idle timeout config) of the first instantiated client will be used for all other client instances."},"consistencyLevel":{"index":4,"kind":"parameter","displayName":"Consistency Level","group":"common","label":"common","required":false,"type":"object","javaType":"com.azure.cosmos.ConsistencyLevel","enum":["Strong","BoundedStaleness","Session","Eventual","ConsistentPrefix"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SESSION","configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the consistency levels supported for Azure Cosmos DB client operations in the Azure Cosmos DB service. The requested ConsistencyLevel must match or be weaker than that provisioned for the database account. Consistency levels by order of strength are STRONG, BOUNDED_STALENESS, SESSION and EVENTUAL. Refer to consistency level documentation for additional details: https://docs.microsoft.com/en-us/azure/cosmos-db/consistency-levels"},"containerPartitionKeyPath":{"index":5,"kind":"parameter","displayName":"Container Partition Key Path","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the container partition key path."},"contentResponseOnWriteEnabled":{"index":6,"kind":"parameter","displayName":"Content Response On Write Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations on CosmosItem. In Consumer, it is enabled by default because of the ChangeFeed in the consumer that needs this flag to be enabled, and thus it shouldn't be overridden. In Producer, it is advised to disable it since it reduces the network overhead"},"cosmosAsyncClient":{"index":7,"kind":"parameter","displayName":"Cosmos Async Client","group":"common","label":"common","required":false,"type":"object","javaType":"com.azure.cosmos.CosmosAsyncClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Inject an external CosmosAsyncClient into the component which provides a client-side logical representation of the Azure Cosmos DB service. This asynchronous client is used to configure and execute requests against the service."},"createContainerIfNotExists":{"index":8,"kind":"parameter","displayName":"Create Container If Not Exists","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets if the component should create the Cosmos container automatically in case it doesn't exist in the Cosmos database"},"createDatabaseIfNotExists":{"index":9,"kind":"parameter","displayName":"Create Database If Not Exists","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets if the component should create the Cosmos database automatically in case it doesn't exist in the Cosmos account"},"databaseEndpoint":{"index":10,"kind":"parameter","displayName":"Database Endpoint","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the Azure Cosmos database endpoint the component will connect to."},"multipleWriteRegionsEnabled":{"index":11,"kind":"parameter","displayName":"Multiple Write Regions Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the flag to enable writes on any regions for geo-replicated database accounts in the Azure Cosmos DB service. When the value of this property is true, the SDK will direct write operations to available writable regions of geo-replicated database account. Writable regions are ordered by PreferredRegions property. Setting the property value to true has no effect until EnableMultipleWriteRegions in DatabaseAccount is also set to true. DEFAULT value is true indicating that writes are directed to available writable regions of geo-replicated database account."},"preferredRegions":{"index":12,"kind":"parameter","displayName":"Preferred Regions","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the comma separated preferred regions for geo-replicated database accounts. For example, East US as the preferred region. When EnableEndpointDiscovery is true and PreferredRegions is non-empty, the SDK will prefer to use the regions in the container in the order they are specified to perform operations."},"readRequestsFallbackEnabled":{"index":13,"kind":"parameter","displayName":"Read Requests Fallback Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets whether to allow for reads to go to multiple regions configured on an account of Azure Cosmos DB service. DEFAULT value is true. If this property is not set, the default is true for all Consistency Levels other than Bounded Staleness, The default is false for Bounded Staleness. 1. endpointDiscoveryEnabled is true 2. the Azure Cosmos DB account has more than one region"},"throughputProperties":{"index":14,"kind":"parameter","displayName":"Throughput Properties","group":"common","label":"common","required":false,"type":"object","javaType":"com.azure.cosmos.models.ThroughputProperties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets throughput of the resources in the Azure Cosmos DB service."},"changeFeedProcessorOptions":{"index":15,"kind":"parameter","displayName":"Change Feed Processor Options","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.azure.cosmos.models.ChangeFeedProcessorOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the ChangeFeedProcessorOptions to be used. Unless specifically set the default values that will be used are: maximum items per page or FeedResponse: 100 lease renew interval: 17 seconds lease acquire interval: 13 seconds lease expiration interval: 60 seconds feed poll delay: 5 seconds maximum scale count: unlimited"},"createLeaseContainerIfNotExists":{"index":16,"kind":"parameter","displayName":"Create Lease Container If Not Exists","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets if the component should create Cosmos lease container for the consumer automatically in case it doesn't exist in Cosmos database"},"createLeaseDatabaseIfNotExists":{"index":17,"kind":"parameter","displayName":"Create Lease Database If Not Exists","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets if the component should create the Cosmos lease database for the consumer automatically in case it doesn't exist in the Cosmos account"},"hostName":{"index":18,"kind":"parameter","displayName":"Host 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.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the hostname. The host: a host is an application instance that uses the change feed processor to listen for changes. Multiple instances with the same lease configuration can run in parallel, but each instance should have a different instance name. If not specified, this will be a generated random hostname."},"leaseContainerName":{"index":19,"kind":"parameter","displayName":"Lease Container Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel-lease","configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the lease container which acts as a state storage and coordinates processing the change feed across multiple workers. The lease container can be stored in the same account as the monitored container or in a separate account. It will be auto-created if createLeaseContainerIfNotExists is set to true."},"leaseDatabaseName":{"index":20,"kind":"parameter","displayName":"Lease Database 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.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the lease database where the leaseContainerName will be stored. If it is not specified, this component will store the lease container in the same database that is specified in databaseName. It will be auto-created if createLeaseDatabaseIfNotExists is set to true."},"bridgeErrorHandler":{"index":21,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":22,"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":{"index":23,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"itemId":{"index":24,"kind":"parameter","displayName":"Item Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets the itemId in case needed for operation on item like delete, replace"},"itemPartitionKey":{"index":25,"kind":"parameter","displayName":"Item Partition Key","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets partition key. Represents a partition key value in the Azure Cosmos DB database service. A partition key identifies the partition where the item is stored in."},"operation":{"index":26,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.azure.cosmosdb.CosmosDbOperationsDefinition","enum":["listDatabases","createDatabase","queryDatabases","deleteDatabase","createContainer","replaceDatabaseThroughput","listContainers","queryContainers","deleteContainer","replaceContainerThroughput","createItem","upsertItem","deleteItem","replaceItem","readItem","readAllItems","queryItems"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"listDatabases","configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"The CosmosDB operation that can be used with this component on the producer."},"query":{"index":27,"kind":"parameter","displayName":"Query","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"An SQL query to execute on a given resources. To learn more about Cosmos SQL API, check this link {link https://docs.microsoft.com/en-us/azure/cosmos-db/sql-query-getting-started}"},"queryRequestOptions":{"index":28,"kind":"parameter","displayName":"Query Request Options","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.azure.cosmos.models.CosmosQueryRequestOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Set additional QueryRequestOptions that can be used with queryItems, queryContainers, queryDatabases, listDatabases, listItems, listContainers operations"},"lazyStartProducer":{"index":29,"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."},"indexingPolicy":{"index":30,"kind":"parameter","displayName":"Indexing Policy","group":" advanced","label":"common, advanced","required":false,"type":"object","javaType":"com.azure.cosmos.models.IndexingPolicy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"The CosmosDB Indexing Policy that will be set in case of container creation, this option is related to createLeaseContainerIfNotExists and it will be taken into account when the latter is true."},"accountKey":{"index":31,"kind":"parameter","displayName":"Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Sets either a master or readonly key used to perform authentication for accessing resource."},"credentialType":{"index":32,"kind":"parameter","displayName":"Credential Type","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.azure.cosmosdb.CredentialType","enum":["SHARED_ACCOUNT_KEY","AZURE_IDENTITY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SHARED_ACCOUNT_KEY","configurationClass":"org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"}}} , -{"component":{"kind":"component","name":"azure-eventhubs","title":"Azure Event Hubs","description":"Send and receive events to/from Azure Event Hubs using AMQP protocol.","deprecated":false,"firstVersion":"3.5.0","label":"cloud,messaging","javaType":"org.apache.camel.component.azure.eventhubs.EventHubsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-azure-eventhubs","version":"4.8.1","scheme":"azure-eventhubs","extendsScheme":"","syntax":"azure-eventhubs:namespace/eventHubName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAzureEventHubsPartitionKey":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) Overrides the hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition. (consumer) It sets the partition hashing key if it was set when originally publishing the event. If it exists, this value was used to compute a hash to select a partition to send the message to. This is only present on a received EventData.","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#PARTITION_KEY"},"CamelAzureEventHubsPartitionId":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) Overrides the identifier of the Event Hub partition that the events will be sent to. (consumer) It sets the partition id of the Event Hub.","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#PARTITION_ID"},"CamelAzureEventHubsOffset":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"It sets the offset of the event when it was received from the associated Event Hub partition. This is only present on a received EventData.","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#OFFSET"},"CamelAzureEventHubsEnqueuedTime":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Instant","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"It sets the instant, in UTC, of when the event was enqueued in the Event Hub partition. This is only present on a received EventData.","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#ENQUEUED_TIME"},"CamelAzureEventHubsSequenceNumber":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"It sets the sequence number assigned to the event when it was enqueued in the associated Event Hub partition. This is unique for every message received in the Event Hub partition. This is only present on a received EventData.","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#SEQUENCE_NUMBER"},"CamelAzureEventHubsMetadata":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The set of free-form event properties which may be used for passing metadata associated with the event with the event body during Event Hubs operations.","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#METADATA"},"CamelMessageTimestamp":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#MESSAGE_TIMESTAMP"},"CamelAzureEventHubsCheckpointUpdatedBy":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"It sets the reason for the checkpoint to have been updated. This is only present on a received EventData.","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#CHECKPOINT_UPDATED_BY"}},"properties":{"namespace":{"index":0,"kind":"path","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"EventHubs namespace created in Azure Portal."},"eventHubName":{"index":1,"kind":"path","displayName":"Event Hub Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"EventHubs name under a specific namespace."},"amqpRetryOptions":{"index":2,"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.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the retry policy for EventHubProducerAsyncClient. If not specified, the default retry options are used."},"amqpTransportType":{"index":3,"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.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the transport type by which all the communication with Azure Event Hubs occurs."},"blobAccessKey":{"index":4,"kind":"parameter","displayName":"Blob Access Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"In case you chose the default BlobCheckpointStore, this sets access key for the associated azure account name to be used for authentication with azure blob services."},"blobAccountName":{"index":5,"kind":"parameter","displayName":"Blob Account 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.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"In case you chose the default BlobCheckpointStore, this sets Azure account name to be used for authentication with azure blob services."},"blobContainerName":{"index":6,"kind":"parameter","displayName":"Blob Container 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.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"In case you chose the default BlobCheckpointStore, this sets the blob container that shall be used by the BlobCheckpointStore to store the checkpoint offsets."},"blobStorageSharedKeyCredential":{"index":7,"kind":"parameter","displayName":"Blob Storage Shared Key Credential","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.azure.storage.common.StorageSharedKeyCredential","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"In case you chose the default BlobCheckpointStore, StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information."},"checkpointBatchSize":{"index":8,"kind":"parameter","displayName":"Checkpoint Batch Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the batch size between each checkpoint update. Works jointly with checkpointBatchTimeout."},"checkpointBatchTimeout":{"index":9,"kind":"parameter","displayName":"Checkpoint Batch Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the batch timeout between each checkpoint update. Works jointly with checkpointBatchSize."},"checkpointStore":{"index":10,"kind":"parameter","displayName":"Checkpoint Store","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.azure.messaging.eventhubs.CheckpointStore","deprecated":false,"autowired":false,"secret":false,"defaultValue":"BlobCheckpointStore","configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the CheckpointStore the EventProcessorClient will use for storing partition ownership and checkpoint information. Users can, optionally, provide their own implementation of CheckpointStore which will store ownership and checkpoint information. By default, it's set to use com.azure.messaging.eventhubs.checkpointstore.blob.BlobCheckpointStore which stores all checkpoint offsets into Azure Blob Storage."},"consumerGroupName":{"index":11,"kind":"parameter","displayName":"Consumer Group Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"$Default","configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the name of the consumer group this consumer is associated with. Events are read in the context of this group. The name of the consumer group that is created by default is $Default."},"eventPosition":{"index":12,"kind":"parameter","displayName":"Event Position","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the map containing the event position to use for each partition if a checkpoint for the partition does not exist in CheckpointStore. This map is keyed off of the partition id. If there is no checkpoint in CheckpointStore and there is no entry in this map, the processing of the partition will start from EventPosition#latest() position."},"prefetchCount":{"index":13,"kind":"parameter","displayName":"Prefetch Count","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the count used by the receiver to control the number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receive operation is currently active."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"partitionId":{"index":17,"kind":"parameter","displayName":"Partition Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the identifier of the Event Hub partition that the EventData events will be sent to. If the identifier is not specified, the Event Hubs service will be responsible for routing events that are sent to an available partition."},"partitionKey":{"index":18,"kind":"parameter","displayName":"Partition Key","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets a hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition. The selection of a partition is stable for a given partition hashing key. Should any other batches of events be sent using the same exact partition hashing key, the Event Hubs service will route them all to the same partition. This should be specified only when there is a need to group events by partition, but there is flexibility into which partition they are routed. If ensuring that a batch of events is sent only to a specific partition, it is recommended that the identifier of the position be specified directly when sending the batch."},"producerAsyncClient":{"index":19,"kind":"parameter","displayName":"Producer Async Client","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.azure.messaging.eventhubs.EventHubProducerAsyncClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the EventHubProducerAsyncClient.An asynchronous producer responsible for transmitting EventData to a specific Event Hub, grouped together in batches. Depending on the com.azure.messaging.eventhubs.models.CreateBatchOptions options specified when creating an com.azure.messaging.eventhubs.EventDataBatch, the events may be automatically routed to an available partition or specific to a partition. Use by this component to produce the data in camel producer."},"lazyStartProducer":{"index":20,"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":{"index":21,"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.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Instead of supplying namespace, sharedAccessKey, sharedAccessName, etc. you can supply the connection string for your eventHub. The connection string for EventHubs already includes all the necessary information to connect to your EventHub. To learn how to generate the connection string, take a look at this documentation: https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string"},"credentialType":{"index":22,"kind":"parameter","displayName":"Credential Type","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.azure.eventhubs.CredentialType","enum":["AZURE_IDENTITY","CONNECTION_STRING","TOKEN_CREDENTIAL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CONNECTION_STRING","configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"},"sharedAccessKey":{"index":23,"kind":"parameter","displayName":"Shared Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"The generated value for the SharedAccessName."},"sharedAccessName":{"index":24,"kind":"parameter","displayName":"Shared Access Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"The name you chose for your EventHubs SAS keys."},"tokenCredential":{"index":25,"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.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Provide custom authentication credentials using an implementation of TokenCredential."}}} +{"component":{"kind":"component","name":"azure-eventhubs","title":"Azure Event Hubs","description":"Send and receive events to/from Azure Event Hubs using AMQP protocol.","deprecated":false,"firstVersion":"3.5.0","label":"cloud,messaging","javaType":"org.apache.camel.component.azure.eventhubs.EventHubsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-azure-eventhubs","version":"4.8.2","scheme":"azure-eventhubs","extendsScheme":"","syntax":"azure-eventhubs:namespace/eventHubName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAzureEventHubsPartitionKey":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) Overrides the hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition. (consumer) It sets the partition hashing key if it was set when originally publishing the event. If it exists, this value was used to compute a hash to select a partition to send the message to. This is only present on a received EventData.","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#PARTITION_KEY"},"CamelAzureEventHubsPartitionId":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) Overrides the identifier of the Event Hub partition that the events will be sent to. (consumer) It sets the partition id of the Event Hub.","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#PARTITION_ID"},"CamelAzureEventHubsOffset":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"It sets the offset of the event when it was received from the associated Event Hub partition. This is only present on a received EventData.","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#OFFSET"},"CamelAzureEventHubsEnqueuedTime":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Instant","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"It sets the instant, in UTC, of when the event was enqueued in the Event Hub partition. This is only present on a received EventData.","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#ENQUEUED_TIME"},"CamelAzureEventHubsSequenceNumber":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"It sets the sequence number assigned to the event when it was enqueued in the associated Event Hub partition. This is unique for every message received in the Event Hub partition. This is only present on a received EventData.","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#SEQUENCE_NUMBER"},"CamelAzureEventHubsMetadata":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The set of free-form event properties which may be used for passing metadata associated with the event with the event body during Event Hubs operations.","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#METADATA"},"CamelMessageTimestamp":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#MESSAGE_TIMESTAMP"},"CamelAzureEventHubsCheckpointUpdatedBy":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"It sets the reason for the checkpoint to have been updated. This is only present on a received EventData.","constantName":"org.apache.camel.component.azure.eventhubs.EventHubsConstants#CHECKPOINT_UPDATED_BY"}},"properties":{"namespace":{"index":0,"kind":"path","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"EventHubs namespace created in Azure Portal."},"eventHubName":{"index":1,"kind":"path","displayName":"Event Hub Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"EventHubs name under a specific namespace."},"amqpRetryOptions":{"index":2,"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.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the retry policy for EventHubProducerAsyncClient. If not specified, the default retry options are used."},"amqpTransportType":{"index":3,"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.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the transport type by which all the communication with Azure Event Hubs occurs."},"blobAccessKey":{"index":4,"kind":"parameter","displayName":"Blob Access Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"In case you chose the default BlobCheckpointStore, this sets access key for the associated azure account name to be used for authentication with azure blob services."},"blobAccountName":{"index":5,"kind":"parameter","displayName":"Blob Account 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.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"In case you chose the default BlobCheckpointStore, this sets Azure account name to be used for authentication with azure blob services."},"blobContainerName":{"index":6,"kind":"parameter","displayName":"Blob Container 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.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"In case you chose the default BlobCheckpointStore, this sets the blob container that shall be used by the BlobCheckpointStore to store the checkpoint offsets."},"blobStorageSharedKeyCredential":{"index":7,"kind":"parameter","displayName":"Blob Storage Shared Key Credential","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.azure.storage.common.StorageSharedKeyCredential","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"In case you chose the default BlobCheckpointStore, StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information."},"checkpointBatchSize":{"index":8,"kind":"parameter","displayName":"Checkpoint Batch Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the batch size between each checkpoint update. Works jointly with checkpointBatchTimeout."},"checkpointBatchTimeout":{"index":9,"kind":"parameter","displayName":"Checkpoint Batch Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the batch timeout between each checkpoint update. Works jointly with checkpointBatchSize."},"checkpointStore":{"index":10,"kind":"parameter","displayName":"Checkpoint Store","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.azure.messaging.eventhubs.CheckpointStore","deprecated":false,"autowired":false,"secret":false,"defaultValue":"BlobCheckpointStore","configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the CheckpointStore the EventProcessorClient will use for storing partition ownership and checkpoint information. Users can, optionally, provide their own implementation of CheckpointStore which will store ownership and checkpoint information. By default, it's set to use com.azure.messaging.eventhubs.checkpointstore.blob.BlobCheckpointStore which stores all checkpoint offsets into Azure Blob Storage."},"consumerGroupName":{"index":11,"kind":"parameter","displayName":"Consumer Group Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"$Default","configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the name of the consumer group this consumer is associated with. Events are read in the context of this group. The name of the consumer group that is created by default is $Default."},"eventPosition":{"index":12,"kind":"parameter","displayName":"Event Position","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the map containing the event position to use for each partition if a checkpoint for the partition does not exist in CheckpointStore. This map is keyed off of the partition id. If there is no checkpoint in CheckpointStore and there is no entry in this map, the processing of the partition will start from EventPosition#latest() position."},"prefetchCount":{"index":13,"kind":"parameter","displayName":"Prefetch Count","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the count used by the receiver to control the number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receive operation is currently active."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"partitionId":{"index":17,"kind":"parameter","displayName":"Partition Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the identifier of the Event Hub partition that the EventData events will be sent to. If the identifier is not specified, the Event Hubs service will be responsible for routing events that are sent to an available partition."},"partitionKey":{"index":18,"kind":"parameter","displayName":"Partition Key","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets a hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition. The selection of a partition is stable for a given partition hashing key. Should any other batches of events be sent using the same exact partition hashing key, the Event Hubs service will route them all to the same partition. This should be specified only when there is a need to group events by partition, but there is flexibility into which partition they are routed. If ensuring that a batch of events is sent only to a specific partition, it is recommended that the identifier of the position be specified directly when sending the batch."},"producerAsyncClient":{"index":19,"kind":"parameter","displayName":"Producer Async Client","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.azure.messaging.eventhubs.EventHubProducerAsyncClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Sets the EventHubProducerAsyncClient.An asynchronous producer responsible for transmitting EventData to a specific Event Hub, grouped together in batches. Depending on the com.azure.messaging.eventhubs.models.CreateBatchOptions options specified when creating an com.azure.messaging.eventhubs.EventDataBatch, the events may be automatically routed to an available partition or specific to a partition. Use by this component to produce the data in camel producer."},"lazyStartProducer":{"index":20,"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":{"index":21,"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.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Instead of supplying namespace, sharedAccessKey, sharedAccessName, etc. you can supply the connection string for your eventHub. The connection string for EventHubs already includes all the necessary information to connect to your EventHub. To learn how to generate the connection string, take a look at this documentation: https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string"},"credentialType":{"index":22,"kind":"parameter","displayName":"Credential Type","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.azure.eventhubs.CredentialType","enum":["AZURE_IDENTITY","CONNECTION_STRING","TOKEN_CREDENTIAL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CONNECTION_STRING","configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"},"sharedAccessKey":{"index":23,"kind":"parameter","displayName":"Shared Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"The generated value for the SharedAccessName."},"sharedAccessName":{"index":24,"kind":"parameter","displayName":"Shared Access Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"The name you chose for your EventHubs SAS keys."},"tokenCredential":{"index":25,"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.eventhubs.EventHubsConfiguration","configurationField":"configuration","description":"Provide custom authentication credentials using an implementation of TokenCredential."}}} , -{"component":{"kind":"component","name":"azure-files","title":"Azure Files","description":"Send and receive files to Azure storage file share","deprecated":false,"firstVersion":"3.22.0","label":"cloud,file","javaType":"org.apache.camel.component.file.azure.FilesComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-azure-files","version":"4.8.1","scheme":"azure-files","extendsScheme":"file","syntax":"azure-files:account/share","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelFileLength":{"index":0,"kind":"header","displayName":"","group":"both","label":"both","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A long value containing the file size. For producer, known length helps if the body converts to InputStream more efficiently than to bytes array.","constantName":"org.apache.camel.component.file.azure.FilesHeaders#FILE_LENGTH"},"CamelFileLastModified":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Long value containing the last modified timestamp of the file.","constantName":"org.apache.camel.component.file.azure.FilesHeaders#FILE_LAST_MODIFIED"},"CamelFileName":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the output file name (relative to the endpoint directory) to be used for the output message when sending to the endpoint. If this is not present and no expression either, then a generated message ID is used as the filename instead.","constantName":"org.apache.camel.component.file.azure.FilesHeaders#FILE_NAME"},"CamelFileNameOnly":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only the file name (the name with no leading paths).","constantName":"org.apache.camel.component.file.azure.FilesHeaders#FILE_NAME_ONLY"},"CamelFileParent":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent path.","constantName":"org.apache.camel.component.file.azure.FilesHeaders#FILE_PARENT"},"CamelRemoteFileInputStream":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.io.InputStream","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote file input stream.","constantName":"org.apache.camel.component.file.azure.FilesHeaders#REMOTE_FILE_INPUT_STREAM"},"CamelFileLocalWorkPath":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the local work file, if local work directory is used.","constantName":"org.apache.camel.component.file.azure.FilesHeaders#FILE_LOCAL_WORK_PATH"},"CamelFileHost":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote hostname.","constantName":"org.apache.camel.component.file.azure.FilesHeaders#FILE_HOST"}},"properties":{"account":{"index":0,"kind":"path","displayName":"Account","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"The account to use"},"share":{"index":1,"kind":"path","displayName":"Share","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"The share to use"},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"Port of the FTP server"},"directoryName":{"index":3,"kind":"path","displayName":"Directory Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"The starting directory"},"credentialType":{"index":4,"kind":"parameter","displayName":"Credential Type","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.component.file.azure.CredentialType","enum":["SHARED_ACCOUNT_KEY","SHARED_KEY_CREDENTIAL","AZURE_IDENTITY","AZURE_SAS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SHARED_ACCOUNT_KEY","configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"},"disconnect":{"index":5,"kind":"parameter","displayName":"Disconnect","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead."},"doneFileName":{"index":6,"kind":"parameter","displayName":"Done File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders."},"fileName":{"index":7,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."},"sharedKey":{"index":8,"kind":"parameter","displayName":"Shared Key","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"Shared key (storage account key)"},"delete":{"index":9,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file will be deleted after it is processed successfully."},"moveFailed":{"index":10,"kind":"parameter","displayName":"Move Failed","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again."},"noop":{"index":11,"kind":"parameter","displayName":"Noop","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again."},"preMove":{"index":12,"kind":"parameter","displayName":"Pre Move","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order."},"preSort":{"index":13,"kind":"parameter","displayName":"Pre Sort","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled."},"recursive":{"index":14,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If a directory, will look for files in all the sub-directories as well."},"resumeDownload":{"index":15,"kind":"parameter","displayName":"Resume Download","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configures whether resume download is enabled. In addition the options localWorkDirectory must be configured so downloaded files are stored in a local directory, which is required to support resuming of downloads."},"sendEmptyMessageWhenIdle":{"index":16,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"streamDownload":{"index":17,"kind":"parameter","displayName":"Stream Download","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"Sets the download method to use when not using a local working directory. If set to true, the remote files are streamed to the route as they are read. When set to false, the remote files are loaded into memory before being sent into the route. If enabling this option then you must set stepwise=false as both cannot be enabled at the same time."},"bridgeErrorHandler":{"index":18,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"download":{"index":19,"kind":"parameter","displayName":"Download","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded."},"exceptionHandler":{"index":20,"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":{"index":21,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"inProgressRepository":{"index":22,"kind":"parameter","displayName":"In Progress Repository","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."},"localWorkDirectory":{"index":23,"kind":"parameter","displayName":"Local Work Directory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory."},"onCompletionExceptionHandler":{"index":24,"kind":"parameter","displayName":"On Completion Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore."},"pollStrategy":{"index":25,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"processStrategy":{"index":26,"kind":"parameter","displayName":"Process Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileProcessStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply."},"checksumFileAlgorithm":{"index":27,"kind":"parameter","displayName":"Checksum File Algorithm","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["MD2","MD5","SHA_1","SHA_224","SHA_256","SHA_384","SHA_512","SHA_512_224","SHA_512_256","SHA3_224","SHA3_256","SHA3_384","SHA3_512"],"deprecated":false,"autowired":false,"secret":false,"description":"If provided, then Camel will write a checksum file when the original file has been written. The checksum file will contain the checksum created with the provided algorithm for the original file. The checksum file will always be written in the same folder as the original file."},"fileExist":{"index":28,"kind":"parameter","displayName":"File Exist","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExist","enum":["Override","Append","Fail","Ignore","Move","TryRename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Override","description":"What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers."},"flatten":{"index":29,"kind":"parameter","displayName":"Flatten","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."},"jailStartingDirectory":{"index":30,"kind":"parameter","displayName":"Jail Starting Directory","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."},"tempFileName":{"index":31,"kind":"parameter","displayName":"Temp File Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir."},"tempPrefix":{"index":32,"kind":"parameter","displayName":"Temp Prefix","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files."},"allowNullBody":{"index":33,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."},"disconnectOnBatchComplete":{"index":34,"kind":"parameter","displayName":"Disconnect On Batch Complete","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server."},"eagerDeleteTargetFile":{"index":35,"kind":"parameter","displayName":"Eager Delete Target File","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation."},"keepLastModified":{"index":36,"kind":"parameter","displayName":"Keep Last Modified","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers."},"lazyStartProducer":{"index":37,"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."},"moveExistingFileStrategy":{"index":38,"kind":"parameter","displayName":"Move Existing File Strategy","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.strategy.FileMoveExistingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"},"autoCreate":{"index":39,"kind":"parameter","displayName":"Auto Create","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to."},"connectTimeout":{"index":40,"kind":"parameter","displayName":"Connect Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH"},"maximumReconnectAttempts":{"index":41,"kind":"parameter","displayName":"Maximum Reconnect Attempts","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior."},"reconnectDelay":{"index":42,"kind":"parameter","displayName":"Reconnect Delay","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Delay in millis Camel will wait before performing a reconnect attempt."},"throwExceptionOnConnectFailed":{"index":43,"kind":"parameter","displayName":"Throw Exception On Connect Failed","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method."},"timeout":{"index":44,"kind":"parameter","displayName":"Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"Sets the data timeout for waiting for reply Used only by FTPClient"},"antExclude":{"index":45,"kind":"parameter","displayName":"Ant Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format."},"antFilterCaseSensitive":{"index":46,"kind":"parameter","displayName":"Ant Filter Case Sensitive","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets case sensitive flag on ant filter."},"antInclude":{"index":47,"kind":"parameter","displayName":"Ant Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format."},"eagerMaxMessagesPerPoll":{"index":48,"kind":"parameter","displayName":"Eager Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting."},"exclude":{"index":49,"kind":"parameter","displayName":"Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"excludeExt":{"index":50,"kind":"parameter","displayName":"Exclude Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat files, use excludeExt=bak,dat. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"filter":{"index":51,"kind":"parameter","displayName":"Filter","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileFilter","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method."},"filterDirectory":{"index":52,"kind":"parameter","displayName":"Filter Directory","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}"},"filterFile":{"index":53,"kind":"parameter","displayName":"Filter File","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000"},"idempotent":{"index":54,"kind":"parameter","displayName":"Idempotent","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentEager":{"index":55,"kind":"parameter","displayName":"Idempotent Eager","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentKey":{"index":56,"kind":"parameter","displayName":"Idempotent Key","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}"},"idempotentRepository":{"index":57,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true."},"include":{"index":58,"kind":"parameter","displayName":"Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"includeExt":{"index":59,"kind":"parameter","displayName":"Include Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml files, use includeExt=txt,xml. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"maxDepth":{"index":60,"kind":"parameter","displayName":"Max Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"description":"The maximum depth to traverse when recursively processing a directory."},"maxMessagesPerPoll":{"index":61,"kind":"parameter","displayName":"Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards."},"minDepth":{"index":62,"kind":"parameter","displayName":"Min Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory."},"move":{"index":63,"kind":"parameter","displayName":"Move","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done."},"exclusiveReadLockStrategy":{"index":64,"kind":"parameter","displayName":"Exclusive Read Lock Strategy","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation."},"readLock":{"index":65,"kind":"parameter","displayName":"Read Lock","group":"lock","label":"consumer,lock","required":false,"type":"string","javaType":"java.lang.String","enum":["none","markerFile","fileLock","rename","changed","idempotent","idempotent-changed","idempotent-rename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: - none - No read lock is in use - markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component - changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. - fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. - rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. - idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that.Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan."},"readLockCheckInterval":{"index":66,"kind":"parameter","displayName":"Read Lock Check Interval","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"readLockDeleteOrphanLockFiles":{"index":67,"kind":"parameter","displayName":"Read Lock Delete Orphan Lock Files","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory."},"readLockLoggingLevel":{"index":68,"kind":"parameter","displayName":"Read Lock Logging Level","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename."},"readLockMarkerFile":{"index":69,"kind":"parameter","displayName":"Read Lock Marker File","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application."},"readLockMinAge":{"index":70,"kind":"parameter","displayName":"Read Lock Min Age","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age."},"readLockMinLength":{"index":71,"kind":"parameter","displayName":"Read Lock Min Length","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files."},"readLockRemoveOnCommit":{"index":72,"kind":"parameter","displayName":"Read Lock Remove On Commit","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option."},"readLockRemoveOnRollback":{"index":73,"kind":"parameter","displayName":"Read Lock Remove On Rollback","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit)."},"readLockTimeout":{"index":74,"kind":"parameter","displayName":"Read Lock Timeout","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"description":"Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"backoffErrorThreshold":{"index":75,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":76,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":77,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":78,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":79,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":80,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":81,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":82,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":83,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":84,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":85,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":86,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":87,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":88,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"sdd":{"index":89,"kind":"parameter","displayName":"Sdd","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of service SAS token"},"se":{"index":90,"kind":"parameter","displayName":"Se","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"si":{"index":91,"kind":"parameter","displayName":"Si","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of service SAS token"},"sig":{"index":92,"kind":"parameter","displayName":"Sig","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"sip":{"index":93,"kind":"parameter","displayName":"Sip","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"sp":{"index":94,"kind":"parameter","displayName":"Sp","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"spr":{"index":95,"kind":"parameter","displayName":"Spr","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"sr":{"index":96,"kind":"parameter","displayName":"Sr","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of service SAS token"},"srt":{"index":97,"kind":"parameter","displayName":"Srt","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"ss":{"index":98,"kind":"parameter","displayName":"Ss","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of account SAS token"},"st":{"index":99,"kind":"parameter","displayName":"St","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"sv":{"index":100,"kind":"parameter","displayName":"Sv","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"shuffle":{"index":101,"kind":"parameter","displayName":"Shuffle","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To shuffle the list of files (sort in random order)"},"sortBy":{"index":102,"kind":"parameter","displayName":"Sort By","group":"sort","label":"consumer,sort","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date."},"sorter":{"index":103,"kind":"parameter","displayName":"Sorter","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"java.util.Comparator>","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable sorter as a java.util.Comparator class."}}} +{"component":{"kind":"component","name":"azure-files","title":"Azure Files","description":"Send and receive files to Azure storage file share","deprecated":false,"firstVersion":"3.22.0","label":"cloud,file","javaType":"org.apache.camel.component.file.azure.FilesComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-azure-files","version":"4.8.2","scheme":"azure-files","extendsScheme":"file","syntax":"azure-files:account/share","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelFileLength":{"index":0,"kind":"header","displayName":"","group":"both","label":"both","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A long value containing the file size. For producer, known length helps if the body converts to InputStream more efficiently than to bytes array.","constantName":"org.apache.camel.component.file.azure.FilesHeaders#FILE_LENGTH"},"CamelFileLastModified":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Long value containing the last modified timestamp of the file.","constantName":"org.apache.camel.component.file.azure.FilesHeaders#FILE_LAST_MODIFIED"},"CamelFileName":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the output file name (relative to the endpoint directory) to be used for the output message when sending to the endpoint. If this is not present and no expression either, then a generated message ID is used as the filename instead.","constantName":"org.apache.camel.component.file.azure.FilesHeaders#FILE_NAME"},"CamelFileNameOnly":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only the file name (the name with no leading paths).","constantName":"org.apache.camel.component.file.azure.FilesHeaders#FILE_NAME_ONLY"},"CamelFileParent":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent path.","constantName":"org.apache.camel.component.file.azure.FilesHeaders#FILE_PARENT"},"CamelRemoteFileInputStream":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.io.InputStream","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote file input stream.","constantName":"org.apache.camel.component.file.azure.FilesHeaders#REMOTE_FILE_INPUT_STREAM"},"CamelFileLocalWorkPath":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the local work file, if local work directory is used.","constantName":"org.apache.camel.component.file.azure.FilesHeaders#FILE_LOCAL_WORK_PATH"},"CamelFileHost":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote hostname.","constantName":"org.apache.camel.component.file.azure.FilesHeaders#FILE_HOST"}},"properties":{"account":{"index":0,"kind":"path","displayName":"Account","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"The account to use"},"share":{"index":1,"kind":"path","displayName":"Share","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"The share to use"},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"Port of the FTP server"},"directoryName":{"index":3,"kind":"path","displayName":"Directory Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"The starting directory"},"credentialType":{"index":4,"kind":"parameter","displayName":"Credential Type","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.component.file.azure.CredentialType","enum":["SHARED_ACCOUNT_KEY","SHARED_KEY_CREDENTIAL","AZURE_IDENTITY","AZURE_SAS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SHARED_ACCOUNT_KEY","configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"},"disconnect":{"index":5,"kind":"parameter","displayName":"Disconnect","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead."},"doneFileName":{"index":6,"kind":"parameter","displayName":"Done File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders."},"fileName":{"index":7,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."},"sharedKey":{"index":8,"kind":"parameter","displayName":"Shared Key","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"Shared key (storage account key)"},"delete":{"index":9,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file will be deleted after it is processed successfully."},"moveFailed":{"index":10,"kind":"parameter","displayName":"Move Failed","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again."},"noop":{"index":11,"kind":"parameter","displayName":"Noop","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again."},"preMove":{"index":12,"kind":"parameter","displayName":"Pre Move","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order."},"preSort":{"index":13,"kind":"parameter","displayName":"Pre Sort","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled."},"recursive":{"index":14,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If a directory, will look for files in all the sub-directories as well."},"resumeDownload":{"index":15,"kind":"parameter","displayName":"Resume Download","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configures whether resume download is enabled. In addition the options localWorkDirectory must be configured so downloaded files are stored in a local directory, which is required to support resuming of downloads."},"sendEmptyMessageWhenIdle":{"index":16,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"streamDownload":{"index":17,"kind":"parameter","displayName":"Stream Download","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"Sets the download method to use when not using a local working directory. If set to true, the remote files are streamed to the route as they are read. When set to false, the remote files are loaded into memory before being sent into the route. If enabling this option then you must set stepwise=false as both cannot be enabled at the same time."},"bridgeErrorHandler":{"index":18,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"download":{"index":19,"kind":"parameter","displayName":"Download","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded."},"exceptionHandler":{"index":20,"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":{"index":21,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"inProgressRepository":{"index":22,"kind":"parameter","displayName":"In Progress Repository","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."},"localWorkDirectory":{"index":23,"kind":"parameter","displayName":"Local Work Directory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory."},"onCompletionExceptionHandler":{"index":24,"kind":"parameter","displayName":"On Completion Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore."},"pollStrategy":{"index":25,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"processStrategy":{"index":26,"kind":"parameter","displayName":"Process Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileProcessStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply."},"checksumFileAlgorithm":{"index":27,"kind":"parameter","displayName":"Checksum File Algorithm","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["MD2","MD5","SHA_1","SHA_224","SHA_256","SHA_384","SHA_512","SHA_512_224","SHA_512_256","SHA3_224","SHA3_256","SHA3_384","SHA3_512"],"deprecated":false,"autowired":false,"secret":false,"description":"If provided, then Camel will write a checksum file when the original file has been written. The checksum file will contain the checksum created with the provided algorithm for the original file. The checksum file will always be written in the same folder as the original file."},"fileExist":{"index":28,"kind":"parameter","displayName":"File Exist","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExist","enum":["Override","Append","Fail","Ignore","Move","TryRename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Override","description":"What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers."},"flatten":{"index":29,"kind":"parameter","displayName":"Flatten","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."},"jailStartingDirectory":{"index":30,"kind":"parameter","displayName":"Jail Starting Directory","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."},"tempFileName":{"index":31,"kind":"parameter","displayName":"Temp File Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir."},"tempPrefix":{"index":32,"kind":"parameter","displayName":"Temp Prefix","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files."},"allowNullBody":{"index":33,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."},"disconnectOnBatchComplete":{"index":34,"kind":"parameter","displayName":"Disconnect On Batch Complete","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server."},"eagerDeleteTargetFile":{"index":35,"kind":"parameter","displayName":"Eager Delete Target File","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation."},"keepLastModified":{"index":36,"kind":"parameter","displayName":"Keep Last Modified","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers."},"lazyStartProducer":{"index":37,"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."},"moveExistingFileStrategy":{"index":38,"kind":"parameter","displayName":"Move Existing File Strategy","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.strategy.FileMoveExistingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"},"autoCreate":{"index":39,"kind":"parameter","displayName":"Auto Create","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to."},"connectTimeout":{"index":40,"kind":"parameter","displayName":"Connect Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH"},"maximumReconnectAttempts":{"index":41,"kind":"parameter","displayName":"Maximum Reconnect Attempts","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior."},"reconnectDelay":{"index":42,"kind":"parameter","displayName":"Reconnect Delay","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Delay in millis Camel will wait before performing a reconnect attempt."},"throwExceptionOnConnectFailed":{"index":43,"kind":"parameter","displayName":"Throw Exception On Connect Failed","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method."},"timeout":{"index":44,"kind":"parameter","displayName":"Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.file.azure.FilesConfiguration","configurationField":"configuration","description":"Sets the data timeout for waiting for reply Used only by FTPClient"},"antExclude":{"index":45,"kind":"parameter","displayName":"Ant Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format."},"antFilterCaseSensitive":{"index":46,"kind":"parameter","displayName":"Ant Filter Case Sensitive","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets case sensitive flag on ant filter."},"antInclude":{"index":47,"kind":"parameter","displayName":"Ant Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format."},"eagerMaxMessagesPerPoll":{"index":48,"kind":"parameter","displayName":"Eager Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting."},"exclude":{"index":49,"kind":"parameter","displayName":"Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"excludeExt":{"index":50,"kind":"parameter","displayName":"Exclude Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat files, use excludeExt=bak,dat. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"filter":{"index":51,"kind":"parameter","displayName":"Filter","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileFilter","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method."},"filterDirectory":{"index":52,"kind":"parameter","displayName":"Filter Directory","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}"},"filterFile":{"index":53,"kind":"parameter","displayName":"Filter File","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000"},"idempotent":{"index":54,"kind":"parameter","displayName":"Idempotent","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentEager":{"index":55,"kind":"parameter","displayName":"Idempotent Eager","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentKey":{"index":56,"kind":"parameter","displayName":"Idempotent Key","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}"},"idempotentRepository":{"index":57,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true."},"include":{"index":58,"kind":"parameter","displayName":"Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"includeExt":{"index":59,"kind":"parameter","displayName":"Include Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml files, use includeExt=txt,xml. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"maxDepth":{"index":60,"kind":"parameter","displayName":"Max Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"description":"The maximum depth to traverse when recursively processing a directory."},"maxMessagesPerPoll":{"index":61,"kind":"parameter","displayName":"Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards."},"minDepth":{"index":62,"kind":"parameter","displayName":"Min Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory."},"move":{"index":63,"kind":"parameter","displayName":"Move","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done."},"exclusiveReadLockStrategy":{"index":64,"kind":"parameter","displayName":"Exclusive Read Lock Strategy","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation."},"readLock":{"index":65,"kind":"parameter","displayName":"Read Lock","group":"lock","label":"consumer,lock","required":false,"type":"string","javaType":"java.lang.String","enum":["none","markerFile","fileLock","rename","changed","idempotent","idempotent-changed","idempotent-rename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: - none - No read lock is in use - markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component - changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. - fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. - rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. - idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that.Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan."},"readLockCheckInterval":{"index":66,"kind":"parameter","displayName":"Read Lock Check Interval","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"readLockDeleteOrphanLockFiles":{"index":67,"kind":"parameter","displayName":"Read Lock Delete Orphan Lock Files","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory."},"readLockLoggingLevel":{"index":68,"kind":"parameter","displayName":"Read Lock Logging Level","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename."},"readLockMarkerFile":{"index":69,"kind":"parameter","displayName":"Read Lock Marker File","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application."},"readLockMinAge":{"index":70,"kind":"parameter","displayName":"Read Lock Min Age","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age."},"readLockMinLength":{"index":71,"kind":"parameter","displayName":"Read Lock Min Length","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files."},"readLockRemoveOnCommit":{"index":72,"kind":"parameter","displayName":"Read Lock Remove On Commit","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option."},"readLockRemoveOnRollback":{"index":73,"kind":"parameter","displayName":"Read Lock Remove On Rollback","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit)."},"readLockTimeout":{"index":74,"kind":"parameter","displayName":"Read Lock Timeout","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"description":"Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"backoffErrorThreshold":{"index":75,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":76,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":77,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":78,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":79,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":80,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":81,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":82,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":83,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":84,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":85,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":86,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":87,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":88,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"sdd":{"index":89,"kind":"parameter","displayName":"Sdd","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of service SAS token"},"se":{"index":90,"kind":"parameter","displayName":"Se","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"si":{"index":91,"kind":"parameter","displayName":"Si","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of service SAS token"},"sig":{"index":92,"kind":"parameter","displayName":"Sig","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"sip":{"index":93,"kind":"parameter","displayName":"Sip","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"sp":{"index":94,"kind":"parameter","displayName":"Sp","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"spr":{"index":95,"kind":"parameter","displayName":"Spr","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"sr":{"index":96,"kind":"parameter","displayName":"Sr","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of service SAS token"},"srt":{"index":97,"kind":"parameter","displayName":"Srt","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"ss":{"index":98,"kind":"parameter","displayName":"Ss","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of account SAS token"},"st":{"index":99,"kind":"parameter","displayName":"St","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"sv":{"index":100,"kind":"parameter","displayName":"Sv","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.azure.FilesToken","configurationField":"token","description":"part of SAS token"},"shuffle":{"index":101,"kind":"parameter","displayName":"Shuffle","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To shuffle the list of files (sort in random order)"},"sortBy":{"index":102,"kind":"parameter","displayName":"Sort By","group":"sort","label":"consumer,sort","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date."},"sorter":{"index":103,"kind":"parameter","displayName":"Sorter","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"java.util.Comparator>","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable sorter as a java.util.Comparator class."}}} , -{"component":{"kind":"component","name":"azure-key-vault","title":"Azure Key Vault","description":"Manage secrets and keys in Azure Key Vault Service","deprecated":false,"firstVersion":"3.17.0","label":"cloud,cloud","javaType":"org.apache.camel.component.azure.key.vault.KeyVaultComponent","supportLevel":"Stable","metadata":{"vault":"azure-key-vault"},"groupId":"org.apache.camel","artifactId":"camel-azure-key-vault","version":"4.8.1","scheme":"azure-key-vault","extendsScheme":"","syntax":"azure-key-vault:vaultName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAzureKeyVaultProducerOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.azure.key.vault.KeyVaultOperationDefinition","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Overrides the desired operation to be used in the producer.","constantName":"org.apache.camel.component.azure.key.vault.KeyVaultConstants#OPERATION"},"CamelAzureKeyVaultSecretName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The secret name to be used in Key Vault","constantName":"org.apache.camel.component.azure.key.vault.KeyVaultConstants#SECRET_NAME"}},"properties":{"vaultName":{"index":0,"kind":"path","displayName":"Vault Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.key.vault.KeyVaultConfiguration","configurationField":"configuration","description":"Vault Name to be used"},"credentialType":{"index":1,"kind":"parameter","displayName":"Credential Type","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.component.azure.key.vault.CredentialType","enum":["CLIENT_SECRET","AZURE_IDENTITY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CLIENT_SECRET","configurationClass":"org.apache.camel.component.azure.key.vault.KeyVaultConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.azure.key.vault.KeyVaultOperation","enum":["createSecret","getSecret","deleteSecret","purgeDeletedSecret"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.key.vault.KeyVaultConfiguration","configurationField":"configuration","description":"Operation to be performed"},"secretClient":{"index":3,"kind":"parameter","displayName":"Secret Client","group":"producer","label":"","required":false,"type":"object","javaType":"com.azure.security.keyvault.secrets.SecretClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.key.vault.KeyVaultConfiguration","configurationField":"configuration","description":"Instance of Secret client"},"lazyStartProducer":{"index":4,"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."},"clientId":{"index":5,"kind":"parameter","displayName":"Client Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.key.vault.KeyVaultConfiguration","configurationField":"configuration","description":"Client Id to be used"},"clientSecret":{"index":6,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.key.vault.KeyVaultConfiguration","configurationField":"configuration","description":"Client Secret to be used"},"tenantId":{"index":7,"kind":"parameter","displayName":"Tenant Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.key.vault.KeyVaultConfiguration","configurationField":"configuration","description":"Tenant Id to be used"}}} +{"component":{"kind":"component","name":"azure-key-vault","title":"Azure Key Vault","description":"Manage secrets and keys in Azure Key Vault Service","deprecated":false,"firstVersion":"3.17.0","label":"cloud,cloud","javaType":"org.apache.camel.component.azure.key.vault.KeyVaultComponent","supportLevel":"Stable","metadata":{"vault":"azure-key-vault"},"groupId":"org.apache.camel","artifactId":"camel-azure-key-vault","version":"4.8.2","scheme":"azure-key-vault","extendsScheme":"","syntax":"azure-key-vault:vaultName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelAzureKeyVaultProducerOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.azure.key.vault.KeyVaultOperationDefinition","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Overrides the desired operation to be used in the producer.","constantName":"org.apache.camel.component.azure.key.vault.KeyVaultConstants#OPERATION"},"CamelAzureKeyVaultSecretName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The secret name to be used in Key Vault","constantName":"org.apache.camel.component.azure.key.vault.KeyVaultConstants#SECRET_NAME"}},"properties":{"vaultName":{"index":0,"kind":"path","displayName":"Vault Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.key.vault.KeyVaultConfiguration","configurationField":"configuration","description":"Vault Name to be used"},"credentialType":{"index":1,"kind":"parameter","displayName":"Credential Type","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.component.azure.key.vault.CredentialType","enum":["CLIENT_SECRET","AZURE_IDENTITY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CLIENT_SECRET","configurationClass":"org.apache.camel.component.azure.key.vault.KeyVaultConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.azure.key.vault.KeyVaultOperation","enum":["createSecret","getSecret","deleteSecret","purgeDeletedSecret"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.key.vault.KeyVaultConfiguration","configurationField":"configuration","description":"Operation to be performed"},"secretClient":{"index":3,"kind":"parameter","displayName":"Secret Client","group":"producer","label":"","required":false,"type":"object","javaType":"com.azure.security.keyvault.secrets.SecretClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.key.vault.KeyVaultConfiguration","configurationField":"configuration","description":"Instance of Secret client"},"lazyStartProducer":{"index":4,"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."},"clientId":{"index":5,"kind":"parameter","displayName":"Client Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.key.vault.KeyVaultConfiguration","configurationField":"configuration","description":"Client Id to be used"},"clientSecret":{"index":6,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.key.vault.KeyVaultConfiguration","configurationField":"configuration","description":"Client Secret to be used"},"tenantId":{"index":7,"kind":"parameter","displayName":"Tenant Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.key.vault.KeyVaultConfiguration","configurationField":"configuration","description":"Tenant Id to be used"}}} , -{"component":{"kind":"component","name":"azure-servicebus","title":"Azure ServiceBus","description":"Send and receive messages to/from Azure Service 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":"4.8.1","scheme":"azure-servicebus","extendsScheme":"","syntax":"azure-servicebus:topicOrQueueName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAzureServiceBusApplicationProperties":{"index":0,"kind":"header","displayName":"","group":"common","label":"common","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The application properties (also known as custom properties) on messages sent and received by the producer and consumer, respectively.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#APPLICATION_PROPERTIES"},"CamelAzureServiceBusContentType":{"index":1,"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"},"CamelAzureServiceBusDeadLetterErrorDescription":{"index":2,"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":{"index":3,"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":{"index":4,"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":{"index":5,"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":{"index":6,"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":{"index":7,"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":{"index":8,"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":{"index":9,"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":{"index":10,"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":{"index":11,"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":{"index":12,"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":{"index":13,"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":{"index":14,"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":{"index":15,"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":{"index":16,"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":{"index":17,"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":{"index":18,"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":{"index":19,"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":{"index":20,"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":{"index":21,"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":{"index":22,"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":{"index":23,"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"},"CamelAzureServiceBusCorrelationId":{"index":24,"kind":"header","displayName":"","group":"common","label":"common","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets or Sets a correlation identifier.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#CORRELATION_ID"}},"properties":{"topicOrQueueName":{"index":0,"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":{"index":1,"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":{"index":2,"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 AMQP."},"clientOptions":{"index":3,"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."},"headerFilterStrategy":{"index":4,"kind":"parameter","displayName":"Header Filter Strategy","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"To use a custom HeaderFilterStrategy to filter Service Bus application properties to and from Camel message headers."},"proxyOptions":{"index":5,"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 ServiceBusSenderClient. When a proxy is configured, AMQP_WEB_SOCKETS must be used for the transport type."},"serviceBusType":{"index":6,"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."},"enableDeadLettering":{"index":7,"kind":"parameter","displayName":"Enable Dead Lettering","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":"Enable application level deadlettering to the subscription deadletter subqueue if deadletter related headers are set."},"maxAutoLockRenewDuration":{"index":8,"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 ZERO disables auto-renewal. For ServiceBus receive mode (RECEIVE_AND_DELETE RECEIVE_AND_DELETE), auto-renewal is disabled."},"maxConcurrentCalls":{"index":9,"kind":"parameter","displayName":"Max Concurrent Calls","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets maximum number of concurrent calls"},"prefetchCount":{"index":10,"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 PEEK_LOCK PEEK_LOCK and RECEIVE_AND_DELETE RECEIVE_AND_DELETE receive 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 receive message. Setting a non-zero value will prefetch that number of messages. Setting the value to zero turns prefetch off."},"processorClient":{"index":11,"kind":"parameter","displayName":"Processor Client","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.azure.messaging.servicebus.ServiceBusProcessorClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the processorClient in order to consume messages by the consumer"},"serviceBusReceiveMode":{"index":12,"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":{"index":13,"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":{"index":14,"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":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"binary":{"index":18,"kind":"parameter","displayName":"Binary","group":"producer","label":"producer","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":"Set binary mode. If true, message body will be sent as byte. By default, it is false."},"producerOperation":{"index":19,"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":{"index":20,"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."},"senderClient":{"index":21,"kind":"parameter","displayName":"Sender Client","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.azure.messaging.servicebus.ServiceBusSenderClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets senderClient to be used in the producer."},"serviceBusTransactionContext":{"index":22,"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":{"index":23,"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":{"index":24,"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."},"credentialType":{"index":25,"kind":"parameter","displayName":"Credential Type","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.azure.servicebus.CredentialType","enum":["AZURE_IDENTITY","CONNECTION_STRING","TOKEN_CREDENTIAL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CONNECTION_STRING","configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"},"fullyQualifiedNamespace":{"index":26,"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":{"index":27,"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."}}} +{"component":{"kind":"component","name":"azure-servicebus","title":"Azure ServiceBus","description":"Send and receive messages to/from Azure Service 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":"4.8.2","scheme":"azure-servicebus","extendsScheme":"","syntax":"azure-servicebus:topicOrQueueName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAzureServiceBusApplicationProperties":{"index":0,"kind":"header","displayName":"","group":"common","label":"common","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The application properties (also known as custom properties) on messages sent and received by the producer and consumer, respectively.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#APPLICATION_PROPERTIES"},"CamelAzureServiceBusContentType":{"index":1,"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"},"CamelAzureServiceBusDeadLetterErrorDescription":{"index":2,"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":{"index":3,"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":{"index":4,"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":{"index":5,"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":{"index":6,"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":{"index":7,"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":{"index":8,"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":{"index":9,"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":{"index":10,"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":{"index":11,"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":{"index":12,"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":{"index":13,"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":{"index":14,"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":{"index":15,"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":{"index":16,"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":{"index":17,"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":{"index":18,"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":{"index":19,"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":{"index":20,"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":{"index":21,"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":{"index":22,"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":{"index":23,"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"},"CamelAzureServiceBusCorrelationId":{"index":24,"kind":"header","displayName":"","group":"common","label":"common","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets or Sets a correlation identifier.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#CORRELATION_ID"}},"properties":{"topicOrQueueName":{"index":0,"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":{"index":1,"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":{"index":2,"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 AMQP."},"clientOptions":{"index":3,"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."},"headerFilterStrategy":{"index":4,"kind":"parameter","displayName":"Header Filter Strategy","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"To use a custom HeaderFilterStrategy to filter Service Bus application properties to and from Camel message headers."},"proxyOptions":{"index":5,"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 ServiceBusSenderClient. When a proxy is configured, AMQP_WEB_SOCKETS must be used for the transport type."},"serviceBusType":{"index":6,"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."},"enableDeadLettering":{"index":7,"kind":"parameter","displayName":"Enable Dead Lettering","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":"Enable application level deadlettering to the subscription deadletter subqueue if deadletter related headers are set."},"maxAutoLockRenewDuration":{"index":8,"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 ZERO disables auto-renewal. For ServiceBus receive mode (RECEIVE_AND_DELETE RECEIVE_AND_DELETE), auto-renewal is disabled."},"maxConcurrentCalls":{"index":9,"kind":"parameter","displayName":"Max Concurrent Calls","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets maximum number of concurrent calls"},"prefetchCount":{"index":10,"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 PEEK_LOCK PEEK_LOCK and RECEIVE_AND_DELETE RECEIVE_AND_DELETE receive 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 receive message. Setting a non-zero value will prefetch that number of messages. Setting the value to zero turns prefetch off."},"processorClient":{"index":11,"kind":"parameter","displayName":"Processor Client","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.azure.messaging.servicebus.ServiceBusProcessorClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the processorClient in order to consume messages by the consumer"},"serviceBusReceiveMode":{"index":12,"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":{"index":13,"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":{"index":14,"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":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"binary":{"index":18,"kind":"parameter","displayName":"Binary","group":"producer","label":"producer","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":"Set binary mode. If true, message body will be sent as byte. By default, it is false."},"producerOperation":{"index":19,"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":{"index":20,"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."},"senderClient":{"index":21,"kind":"parameter","displayName":"Sender Client","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.azure.messaging.servicebus.ServiceBusSenderClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets senderClient to be used in the producer."},"serviceBusTransactionContext":{"index":22,"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":{"index":23,"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":{"index":24,"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."},"credentialType":{"index":25,"kind":"parameter","displayName":"Credential Type","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.azure.servicebus.CredentialType","enum":["AZURE_IDENTITY","CONNECTION_STRING","TOKEN_CREDENTIAL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CONNECTION_STRING","configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"},"fullyQualifiedNamespace":{"index":26,"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":{"index":27,"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."}}} , -{"component":{"kind":"component","name":"azure-storage-blob","title":"Azure Storage Blob Service","description":"Store and retrieve blobs from Azure Storage Blob Service.","deprecated":false,"firstVersion":"3.3.0","label":"cloud,file","javaType":"org.apache.camel.component.azure.storage.blob.BlobComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-azure-storage-blob","version":"4.8.1","scheme":"azure-storage-blob","extendsScheme":"","syntax":"azure-storage-blob:accountName/containerName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAzureStorageBlobOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.azure.storage.blob.BlobOperationsDefinition","enum":["listBlobContainers","createBlobContainer","deleteBlobContainer","listBlobs","getBlob","deleteBlob","downloadBlobToFile","downloadLink","uploadBlockBlob","stageBlockBlobList","commitBlobBlockList","getBlobBlockList","createAppendBlob","commitAppendBlob","createPageBlob","uploadPageBlob","resizePageBlob","clearPageBlob","getPageBlobRanges","getChangeFeed","copyBlob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(All) Specify the producer operation to execute, please see the doc on this page related to producer operation.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_OPERATION"},"CamelAzureStorageBlobHttpHeaders":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"BlobHttpHeaders","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(uploadBlockBlob, commitBlobBlockList, createAppendBlob, createPageBlob) Additional parameters for a set of operations.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_HTTP_HEADERS"},"CamelAzureStorageBlobETag":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The E Tag of the blob","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#E_TAG"},"CamelAzureStorageBlobCreationTime":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Creation time of the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CREATION_TIME"},"CamelAzureStorageBlobLastModified":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Datetime when the blob was last modified.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#LAST_MODIFIED"},"CamelAzureStorageBlobContentType":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content type specified for the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CONTENT_TYPE"},"CamelAzureStorageBlobContentMD5":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) (Most operations related to upload blob) Most operations related to upload blobAn MD5 hash of the block content. This hash is used to verify the integrity of the block during transport. When this header is specified, the storage service compares the hash of the content that has arrived with this header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the operation will fail. (consumer) Content MD5 specified for the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CONTENT_MD5"},"CamelAzureStorageBlobContentEncoding":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content encoding specified for the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CONTENT_ENCODING"},"CamelAzureStorageBlobContentDisposition":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content disposition specified for the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CONTENT_DISPOSITION"},"CamelAzureStorageBlobContentLanguage":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content language specified for the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CONTENT_LANGUAGE"},"CamelAzureStorageBlobCacheControl":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cache control specified for the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CACHE_CONTROL"},"CamelAzureStorageBlobBlobSize":{"index":11,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_SIZE"},"CamelAzureStorageBlobBlobUploadSize":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When uploading a blob with the uploadBlockBlob-operation this can be used to tell the client what the length of an InputStream is.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_UPLOAD_SIZE"},"CamelAzureStorageBlobSequenceNumber":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) (createPageBlob) A user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 263 - 1. The default value is 0. (consumer) The current sequence number for a page blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_SEQUENCE_NUMBER"},"CamelAzureStorageBlobBlobType":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.azure.storage.blob.BlobType","enum":["blockblob","appendblob","pageblob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_TYPE"},"CamelAzureStorageBlobLeaseStatus":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.blob.models.LeaseStatusType","enum":["locked","unlocked"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Status of the lease on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#LEASE_STATUS"},"CamelAzureStorageBlobLeaseState":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.blob.models.LeaseStateType","enum":["available","leased","expired","breaking","broken"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"State of the lease on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#LEASE_STATE"},"CamelAzureStorageBlobLeaseDuration":{"index":17,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.blob.models.LeaseDurationType","enum":["infinite","fixed"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Type of lease on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#LEASE_DURATION"},"CamelAzureStorageBlobCopyId":{"index":18,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Identifier of the last copy operation performed on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COPY_ID"},"CamelAzureStorageBlobCopyStatus":{"index":19,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.blob.models.CopyStatusType","enum":["pending","success","aborted","failed"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Status of the last copy operation performed on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COPY_STATUS"},"CamelAzureStorageBlobCopySource":{"index":20,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Source of the last copy operation performed on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COPY_SOURCE"},"CamelAzureStorageBlobCopyProgress":{"index":21,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Progress of the last copy operation performed on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COPY_PROGRESS"},"CamelAzureStorageBlobCopyCompletionTime":{"index":22,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Datetime when the last copy operation on the blob completed.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COPY_COMPILATION_TIME"},"CamelAzureStorageBlobCopyStatusDescription":{"index":23,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Description of the last copy operation on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COPY_STATUS_DESCRIPTION"},"CamelAzureStorageBlobCopyDestinationSnapshot":{"index":24,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Snapshot identifier of the last incremental copy snapshot for the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COPY_DESTINATION_SNAPSHOT"},"CamelAzureStorageBlobIsServerEncrypted":{"index":25,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Flag indicating if the blob's content is encrypted on the server.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#IS_SERVER_ENCRYPTED"},"CamelAzureStorageBlobIsIncrementalCopy":{"index":26,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Flag indicating if the blob was incrementally copied.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#IS_INCREMENTAL_COPY"},"CamelAzureStorageBlobAccessTier":{"index":27,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"AccessTier","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) (uploadBlockBlob, commitBlobBlockList) Defines values for AccessTier. (consumer) Access tier of the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#ACCESS_TIER"},"CamelAzureStorageBlobIsAccessTierInferred":{"index":28,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Flag indicating if the access tier of the blob was inferred from properties of the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#IS_ACCESS_TIER_INFRRRED"},"CamelAzureStorageBlobArchiveStatus":{"index":29,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"ArchiveStatus","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Archive status of the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#ARCHIVE_STATUS"},"CamelAzureStorageBlobaccessTierChangeTime":{"index":30,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Datetime when the access tier of the blob last changed.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#ACCESS_TIER_CHANGE_TIME"},"CamelAzureStorageBlobMetadata":{"index":31,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) (Operations related to container and blob) Operations related to container and blob Metadata to associate with the container or blob. (consumer) Additional metadata associated with the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#METADATA"},"CamelAzureStorageBlobCommittedBlockCount":{"index":32,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Number of blocks committed to an append blob","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COMMITTED_BLOCK_COUNT"},"CamelAzureStorageBlobAppendOffset":{"index":33,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The offset at which the block was committed to the block blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#APPEND_OFFSET"},"CamelAzureStorageBlobRawHttpHeaders":{"index":34,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"HttpHeaders","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Returns non-parsed httpHeaders that can be used by the user.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#RAW_HTTP_HEADERS"},"CamelAzureStorageBlobFileName":{"index":35,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The downloaded filename from the operation downloadBlobToFile.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#FILE_NAME"},"CamelAzureStorageBlobDownloadLink":{"index":36,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The download link generated by downloadLink operation.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#DOWNLOAD_LINK"},"CamelAzureStorageBlobListBlobOptions":{"index":37,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"ListBlobsOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(listBlobs) Defines options available to configure the behavior of a call to listBlobsFlatSegment on a BlobContainerClient object.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#LIST_BLOB_OPTIONS"},"CamelAzureStorageBlobListDetails":{"index":38,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"BlobListDetails","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(listBlobs) The details for listing specific blobs","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_LIST_DETAILS"},"CamelAzureStorageBlobPrefix":{"index":39,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(listBlobs,getBlob) Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#PREFIX"},"CamelAzureStorageBlobRegex":{"index":40,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(listBlobs,getBlob) Filters the results to return only blobs whose names match the specified regular expression. May be null to return all. If both prefix and regex are set, regex takes the priority and prefix is ignored.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#REGEX"},"CamelAzureStorageBlobMaxResultsPerPage":{"index":41,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(listBlobs) Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#MAX_RESULTS_PER_PAGE"},"CamelAzureStorageBlobTimeout":{"index":42,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Duration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(All) An optional timeout value beyond which a RuntimeException will be raised.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#TIMEOUT"},"CamelAzureStorageBlobPublicAccessType":{"index":43,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"PublicAccessType","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(createContainer) Specifies how the data in this container is available to the public. Pass null for no public access.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#PUBLIC_ACCESS_TYPE"},"CamelAzureStorageBlobRequestCondition":{"index":44,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"BlobRequestConditions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(Operations related to container and blob) This contains values which will restrict the successful operation of a variety of requests to the conditions present. These conditions are entirely optional.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_REQUEST_CONDITION"},"CamelAzureStorageBlobBlobContainerName":{"index":45,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(Operations related to container and blob) Override/set the container name on the exchange headers.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_CONTAINER_NAME"},"CamelAzureStorageBlobBlobName":{"index":46,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(Operations related to blob) Override/set the blob name on the exchange headers.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_NAME"},"CamelAzureStorageBlobFileDir":{"index":47,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(downloadBlobToFile) The file directory where the downloaded blobs will be saved to.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#FILE_DIR"},"CamelAzureStorageBlobPageBlobRange":{"index":48,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"PageRange","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(Operations related to page blob) A PageRange object. Given that pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the end offset must be a modulus of 512 - 1. Examples of valid byte ranges are 0-511, 512-1023, etc.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#PAGE_BLOB_RANGE"},"CamelAzureStorageBlobPageBlobSize":{"index":49,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(createPageBlob, resizePageBlob) Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a 512-byte boundary.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#PAGE_BLOB_SIZE"},"CamelAzureStorageBlobCommitBlobBlockListLater":{"index":50,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(stageBlockBlobList) When is set to true, the staged blocks will not be committed directly.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COMMIT_BLOCK_LIST_LATER"},"CamelAzureStorageBlobBlockListType":{"index":51,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"com.azure.storage.blob.models.BlockListType","enum":["committed","uncommitted","all"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(getBlobBlockList) Specifies which type of blocks to return.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOCK_LIST_TYPE"},"CamelAzureStorageBlobCreateAppendBlob":{"index":52,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(commitAppendBlob) When is set to true, the append blocks will be created when committing append blocks.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CREATE_APPEND_BLOB"},"CamelAzureStorageBlobCreatePageBlob":{"index":53,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(uploadPageBlob) When is set to true, the page blob will be created when uploading page blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CREATE_PAGE_BLOB"},"CamelAzureStorageBlobDeleteSnapshotsOptionType":{"index":54,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"com.azure.storage.blob.models.DeleteSnapshotsOptionType","enum":["include","only"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(deleteBlob) Specifies the behavior for deleting the snapshots on this blob. Include will delete the base blob and all snapshots. Only will delete only the snapshots. If a snapshot is being deleted, you must pass null.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#DELETE_SNAPSHOT_OPTION_TYPE"},"CamelAzureStorageBlobListBlobContainersOptions":{"index":55,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"ListBlobContainersOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(listBlobContainers) A ListBlobContainersOptions which specifies what data should be returned by the service.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#LIST_BLOB_CONTAINERS_OPTIONS"},"CamelAzureStorageBlobParallelTransferOptions":{"index":56,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"ParallelTransferOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(downloadBlobToFile) ParallelTransferOptions to use to download to file. Number of parallel transfers parameter is ignored.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#PARALLEL_TRANSFER_OPTIONS"},"CamelAzureStorageBlobDownloadLinkExpiration":{"index":57,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(downloadLink) Override the default expiration (millis) of URL download link.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#DOWNLOAD_LINK_EXPIRATION"},"CamelAzureStorageBlobSourceBlobAccountName":{"index":58,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(copyBlob) The source blob account name to be used as source account name in a copy blob operation","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#SOURCE_BLOB_ACCOUNT_NAME"},"CamelAzureStorageBlobSourceBlobContainerName":{"index":59,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(copyBlob) The source blob container name to be used as source container name in a copy blob operation","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#SOURCE_BLOB_CONTAINER_NAME"},"CamelAzureStorageBlobChangeFeedStartTime":{"index":60,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(getChangeFeed) It filters the results to return events approximately after the start time. Note: A few events belonging to the previous hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the start time down by an hour.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CHANGE_FEED_START_TIME"},"CamelAzureStorageBlobChangeFeedEndTime":{"index":61,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(getChangeFeed) It filters the results to return events approximately before the end time. Note: A few events belonging to the next hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the end time up by an hour.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CHANGE_FEED_END_TIME"},"CamelAzureStorageBlobContext":{"index":62,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Context","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(getChangeFeed) This gives additional context that is passed through the Http pipeline during the service call.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CHANGE_FEED_CONTEXT"}},"properties":{"accountName":{"index":0,"kind":"path","displayName":"Account Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Azure account name to be used for authentication with azure blob services"},"containerName":{"index":1,"kind":"path","displayName":"Container Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"The blob container name"},"blobName":{"index":2,"kind":"parameter","displayName":"Blob Name","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"The blob name, to consume specific blob from a container. However, on producer it is only required for the operations on the blob level"},"blobOffset":{"index":3,"kind":"parameter","displayName":"Blob Offset","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Set the blob offset for the upload or download operations, default is 0"},"blobServiceClient":{"index":4,"kind":"parameter","displayName":"Blob Service Client","group":"common","label":"","required":false,"type":"object","javaType":"com.azure.storage.blob.BlobServiceClient","deprecated":false,"autowired":false,"secret":false,"description":"Client to a storage account. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to blobs and containers. This client contains operations on a service account. Operations on a container are available on BlobContainerClient through getBlobContainerClient(String), and operations on a blob are available on BlobClient through getBlobContainerClient(String).getBlobClient(String)."},"blobType":{"index":5,"kind":"parameter","displayName":"Blob Type","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.component.azure.storage.blob.BlobType","enum":["blockblob","appendblob","pageblob"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"blockblob","configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"The blob type in order to initiate the appropriate settings for each blob type"},"closeStreamAfterRead":{"index":6,"kind":"parameter","displayName":"Close Stream After Read","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Close the stream after read or keep it open, default is true"},"credentials":{"index":7,"kind":"parameter","displayName":"Credentials","group":"common","label":"","required":false,"type":"object","javaType":"com.azure.storage.common.StorageSharedKeyCredential","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information"},"credentialType":{"index":8,"kind":"parameter","displayName":"Credential Type","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.component.azure.storage.blob.CredentialType","enum":["SHARED_ACCOUNT_KEY","SHARED_KEY_CREDENTIAL","AZURE_IDENTITY","AZURE_SAS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AZURE_IDENTITY","configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"},"dataCount":{"index":9,"kind":"parameter","displayName":"Data Count","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"How many bytes to include in the range. Must be greater than or equal to 0 if specified."},"fileDir":{"index":10,"kind":"parameter","displayName":"File Dir","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"The file directory where the downloaded blobs will be saved to, this can be used in both, producer and consumer"},"maxResultsPerPage":{"index":11,"kind":"parameter","displayName":"Max Results Per Page","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items."},"maxRetryRequests":{"index":12,"kind":"parameter","displayName":"Max Retry Requests","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a response body."},"prefix":{"index":13,"kind":"parameter","displayName":"Prefix","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs."},"regex":{"index":14,"kind":"parameter","displayName":"Regex","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Filters the results to return only blobs whose names match the specified regular expression. May be null to return all if both prefix and regex are set, regex takes the priority and prefix is ignored."},"sasToken":{"index":15,"kind":"parameter","displayName":"Sas Token","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"In case of usage of Shared Access Signature we'll need to set a SAS Token"},"serviceClient":{"index":16,"kind":"parameter","displayName":"Service Client","group":"common","label":"","required":false,"type":"object","javaType":"com.azure.storage.blob.BlobServiceClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Client to a storage account. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to blobs and containers. This client contains operations on a service account. Operations on a container are available on BlobContainerClient through BlobServiceClient#getBlobContainerClient(String), and operations on a blob are available on BlobClient through BlobContainerClient#getBlobClient(String)."},"timeout":{"index":17,"kind":"parameter","displayName":"Timeout","group":"common","label":"common","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"An optional timeout value beyond which a RuntimeException will be raised."},"sendEmptyMessageWhenIdle":{"index":18,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":19,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":20,"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":{"index":21,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":22,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"blobSequenceNumber":{"index":23,"kind":"parameter","displayName":"Blob Sequence Number","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"A user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 263 - 1.The default value is 0."},"blockListType":{"index":24,"kind":"parameter","displayName":"Block List Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.azure.storage.blob.models.BlockListType","enum":["committed","uncommitted","all"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"COMMITTED","configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Specifies which type of blocks to return."},"changeFeedContext":{"index":25,"kind":"parameter","displayName":"Change Feed Context","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.azure.core.util.Context","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"When using getChangeFeed producer operation, this gives additional context that is passed through the Http pipeline during the service call."},"changeFeedEndTime":{"index":26,"kind":"parameter","displayName":"Change Feed End 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.storage.blob.BlobConfiguration","configurationField":"configuration","description":"When using getChangeFeed producer operation, this filters the results to return events approximately before the end time. Note: A few events belonging to the next hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the end time up by an hour."},"changeFeedStartTime":{"index":27,"kind":"parameter","displayName":"Change Feed Start 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.storage.blob.BlobConfiguration","configurationField":"configuration","description":"When using getChangeFeed producer operation, this filters the results to return events approximately after the start time. Note: A few events belonging to the previous hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the start time down by an hour."},"closeStreamAfterWrite":{"index":28,"kind":"parameter","displayName":"Close Stream After Write","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Close the stream after write or keep it open, default is true"},"commitBlockListLater":{"index":29,"kind":"parameter","displayName":"Commit Block List Later","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"When is set to true, the staged blocks will not be committed directly."},"createAppendBlob":{"index":30,"kind":"parameter","displayName":"Create Append Blob","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"When is set to true, the append blocks will be created when committing append blocks."},"createPageBlob":{"index":31,"kind":"parameter","displayName":"Create Page Blob","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"When is set to true, the page blob will be created when uploading page blob."},"downloadLinkExpiration":{"index":32,"kind":"parameter","displayName":"Download Link Expiration","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Override the default expiration (millis) of URL download link."},"operation":{"index":33,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.azure.storage.blob.BlobOperationsDefinition","enum":["listBlobContainers","createBlobContainer","deleteBlobContainer","listBlobs","getBlob","deleteBlob","downloadBlobToFile","downloadLink","uploadBlockBlob","stageBlockBlobList","commitBlobBlockList","getBlobBlockList","createAppendBlob","commitAppendBlob","createPageBlob","uploadPageBlob","resizePageBlob","clearPageBlob","getPageBlobRanges"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"listBlobContainers","configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"The blob operation that can be used with this component on the producer"},"pageBlobSize":{"index":34,"kind":"parameter","displayName":"Page Blob Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"512","configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a 512-byte boundary."},"lazyStartProducer":{"index":35,"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."},"backoffErrorThreshold":{"index":36,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":37,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":38,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":39,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":40,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":41,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":42,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":43,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":44,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":45,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":46,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":47,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":48,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":49,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":50,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Access key for the associated azure account name to be used for authentication with azure blob services"},"sourceBlobAccessKey":{"index":51,"kind":"parameter","displayName":"Source Blob Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Source Blob Access Key: for copyblob operation, sadly, we need to have an accessKey for the source blob we want to copy Passing an accessKey as header, it's unsafe so we could set as key."}}} +{"component":{"kind":"component","name":"azure-storage-blob","title":"Azure Storage Blob Service","description":"Store and retrieve blobs from Azure Storage Blob Service.","deprecated":false,"firstVersion":"3.3.0","label":"cloud,file","javaType":"org.apache.camel.component.azure.storage.blob.BlobComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-azure-storage-blob","version":"4.8.2","scheme":"azure-storage-blob","extendsScheme":"","syntax":"azure-storage-blob:accountName/containerName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAzureStorageBlobOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.azure.storage.blob.BlobOperationsDefinition","enum":["listBlobContainers","createBlobContainer","deleteBlobContainer","listBlobs","getBlob","deleteBlob","downloadBlobToFile","downloadLink","uploadBlockBlob","stageBlockBlobList","commitBlobBlockList","getBlobBlockList","createAppendBlob","commitAppendBlob","createPageBlob","uploadPageBlob","resizePageBlob","clearPageBlob","getPageBlobRanges","getChangeFeed","copyBlob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(All) Specify the producer operation to execute, please see the doc on this page related to producer operation.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_OPERATION"},"CamelAzureStorageBlobHttpHeaders":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"BlobHttpHeaders","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(uploadBlockBlob, commitBlobBlockList, createAppendBlob, createPageBlob) Additional parameters for a set of operations.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_HTTP_HEADERS"},"CamelAzureStorageBlobETag":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The E Tag of the blob","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#E_TAG"},"CamelAzureStorageBlobCreationTime":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Creation time of the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CREATION_TIME"},"CamelAzureStorageBlobLastModified":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Datetime when the blob was last modified.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#LAST_MODIFIED"},"CamelAzureStorageBlobContentType":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content type specified for the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CONTENT_TYPE"},"CamelAzureStorageBlobContentMD5":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) (Most operations related to upload blob) Most operations related to upload blobAn MD5 hash of the block content. This hash is used to verify the integrity of the block during transport. When this header is specified, the storage service compares the hash of the content that has arrived with this header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the operation will fail. (consumer) Content MD5 specified for the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CONTENT_MD5"},"CamelAzureStorageBlobContentEncoding":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content encoding specified for the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CONTENT_ENCODING"},"CamelAzureStorageBlobContentDisposition":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content disposition specified for the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CONTENT_DISPOSITION"},"CamelAzureStorageBlobContentLanguage":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content language specified for the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CONTENT_LANGUAGE"},"CamelAzureStorageBlobCacheControl":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cache control specified for the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CACHE_CONTROL"},"CamelAzureStorageBlobBlobSize":{"index":11,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_SIZE"},"CamelAzureStorageBlobBlobUploadSize":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When uploading a blob with the uploadBlockBlob-operation this can be used to tell the client what the length of an InputStream is.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_UPLOAD_SIZE"},"CamelAzureStorageBlobSequenceNumber":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) (createPageBlob) A user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 263 - 1. The default value is 0. (consumer) The current sequence number for a page blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_SEQUENCE_NUMBER"},"CamelAzureStorageBlobBlobType":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.azure.storage.blob.BlobType","enum":["blockblob","appendblob","pageblob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_TYPE"},"CamelAzureStorageBlobLeaseStatus":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.blob.models.LeaseStatusType","enum":["locked","unlocked"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Status of the lease on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#LEASE_STATUS"},"CamelAzureStorageBlobLeaseState":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.blob.models.LeaseStateType","enum":["available","leased","expired","breaking","broken"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"State of the lease on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#LEASE_STATE"},"CamelAzureStorageBlobLeaseDuration":{"index":17,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.blob.models.LeaseDurationType","enum":["infinite","fixed"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Type of lease on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#LEASE_DURATION"},"CamelAzureStorageBlobCopyId":{"index":18,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Identifier of the last copy operation performed on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COPY_ID"},"CamelAzureStorageBlobCopyStatus":{"index":19,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.blob.models.CopyStatusType","enum":["pending","success","aborted","failed"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Status of the last copy operation performed on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COPY_STATUS"},"CamelAzureStorageBlobCopySource":{"index":20,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Source of the last copy operation performed on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COPY_SOURCE"},"CamelAzureStorageBlobCopyProgress":{"index":21,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Progress of the last copy operation performed on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COPY_PROGRESS"},"CamelAzureStorageBlobCopyCompletionTime":{"index":22,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Datetime when the last copy operation on the blob completed.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COPY_COMPILATION_TIME"},"CamelAzureStorageBlobCopyStatusDescription":{"index":23,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Description of the last copy operation on the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COPY_STATUS_DESCRIPTION"},"CamelAzureStorageBlobCopyDestinationSnapshot":{"index":24,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Snapshot identifier of the last incremental copy snapshot for the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COPY_DESTINATION_SNAPSHOT"},"CamelAzureStorageBlobIsServerEncrypted":{"index":25,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Flag indicating if the blob's content is encrypted on the server.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#IS_SERVER_ENCRYPTED"},"CamelAzureStorageBlobIsIncrementalCopy":{"index":26,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Flag indicating if the blob was incrementally copied.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#IS_INCREMENTAL_COPY"},"CamelAzureStorageBlobAccessTier":{"index":27,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"AccessTier","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) (uploadBlockBlob, commitBlobBlockList) Defines values for AccessTier. (consumer) Access tier of the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#ACCESS_TIER"},"CamelAzureStorageBlobIsAccessTierInferred":{"index":28,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Flag indicating if the access tier of the blob was inferred from properties of the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#IS_ACCESS_TIER_INFRRRED"},"CamelAzureStorageBlobArchiveStatus":{"index":29,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"ArchiveStatus","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Archive status of the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#ARCHIVE_STATUS"},"CamelAzureStorageBlobaccessTierChangeTime":{"index":30,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Datetime when the access tier of the blob last changed.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#ACCESS_TIER_CHANGE_TIME"},"CamelAzureStorageBlobMetadata":{"index":31,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) (Operations related to container and blob) Operations related to container and blob Metadata to associate with the container or blob. (consumer) Additional metadata associated with the blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#METADATA"},"CamelAzureStorageBlobCommittedBlockCount":{"index":32,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Number of blocks committed to an append blob","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COMMITTED_BLOCK_COUNT"},"CamelAzureStorageBlobAppendOffset":{"index":33,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The offset at which the block was committed to the block blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#APPEND_OFFSET"},"CamelAzureStorageBlobRawHttpHeaders":{"index":34,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"HttpHeaders","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Returns non-parsed httpHeaders that can be used by the user.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#RAW_HTTP_HEADERS"},"CamelAzureStorageBlobFileName":{"index":35,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The downloaded filename from the operation downloadBlobToFile.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#FILE_NAME"},"CamelAzureStorageBlobDownloadLink":{"index":36,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The download link generated by downloadLink operation.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#DOWNLOAD_LINK"},"CamelAzureStorageBlobListBlobOptions":{"index":37,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"ListBlobsOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(listBlobs) Defines options available to configure the behavior of a call to listBlobsFlatSegment on a BlobContainerClient object.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#LIST_BLOB_OPTIONS"},"CamelAzureStorageBlobListDetails":{"index":38,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"BlobListDetails","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(listBlobs) The details for listing specific blobs","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_LIST_DETAILS"},"CamelAzureStorageBlobPrefix":{"index":39,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(listBlobs,getBlob) Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#PREFIX"},"CamelAzureStorageBlobRegex":{"index":40,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(listBlobs,getBlob) Filters the results to return only blobs whose names match the specified regular expression. May be null to return all. If both prefix and regex are set, regex takes the priority and prefix is ignored.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#REGEX"},"CamelAzureStorageBlobMaxResultsPerPage":{"index":41,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(listBlobs) Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#MAX_RESULTS_PER_PAGE"},"CamelAzureStorageBlobTimeout":{"index":42,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Duration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(All) An optional timeout value beyond which a RuntimeException will be raised.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#TIMEOUT"},"CamelAzureStorageBlobPublicAccessType":{"index":43,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"PublicAccessType","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(createContainer) Specifies how the data in this container is available to the public. Pass null for no public access.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#PUBLIC_ACCESS_TYPE"},"CamelAzureStorageBlobRequestCondition":{"index":44,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"BlobRequestConditions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(Operations related to container and blob) This contains values which will restrict the successful operation of a variety of requests to the conditions present. These conditions are entirely optional.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_REQUEST_CONDITION"},"CamelAzureStorageBlobBlobContainerName":{"index":45,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(Operations related to container and blob) Override/set the container name on the exchange headers.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_CONTAINER_NAME"},"CamelAzureStorageBlobBlobName":{"index":46,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(Operations related to blob) Override/set the blob name on the exchange headers.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOB_NAME"},"CamelAzureStorageBlobFileDir":{"index":47,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(downloadBlobToFile) The file directory where the downloaded blobs will be saved to.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#FILE_DIR"},"CamelAzureStorageBlobPageBlobRange":{"index":48,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"PageRange","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(Operations related to page blob) A PageRange object. Given that pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the end offset must be a modulus of 512 - 1. Examples of valid byte ranges are 0-511, 512-1023, etc.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#PAGE_BLOB_RANGE"},"CamelAzureStorageBlobPageBlobSize":{"index":49,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(createPageBlob, resizePageBlob) Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a 512-byte boundary.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#PAGE_BLOB_SIZE"},"CamelAzureStorageBlobCommitBlobBlockListLater":{"index":50,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(stageBlockBlobList) When is set to true, the staged blocks will not be committed directly.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#COMMIT_BLOCK_LIST_LATER"},"CamelAzureStorageBlobBlockListType":{"index":51,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"com.azure.storage.blob.models.BlockListType","enum":["committed","uncommitted","all"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(getBlobBlockList) Specifies which type of blocks to return.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#BLOCK_LIST_TYPE"},"CamelAzureStorageBlobCreateAppendBlob":{"index":52,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(commitAppendBlob) When is set to true, the append blocks will be created when committing append blocks.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CREATE_APPEND_BLOB"},"CamelAzureStorageBlobCreatePageBlob":{"index":53,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(uploadPageBlob) When is set to true, the page blob will be created when uploading page blob.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CREATE_PAGE_BLOB"},"CamelAzureStorageBlobDeleteSnapshotsOptionType":{"index":54,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"com.azure.storage.blob.models.DeleteSnapshotsOptionType","enum":["include","only"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(deleteBlob) Specifies the behavior for deleting the snapshots on this blob. Include will delete the base blob and all snapshots. Only will delete only the snapshots. If a snapshot is being deleted, you must pass null.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#DELETE_SNAPSHOT_OPTION_TYPE"},"CamelAzureStorageBlobListBlobContainersOptions":{"index":55,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"ListBlobContainersOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(listBlobContainers) A ListBlobContainersOptions which specifies what data should be returned by the service.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#LIST_BLOB_CONTAINERS_OPTIONS"},"CamelAzureStorageBlobParallelTransferOptions":{"index":56,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"ParallelTransferOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(downloadBlobToFile) ParallelTransferOptions to use to download to file. Number of parallel transfers parameter is ignored.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#PARALLEL_TRANSFER_OPTIONS"},"CamelAzureStorageBlobDownloadLinkExpiration":{"index":57,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(downloadLink) Override the default expiration (millis) of URL download link.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#DOWNLOAD_LINK_EXPIRATION"},"CamelAzureStorageBlobSourceBlobAccountName":{"index":58,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(copyBlob) The source blob account name to be used as source account name in a copy blob operation","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#SOURCE_BLOB_ACCOUNT_NAME"},"CamelAzureStorageBlobSourceBlobContainerName":{"index":59,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(copyBlob) The source blob container name to be used as source container name in a copy blob operation","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#SOURCE_BLOB_CONTAINER_NAME"},"CamelAzureStorageBlobChangeFeedStartTime":{"index":60,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(getChangeFeed) It filters the results to return events approximately after the start time. Note: A few events belonging to the previous hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the start time down by an hour.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CHANGE_FEED_START_TIME"},"CamelAzureStorageBlobChangeFeedEndTime":{"index":61,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(getChangeFeed) It filters the results to return events approximately before the end time. Note: A few events belonging to the next hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the end time up by an hour.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CHANGE_FEED_END_TIME"},"CamelAzureStorageBlobContext":{"index":62,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Context","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(getChangeFeed) This gives additional context that is passed through the Http pipeline during the service call.","constantName":"org.apache.camel.component.azure.storage.blob.BlobConstants#CHANGE_FEED_CONTEXT"}},"properties":{"accountName":{"index":0,"kind":"path","displayName":"Account Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Azure account name to be used for authentication with azure blob services"},"containerName":{"index":1,"kind":"path","displayName":"Container Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"The blob container name"},"blobName":{"index":2,"kind":"parameter","displayName":"Blob Name","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"The blob name, to consume specific blob from a container. However, on producer it is only required for the operations on the blob level"},"blobOffset":{"index":3,"kind":"parameter","displayName":"Blob Offset","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Set the blob offset for the upload or download operations, default is 0"},"blobServiceClient":{"index":4,"kind":"parameter","displayName":"Blob Service Client","group":"common","label":"","required":false,"type":"object","javaType":"com.azure.storage.blob.BlobServiceClient","deprecated":false,"autowired":false,"secret":false,"description":"Client to a storage account. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to blobs and containers. This client contains operations on a service account. Operations on a container are available on BlobContainerClient through getBlobContainerClient(String), and operations on a blob are available on BlobClient through getBlobContainerClient(String).getBlobClient(String)."},"blobType":{"index":5,"kind":"parameter","displayName":"Blob Type","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.component.azure.storage.blob.BlobType","enum":["blockblob","appendblob","pageblob"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"blockblob","configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"The blob type in order to initiate the appropriate settings for each blob type"},"closeStreamAfterRead":{"index":6,"kind":"parameter","displayName":"Close Stream After Read","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Close the stream after read or keep it open, default is true"},"credentials":{"index":7,"kind":"parameter","displayName":"Credentials","group":"common","label":"","required":false,"type":"object","javaType":"com.azure.storage.common.StorageSharedKeyCredential","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information"},"credentialType":{"index":8,"kind":"parameter","displayName":"Credential Type","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.component.azure.storage.blob.CredentialType","enum":["SHARED_ACCOUNT_KEY","SHARED_KEY_CREDENTIAL","AZURE_IDENTITY","AZURE_SAS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AZURE_IDENTITY","configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"},"dataCount":{"index":9,"kind":"parameter","displayName":"Data Count","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"How many bytes to include in the range. Must be greater than or equal to 0 if specified."},"fileDir":{"index":10,"kind":"parameter","displayName":"File Dir","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"The file directory where the downloaded blobs will be saved to, this can be used in both, producer and consumer"},"maxResultsPerPage":{"index":11,"kind":"parameter","displayName":"Max Results Per Page","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items."},"maxRetryRequests":{"index":12,"kind":"parameter","displayName":"Max Retry Requests","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a response body."},"prefix":{"index":13,"kind":"parameter","displayName":"Prefix","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs."},"regex":{"index":14,"kind":"parameter","displayName":"Regex","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Filters the results to return only blobs whose names match the specified regular expression. May be null to return all if both prefix and regex are set, regex takes the priority and prefix is ignored."},"sasToken":{"index":15,"kind":"parameter","displayName":"Sas Token","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"In case of usage of Shared Access Signature we'll need to set a SAS Token"},"serviceClient":{"index":16,"kind":"parameter","displayName":"Service Client","group":"common","label":"","required":false,"type":"object","javaType":"com.azure.storage.blob.BlobServiceClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Client to a storage account. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to blobs and containers. This client contains operations on a service account. Operations on a container are available on BlobContainerClient through BlobServiceClient#getBlobContainerClient(String), and operations on a blob are available on BlobClient through BlobContainerClient#getBlobClient(String)."},"timeout":{"index":17,"kind":"parameter","displayName":"Timeout","group":"common","label":"common","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"An optional timeout value beyond which a RuntimeException will be raised."},"sendEmptyMessageWhenIdle":{"index":18,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":19,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":20,"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":{"index":21,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":22,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"blobSequenceNumber":{"index":23,"kind":"parameter","displayName":"Blob Sequence Number","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"A user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 263 - 1.The default value is 0."},"blockListType":{"index":24,"kind":"parameter","displayName":"Block List Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.azure.storage.blob.models.BlockListType","enum":["committed","uncommitted","all"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"COMMITTED","configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Specifies which type of blocks to return."},"changeFeedContext":{"index":25,"kind":"parameter","displayName":"Change Feed Context","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.azure.core.util.Context","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"When using getChangeFeed producer operation, this gives additional context that is passed through the Http pipeline during the service call."},"changeFeedEndTime":{"index":26,"kind":"parameter","displayName":"Change Feed End 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.storage.blob.BlobConfiguration","configurationField":"configuration","description":"When using getChangeFeed producer operation, this filters the results to return events approximately before the end time. Note: A few events belonging to the next hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the end time up by an hour."},"changeFeedStartTime":{"index":27,"kind":"parameter","displayName":"Change Feed Start 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.storage.blob.BlobConfiguration","configurationField":"configuration","description":"When using getChangeFeed producer operation, this filters the results to return events approximately after the start time. Note: A few events belonging to the previous hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the start time down by an hour."},"closeStreamAfterWrite":{"index":28,"kind":"parameter","displayName":"Close Stream After Write","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Close the stream after write or keep it open, default is true"},"commitBlockListLater":{"index":29,"kind":"parameter","displayName":"Commit Block List Later","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"When is set to true, the staged blocks will not be committed directly."},"createAppendBlob":{"index":30,"kind":"parameter","displayName":"Create Append Blob","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"When is set to true, the append blocks will be created when committing append blocks."},"createPageBlob":{"index":31,"kind":"parameter","displayName":"Create Page Blob","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"When is set to true, the page blob will be created when uploading page blob."},"downloadLinkExpiration":{"index":32,"kind":"parameter","displayName":"Download Link Expiration","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Override the default expiration (millis) of URL download link."},"operation":{"index":33,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.azure.storage.blob.BlobOperationsDefinition","enum":["listBlobContainers","createBlobContainer","deleteBlobContainer","listBlobs","getBlob","deleteBlob","downloadBlobToFile","downloadLink","uploadBlockBlob","stageBlockBlobList","commitBlobBlockList","getBlobBlockList","createAppendBlob","commitAppendBlob","createPageBlob","uploadPageBlob","resizePageBlob","clearPageBlob","getPageBlobRanges"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"listBlobContainers","configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"The blob operation that can be used with this component on the producer"},"pageBlobSize":{"index":34,"kind":"parameter","displayName":"Page Blob Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"512","configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a 512-byte boundary."},"lazyStartProducer":{"index":35,"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."},"backoffErrorThreshold":{"index":36,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":37,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":38,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":39,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":40,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":41,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":42,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":43,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":44,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":45,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":46,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":47,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":48,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":49,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":50,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Access key for the associated azure account name to be used for authentication with azure blob services"},"sourceBlobAccessKey":{"index":51,"kind":"parameter","displayName":"Source Blob Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.blob.BlobConfiguration","configurationField":"configuration","description":"Source Blob Access Key: for copyblob operation, sadly, we need to have an accessKey for the source blob we want to copy Passing an accessKey as header, it's unsafe so we could set as key."}}} , -{"component":{"kind":"component","name":"azure-storage-datalake","title":"Azure Storage Data Lake Service","description":"Sends and receives files to/from Azure Data Lake Storage.","deprecated":false,"firstVersion":"3.8.0","label":"cloud,file,bigdata","javaType":"org.apache.camel.component.azure.storage.datalake.DataLakeComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-azure-storage-datalake","version":"4.8.1","scheme":"azure-storage-datalake","extendsScheme":"","syntax":"azure-storage-datalake:accountName/fileSystemName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAzureStorageDataLakeListFileSystemsOptions":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"ListFileSystemsOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Defines options available to configure the behavior of a call to listFileSystemsSegment on a DataLakeServiceAsyncClient object. Null may be passed.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#LIST_FILESYSTEMS_OPTIONS"},"CamelAzureStorageDataLakeTimeout":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Duration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"An optional timeout value beyond which a RuntimeException will be raised.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#TIMEOUT"},"CamelAzureStorageDataLakeOperation":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.azure.storage.datalake.DataLakeOperationsDefinition","enum":["listFileSystem","createFileSystem","deleteFileSystem","listPaths","getFile","downloadToFile","downloadLink","deleteFile","appendToFile","flushToFile","uploadFromFile","upload","openQueryInputStream","createFile","deleteDirectory"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specify the producer operation to execute. Different operations allowed are shown below.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#DATALAKE_OPERATION"},"CamelAzureStorageDataLakeFileSystemName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the file system in azure data lake on which operation is to be performed. Please make sure that filesystem name is all lowercase.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FILESYSTEM_NAME"},"CamelAzureStorageDataLakeDirectoryName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the directory in azure data lake on which operation is to be performed.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#DIRECTORY_NAME"},"CamelAzureStorageDataLakeFileName":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the file in azure data lake on which operation is to be performed.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FILE_NAME"},"CamelAzureStorageDataLakeMetadata":{"index":6,"kind":"header","displayName":"","group":"from both","label":"from both","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata to associate with the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#METADATA"},"CamelAzureStorageDataLakePublicAccessType":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"PublicAccessType","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Defines options available to configure the behavior of a call to listFileSystemsSegment on a DataLakeServiceAsyncClient object.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#PUBLIC_ACCESS_TYPE"},"CamelAzureStorageDataLakeRawHttpHeaders":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"HttpHeaders","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Non parsed http headers that can be used by the user.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#RAW_HTTP_HEADERS"},"CamelAzureStorageDataLakeRequestCondition":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"DataLakeRequestConditions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This contains values which will restrict the successful operation of a variety of requests to the conditions present. These conditions are entirely optional.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#DATALAKE_REQUEST_CONDITION"},"CamelAzureStorageDataLakeListPathOptions":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"ListPathOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Defines options available to configure the behavior of a call to listContainersSegment on a DataLakeFileSystemClient object. Null may be passed.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#LIST_PATH_OPTIONS"},"CamelAzureStorageDataLakePath":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path of the file to be used for upload operations.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#PATH"},"CamelAzureStorageDataLakeRecursive":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies if the call to listContainersSegment should recursively include all paths.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#RECURSIVE"},"CamelAzureStorageDataLakeMaxResults":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the maximum number of blobs to return, including all BlobPrefix elements.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#MAX_RESULTS"},"CamelAzureStorageDataLakeUserPrincipalNameReturned":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies if the name of the user principal should be returned.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#USER_PRINCIPAL_NAME_RETURNED"},"CamelAzureStorageDataLakeRegex":{"index":15,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Filter the results to return only those files with match the specified regular expression.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#REGEX"},"CamelAzureStorageDataLakeFileDir":{"index":16,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Directory in which the file is to be downloaded.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FILE_DIR"},"CamelAzureStorageDataLakeAccessTier":{"index":17,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"AccessTier","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Access tier of file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#ACCESS_TIER"},"CamelAzureStorageDataLakeContentMD5":{"index":18,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"An MD5 hash of the content. The hash is used to verify the integrity of the file during transport.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CONTENT_MD5"},"CamelAzureStorageDataLakeFileRange":{"index":19,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"FileRange","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This is a representation of a range of bytes on a file, typically used during a download operation. Passing null as a FileRange value will default to the entire range of the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FILE_RANGE"},"CamelAzureStorageDataLakeParallelTransferOptions":{"index":20,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"ParallelTransferOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The configuration used to parallelize data transfer operations.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#PARALLEL_TRANSFER_OPTIONS"},"CamelAzureStorageDataLakeOpenOptions":{"index":21,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set of OpenOption used to configure how to open or create a file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#OPEN_OPTIONS"},"CamelAzureStorageDataLakeAccessTierChangeTime":{"index":22,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Datetime when the access tier of the blob last changed.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#ACCESS_TIER_CHANGE_TIME"},"CamelAzureStorageDataLakeArchiveStatus":{"index":23,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"ArchiveStatus","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Archive status of file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#ARCHIVE_STATUS"},"CamelAzureStorageDataLakeCacheControl":{"index":24,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cache control specified for the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CACHE_CONTROL"},"CamelAzureStorageDataLakeContentDisposition":{"index":25,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content disposition specified for the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CONTENT_DISPOSITION"},"CamelAzureStorageDataLakeContentEncoding":{"index":26,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content encoding specified for the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CONTENT_ENCODING"},"CamelAzureStorageDataLakeContentLanguage":{"index":27,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content language specified for the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CONTENT_LANGUAGE"},"CamelAzureStorageDataLakeContentType":{"index":28,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content type specified for the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CONTENT_TYPE"},"CamelAzureStorageDataLakeCopyCompletionTime":{"index":29,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Conclusion time of the last attempted Copy Blob operation where this file was the destination file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#COPY_COMPLETION_TIME"},"CamelAzureStorageDataLakeCopyId":{"index":30,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"String identifier for this copy operation.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#COPY_ID"},"CamelAzureStorageDataLakeCopyProgress":{"index":31,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this file was the destination file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#COPY_PROGRESS"},"CamelAzureStorageDataLakeCopySource":{"index":32,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URL up to 2 KB in length that specifies the source file or file used in the last attempted Copy Blob operation where this file was the destination file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#COPY_SOURCE"},"CamelAzureStorageDataLakeCopyStatus":{"index":33,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.file.datalake.models.CopyStatusType","enum":["pending","success","aborted","failed"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Status of the last copy operation performed on the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#COPY_STATUS"},"CamelAzureStorageDataLakeCopyStatusDescription":{"index":34,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The description of the copy's status","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#COPY_STATUS_DESCRIPTION"},"CamelAzureStorageDataLakeCreationTime":{"index":35,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Creation time of the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CREATION_TIME"},"CamelAzureStorageDataLakeEncryptionKeySha256":{"index":36,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SHA-256 hash of the encryption key used to encrypt the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#ENCRYPTION_KEY_SHA_256"},"CamelAzureStorageDataLakeETag":{"index":37,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The E Tag of the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#E_TAG"},"CamelAzureStorageDataLakeFileSize":{"index":38,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Size of the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FILE_SIZE"},"CamelAzureStorageDataLakeLastModified":{"index":39,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Datetime when the file was last modified.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#LAST_MODIFIED"},"CamelAzureStorageDataLakeLeaseDuration":{"index":40,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.file.datalake.models.LeaseDurationType","enum":["infinite","fixed"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Type of lease on the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#LEASE_DURATION"},"CamelAzureStorageDataLakeLeaseState":{"index":41,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.file.datalake.models.LeaseStateType","enum":["available","leased","expired","breaking","broken"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"State of the lease on the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#LEASE_STATE"},"CamelAzureStorageDataLakeLeaseStatus":{"index":42,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.file.datalake.models.LeaseStatusType","enum":["locked","unlocked"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Status of the lease on the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#LEASE_STATUS"},"CamelAzureStorageDataLakeIncrementalCopy":{"index":43,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Flag indicating if the file was incrementally copied.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#INCREMENTAL_COPY"},"CamelAzureStorageDataLakeServerEncrypted":{"index":44,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Flag indicating if the file's content is encrypted on the server.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#SERVER_ENCRYPTED"},"CamelAzureStorageDataLakeDownloadLinkExpiration":{"index":45,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set the Expiration time of the download link.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#DOWNLOAD_LINK_EXPIRATION"},"CamelAzureStorageDataLakeDownloadLink":{"index":46,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The link that can be used to download the file from data lake.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#DOWNLOAD_LINK"},"CamelAzureStorageDataLakeFileOffset":{"index":47,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The position where the data is to be appended.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FILE_OFFSET"},"CamelAzureStorageDataLakeLeaseId":{"index":48,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"By setting lease id, requests will fail if the provided lease does not match the active lease on the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#LEASE_ID"},"CamelAzureStorageDataLakePathHttpHeaders":{"index":49,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"PathHttpHeaders","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Additional parameters for a set of operations.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#PATH_HTTP_HEADERS"},"CamelAzureStorageDataLakeRetainCommitedData":{"index":50,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Determines Whether or not uncommitted data is to be retained after the operation.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#RETAIN_UNCOMMITED_DATA"},"CamelAzureStorageDataLakeClose":{"index":51,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Whether or not a file changed event raised indicates completion (true) or modification (false).","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CLOSE"},"CamelAzureStorageDataLakePosition":{"index":52,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The length of the file after all data has been written.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#POSITION"},"CamelAzureStorageDataLakeExpression":{"index":53,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query expression on the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#EXPRESSION"},"CamelAzureStorageDataLakeInputSerialization":{"index":54,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"FileQuerySerialization","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Defines the input serialization for a file query request. either FileQueryJsonSerialization or FileQueryDelimitedSerialization","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#INPUT_SERIALIZATION"},"CamelAzureStorageDataLakeOutputSerialization":{"index":55,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"FileQuerySerialization","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Defines the output serialization for a file query request. either FileQueryJsonSerialization or FileQueryDelimitedSerialization","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#OUTPUT_SERIALIZATION"},"CamelAzureStorageDataLakeErrorConsumer":{"index":56,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Consumer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets error consumer for file query","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#ERROR_CONSUMER"},"CamelAzureStorageDataLakeProgressConsumer":{"index":57,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Consumer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets progress consumer for file query","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#PROGRESS_CONSUMER"},"CamelAzureStorageDataLakeQueryOptions":{"index":58,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"FileQueryOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Optional parameters for File Query.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#QUERY_OPTIONS"},"CamelAzureStorageDataLakePermission":{"index":59,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the permission for file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#PERMISSION"},"CamelAzureStorageDataLakeUmask":{"index":60,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the umask for file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#UMASK"},"CamelAzureStorageDataLakeFileClient":{"index":61,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"DataLakeFileClient","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the file client to use","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FILE_CLIENT"},"CamelAzureStorageDataLakeFlush":{"index":62,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets whether to flush on append","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FLUSH"}},"properties":{"accountName":{"index":0,"kind":"path","displayName":"Account Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"name of the azure account"},"fileSystemName":{"index":1,"kind":"path","displayName":"File System Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"name of filesystem to be used"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"client id for azure account"},"close":{"index":3,"kind":"parameter","displayName":"Close","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"Whether or not a file changed event raised indicates completion (true) or modification (false)"},"closeStreamAfterRead":{"index":4,"kind":"parameter","displayName":"Close Stream After Read","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"check for closing stream after read"},"credentialType":{"index":5,"kind":"parameter","displayName":"Credential Type","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.component.azure.storage.datalake.CredentialType","enum":["CLIENT_SECRET","SHARED_KEY_CREDENTIAL","AZURE_IDENTITY","AZURE_SAS","SERVICE_CLIENT_INSTANCE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CLIENT_SECRET","configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"},"dataCount":{"index":6,"kind":"parameter","displayName":"Data Count","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"count number of bytes to download"},"dataLakeServiceClient":{"index":7,"kind":"parameter","displayName":"Data Lake Service Client","group":"common","label":"","required":false,"type":"object","javaType":"com.azure.storage.file.datalake.DataLakeServiceClient","deprecated":false,"autowired":false,"secret":false,"description":"service client of data lake"},"directoryName":{"index":8,"kind":"parameter","displayName":"Directory Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"directory of the file to be handled in component"},"downloadLinkExpiration":{"index":9,"kind":"parameter","displayName":"Download Link Expiration","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"download link expiration time"},"expression":{"index":10,"kind":"parameter","displayName":"Expression","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"expression for queryInputStream"},"fileDir":{"index":11,"kind":"parameter","displayName":"File Dir","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"directory of file to do operations in the local system"},"fileName":{"index":12,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"name of file to be handled in component"},"fileOffset":{"index":13,"kind":"parameter","displayName":"File Offset","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"offset position in file for different operations"},"maxResults":{"index":14,"kind":"parameter","displayName":"Max Results","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"maximum number of results to show at a time"},"maxRetryRequests":{"index":15,"kind":"parameter","displayName":"Max Retry Requests","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"no of retries to a given request"},"openOptions":{"index":16,"kind":"parameter","displayName":"Open Options","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Set","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"set open options for creating file"},"path":{"index":17,"kind":"parameter","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"path in azure data lake for operations"},"permission":{"index":18,"kind":"parameter","displayName":"Permission","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"permission string for the file"},"position":{"index":19,"kind":"parameter","displayName":"Position","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file."},"recursive":{"index":20,"kind":"parameter","displayName":"Recursive","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"recursively include all paths"},"regex":{"index":21,"kind":"parameter","displayName":"Regex","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"regular expression for matching file names"},"retainUncommitedData":{"index":22,"kind":"parameter","displayName":"Retain Uncommited Data","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"Whether or not uncommitted data is to be retained after the operation"},"serviceClient":{"index":23,"kind":"parameter","displayName":"Service Client","group":"common","label":"","required":false,"type":"object","javaType":"com.azure.storage.file.datalake.DataLakeServiceClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"data lake service client for azure storage data lake"},"sharedKeyCredential":{"index":24,"kind":"parameter","displayName":"Shared Key Credential","group":"common","label":"","required":false,"type":"object","javaType":"com.azure.storage.common.StorageSharedKeyCredential","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"shared key credential for azure data lake gen2"},"tenantId":{"index":25,"kind":"parameter","displayName":"Tenant Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"tenant id for azure account"},"timeout":{"index":26,"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"Timeout for operation"},"umask":{"index":27,"kind":"parameter","displayName":"Umask","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"umask permission for file"},"userPrincipalNameReturned":{"index":28,"kind":"parameter","displayName":"User Principal Name Returned","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"whether or not to use upn"},"sendEmptyMessageWhenIdle":{"index":29,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":30,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":31,"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":{"index":32,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":33,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"operation":{"index":34,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.azure.storage.datalake.DataLakeOperationsDefinition","enum":["listFileSystem","listFiles"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"listFileSystem","configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"operation to be performed"},"lazyStartProducer":{"index":35,"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."},"backoffErrorThreshold":{"index":36,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":37,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":38,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":39,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":40,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":41,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":42,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":43,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":44,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":45,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":46,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":47,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":48,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":49,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accountKey":{"index":50,"kind":"parameter","displayName":"Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"account key for authentication"},"clientSecret":{"index":51,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"client secret for azure account"},"clientSecretCredential":{"index":52,"kind":"parameter","displayName":"Client Secret Credential","group":"security","label":"security","required":false,"type":"object","javaType":"com.azure.identity.ClientSecretCredential","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"client secret credential for authentication"},"sasCredential":{"index":53,"kind":"parameter","displayName":"Sas Credential","group":"security","label":"security","required":false,"type":"object","javaType":"com.azure.core.credential.AzureSasCredential","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"SAS token credential"},"sasSignature":{"index":54,"kind":"parameter","displayName":"Sas Signature","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"SAS token signature"}}} +{"component":{"kind":"component","name":"azure-storage-datalake","title":"Azure Storage Data Lake Service","description":"Sends and receives files to/from Azure Data Lake Storage.","deprecated":false,"firstVersion":"3.8.0","label":"cloud,file,bigdata","javaType":"org.apache.camel.component.azure.storage.datalake.DataLakeComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-azure-storage-datalake","version":"4.8.2","scheme":"azure-storage-datalake","extendsScheme":"","syntax":"azure-storage-datalake:accountName/fileSystemName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAzureStorageDataLakeListFileSystemsOptions":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"ListFileSystemsOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Defines options available to configure the behavior of a call to listFileSystemsSegment on a DataLakeServiceAsyncClient object. Null may be passed.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#LIST_FILESYSTEMS_OPTIONS"},"CamelAzureStorageDataLakeTimeout":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Duration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"An optional timeout value beyond which a RuntimeException will be raised.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#TIMEOUT"},"CamelAzureStorageDataLakeOperation":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.azure.storage.datalake.DataLakeOperationsDefinition","enum":["listFileSystem","createFileSystem","deleteFileSystem","listPaths","getFile","downloadToFile","downloadLink","deleteFile","appendToFile","flushToFile","uploadFromFile","upload","openQueryInputStream","createFile","deleteDirectory"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specify the producer operation to execute. Different operations allowed are shown below.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#DATALAKE_OPERATION"},"CamelAzureStorageDataLakeFileSystemName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the file system in azure data lake on which operation is to be performed. Please make sure that filesystem name is all lowercase.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FILESYSTEM_NAME"},"CamelAzureStorageDataLakeDirectoryName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the directory in azure data lake on which operation is to be performed.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#DIRECTORY_NAME"},"CamelAzureStorageDataLakeFileName":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the file in azure data lake on which operation is to be performed.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FILE_NAME"},"CamelAzureStorageDataLakeMetadata":{"index":6,"kind":"header","displayName":"","group":"from both","label":"from both","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata to associate with the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#METADATA"},"CamelAzureStorageDataLakePublicAccessType":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"PublicAccessType","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Defines options available to configure the behavior of a call to listFileSystemsSegment on a DataLakeServiceAsyncClient object.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#PUBLIC_ACCESS_TYPE"},"CamelAzureStorageDataLakeRawHttpHeaders":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"HttpHeaders","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Non parsed http headers that can be used by the user.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#RAW_HTTP_HEADERS"},"CamelAzureStorageDataLakeRequestCondition":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"DataLakeRequestConditions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This contains values which will restrict the successful operation of a variety of requests to the conditions present. These conditions are entirely optional.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#DATALAKE_REQUEST_CONDITION"},"CamelAzureStorageDataLakeListPathOptions":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"ListPathOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Defines options available to configure the behavior of a call to listContainersSegment on a DataLakeFileSystemClient object. Null may be passed.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#LIST_PATH_OPTIONS"},"CamelAzureStorageDataLakePath":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path of the file to be used for upload operations.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#PATH"},"CamelAzureStorageDataLakeRecursive":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies if the call to listContainersSegment should recursively include all paths.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#RECURSIVE"},"CamelAzureStorageDataLakeMaxResults":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the maximum number of blobs to return, including all BlobPrefix elements.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#MAX_RESULTS"},"CamelAzureStorageDataLakeUserPrincipalNameReturned":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies if the name of the user principal should be returned.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#USER_PRINCIPAL_NAME_RETURNED"},"CamelAzureStorageDataLakeRegex":{"index":15,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Filter the results to return only those files with match the specified regular expression.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#REGEX"},"CamelAzureStorageDataLakeFileDir":{"index":16,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Directory in which the file is to be downloaded.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FILE_DIR"},"CamelAzureStorageDataLakeAccessTier":{"index":17,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"AccessTier","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Access tier of file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#ACCESS_TIER"},"CamelAzureStorageDataLakeContentMD5":{"index":18,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"An MD5 hash of the content. The hash is used to verify the integrity of the file during transport.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CONTENT_MD5"},"CamelAzureStorageDataLakeFileRange":{"index":19,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"FileRange","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This is a representation of a range of bytes on a file, typically used during a download operation. Passing null as a FileRange value will default to the entire range of the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FILE_RANGE"},"CamelAzureStorageDataLakeParallelTransferOptions":{"index":20,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"ParallelTransferOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The configuration used to parallelize data transfer operations.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#PARALLEL_TRANSFER_OPTIONS"},"CamelAzureStorageDataLakeOpenOptions":{"index":21,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set of OpenOption used to configure how to open or create a file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#OPEN_OPTIONS"},"CamelAzureStorageDataLakeAccessTierChangeTime":{"index":22,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Datetime when the access tier of the blob last changed.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#ACCESS_TIER_CHANGE_TIME"},"CamelAzureStorageDataLakeArchiveStatus":{"index":23,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"ArchiveStatus","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Archive status of file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#ARCHIVE_STATUS"},"CamelAzureStorageDataLakeCacheControl":{"index":24,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cache control specified for the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CACHE_CONTROL"},"CamelAzureStorageDataLakeContentDisposition":{"index":25,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content disposition specified for the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CONTENT_DISPOSITION"},"CamelAzureStorageDataLakeContentEncoding":{"index":26,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content encoding specified for the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CONTENT_ENCODING"},"CamelAzureStorageDataLakeContentLanguage":{"index":27,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content language specified for the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CONTENT_LANGUAGE"},"CamelAzureStorageDataLakeContentType":{"index":28,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content type specified for the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CONTENT_TYPE"},"CamelAzureStorageDataLakeCopyCompletionTime":{"index":29,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Conclusion time of the last attempted Copy Blob operation where this file was the destination file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#COPY_COMPLETION_TIME"},"CamelAzureStorageDataLakeCopyId":{"index":30,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"String identifier for this copy operation.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#COPY_ID"},"CamelAzureStorageDataLakeCopyProgress":{"index":31,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this file was the destination file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#COPY_PROGRESS"},"CamelAzureStorageDataLakeCopySource":{"index":32,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URL up to 2 KB in length that specifies the source file or file used in the last attempted Copy Blob operation where this file was the destination file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#COPY_SOURCE"},"CamelAzureStorageDataLakeCopyStatus":{"index":33,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.file.datalake.models.CopyStatusType","enum":["pending","success","aborted","failed"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Status of the last copy operation performed on the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#COPY_STATUS"},"CamelAzureStorageDataLakeCopyStatusDescription":{"index":34,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The description of the copy's status","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#COPY_STATUS_DESCRIPTION"},"CamelAzureStorageDataLakeCreationTime":{"index":35,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Creation time of the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CREATION_TIME"},"CamelAzureStorageDataLakeEncryptionKeySha256":{"index":36,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SHA-256 hash of the encryption key used to encrypt the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#ENCRYPTION_KEY_SHA_256"},"CamelAzureStorageDataLakeETag":{"index":37,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The E Tag of the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#E_TAG"},"CamelAzureStorageDataLakeFileSize":{"index":38,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Size of the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FILE_SIZE"},"CamelAzureStorageDataLakeLastModified":{"index":39,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Datetime when the file was last modified.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#LAST_MODIFIED"},"CamelAzureStorageDataLakeLeaseDuration":{"index":40,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.file.datalake.models.LeaseDurationType","enum":["infinite","fixed"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Type of lease on the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#LEASE_DURATION"},"CamelAzureStorageDataLakeLeaseState":{"index":41,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.file.datalake.models.LeaseStateType","enum":["available","leased","expired","breaking","broken"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"State of the lease on the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#LEASE_STATE"},"CamelAzureStorageDataLakeLeaseStatus":{"index":42,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.azure.storage.file.datalake.models.LeaseStatusType","enum":["locked","unlocked"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Status of the lease on the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#LEASE_STATUS"},"CamelAzureStorageDataLakeIncrementalCopy":{"index":43,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Flag indicating if the file was incrementally copied.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#INCREMENTAL_COPY"},"CamelAzureStorageDataLakeServerEncrypted":{"index":44,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Flag indicating if the file's content is encrypted on the server.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#SERVER_ENCRYPTED"},"CamelAzureStorageDataLakeDownloadLinkExpiration":{"index":45,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set the Expiration time of the download link.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#DOWNLOAD_LINK_EXPIRATION"},"CamelAzureStorageDataLakeDownloadLink":{"index":46,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The link that can be used to download the file from data lake.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#DOWNLOAD_LINK"},"CamelAzureStorageDataLakeFileOffset":{"index":47,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The position where the data is to be appended.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FILE_OFFSET"},"CamelAzureStorageDataLakeLeaseId":{"index":48,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"By setting lease id, requests will fail if the provided lease does not match the active lease on the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#LEASE_ID"},"CamelAzureStorageDataLakePathHttpHeaders":{"index":49,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"PathHttpHeaders","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Additional parameters for a set of operations.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#PATH_HTTP_HEADERS"},"CamelAzureStorageDataLakeRetainCommitedData":{"index":50,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Determines Whether or not uncommitted data is to be retained after the operation.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#RETAIN_UNCOMMITED_DATA"},"CamelAzureStorageDataLakeClose":{"index":51,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Whether or not a file changed event raised indicates completion (true) or modification (false).","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#CLOSE"},"CamelAzureStorageDataLakePosition":{"index":52,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The length of the file after all data has been written.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#POSITION"},"CamelAzureStorageDataLakeExpression":{"index":53,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query expression on the file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#EXPRESSION"},"CamelAzureStorageDataLakeInputSerialization":{"index":54,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"FileQuerySerialization","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Defines the input serialization for a file query request. either FileQueryJsonSerialization or FileQueryDelimitedSerialization","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#INPUT_SERIALIZATION"},"CamelAzureStorageDataLakeOutputSerialization":{"index":55,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"FileQuerySerialization","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Defines the output serialization for a file query request. either FileQueryJsonSerialization or FileQueryDelimitedSerialization","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#OUTPUT_SERIALIZATION"},"CamelAzureStorageDataLakeErrorConsumer":{"index":56,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Consumer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets error consumer for file query","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#ERROR_CONSUMER"},"CamelAzureStorageDataLakeProgressConsumer":{"index":57,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Consumer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets progress consumer for file query","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#PROGRESS_CONSUMER"},"CamelAzureStorageDataLakeQueryOptions":{"index":58,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"FileQueryOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Optional parameters for File Query.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#QUERY_OPTIONS"},"CamelAzureStorageDataLakePermission":{"index":59,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the permission for file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#PERMISSION"},"CamelAzureStorageDataLakeUmask":{"index":60,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the umask for file.","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#UMASK"},"CamelAzureStorageDataLakeFileClient":{"index":61,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"DataLakeFileClient","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the file client to use","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FILE_CLIENT"},"CamelAzureStorageDataLakeFlush":{"index":62,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets whether to flush on append","constantName":"org.apache.camel.component.azure.storage.datalake.DataLakeConstants#FLUSH"}},"properties":{"accountName":{"index":0,"kind":"path","displayName":"Account Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"name of the azure account"},"fileSystemName":{"index":1,"kind":"path","displayName":"File System Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"name of filesystem to be used"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"client id for azure account"},"close":{"index":3,"kind":"parameter","displayName":"Close","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"Whether or not a file changed event raised indicates completion (true) or modification (false)"},"closeStreamAfterRead":{"index":4,"kind":"parameter","displayName":"Close Stream After Read","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"check for closing stream after read"},"credentialType":{"index":5,"kind":"parameter","displayName":"Credential Type","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.component.azure.storage.datalake.CredentialType","enum":["CLIENT_SECRET","SHARED_KEY_CREDENTIAL","AZURE_IDENTITY","AZURE_SAS","SERVICE_CLIENT_INSTANCE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CLIENT_SECRET","configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"},"dataCount":{"index":6,"kind":"parameter","displayName":"Data Count","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"count number of bytes to download"},"dataLakeServiceClient":{"index":7,"kind":"parameter","displayName":"Data Lake Service Client","group":"common","label":"","required":false,"type":"object","javaType":"com.azure.storage.file.datalake.DataLakeServiceClient","deprecated":false,"autowired":false,"secret":false,"description":"service client of data lake"},"directoryName":{"index":8,"kind":"parameter","displayName":"Directory Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"directory of the file to be handled in component"},"downloadLinkExpiration":{"index":9,"kind":"parameter","displayName":"Download Link Expiration","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"download link expiration time"},"expression":{"index":10,"kind":"parameter","displayName":"Expression","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"expression for queryInputStream"},"fileDir":{"index":11,"kind":"parameter","displayName":"File Dir","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"directory of file to do operations in the local system"},"fileName":{"index":12,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"name of file to be handled in component"},"fileOffset":{"index":13,"kind":"parameter","displayName":"File Offset","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"offset position in file for different operations"},"maxResults":{"index":14,"kind":"parameter","displayName":"Max Results","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"maximum number of results to show at a time"},"maxRetryRequests":{"index":15,"kind":"parameter","displayName":"Max Retry Requests","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"no of retries to a given request"},"openOptions":{"index":16,"kind":"parameter","displayName":"Open Options","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Set","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"set open options for creating file"},"path":{"index":17,"kind":"parameter","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"path in azure data lake for operations"},"permission":{"index":18,"kind":"parameter","displayName":"Permission","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"permission string for the file"},"position":{"index":19,"kind":"parameter","displayName":"Position","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file."},"recursive":{"index":20,"kind":"parameter","displayName":"Recursive","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"recursively include all paths"},"regex":{"index":21,"kind":"parameter","displayName":"Regex","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"regular expression for matching file names"},"retainUncommitedData":{"index":22,"kind":"parameter","displayName":"Retain Uncommited Data","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"Whether or not uncommitted data is to be retained after the operation"},"serviceClient":{"index":23,"kind":"parameter","displayName":"Service Client","group":"common","label":"","required":false,"type":"object","javaType":"com.azure.storage.file.datalake.DataLakeServiceClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"data lake service client for azure storage data lake"},"sharedKeyCredential":{"index":24,"kind":"parameter","displayName":"Shared Key Credential","group":"common","label":"","required":false,"type":"object","javaType":"com.azure.storage.common.StorageSharedKeyCredential","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"shared key credential for azure data lake gen2"},"tenantId":{"index":25,"kind":"parameter","displayName":"Tenant Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"tenant id for azure account"},"timeout":{"index":26,"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"Timeout for operation"},"umask":{"index":27,"kind":"parameter","displayName":"Umask","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"umask permission for file"},"userPrincipalNameReturned":{"index":28,"kind":"parameter","displayName":"User Principal Name Returned","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"whether or not to use upn"},"sendEmptyMessageWhenIdle":{"index":29,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":30,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":31,"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":{"index":32,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":33,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"operation":{"index":34,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.azure.storage.datalake.DataLakeOperationsDefinition","enum":["listFileSystem","listFiles"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"listFileSystem","configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"operation to be performed"},"lazyStartProducer":{"index":35,"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."},"backoffErrorThreshold":{"index":36,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":37,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":38,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":39,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":40,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":41,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":42,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":43,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":44,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":45,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":46,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":47,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":48,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":49,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accountKey":{"index":50,"kind":"parameter","displayName":"Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"account key for authentication"},"clientSecret":{"index":51,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"client secret for azure account"},"clientSecretCredential":{"index":52,"kind":"parameter","displayName":"Client Secret Credential","group":"security","label":"security","required":false,"type":"object","javaType":"com.azure.identity.ClientSecretCredential","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"client secret credential for authentication"},"sasCredential":{"index":53,"kind":"parameter","displayName":"Sas Credential","group":"security","label":"security","required":false,"type":"object","javaType":"com.azure.core.credential.AzureSasCredential","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"SAS token credential"},"sasSignature":{"index":54,"kind":"parameter","displayName":"Sas Signature","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration","configurationField":"configuration","description":"SAS token signature"}}} , -{"component":{"kind":"component","name":"azure-storage-queue","title":"Azure Storage Queue Service","description":"Stores and retrieves messages to/from Azure Storage Queue.","deprecated":false,"firstVersion":"3.3.0","label":"cloud,messaging","javaType":"org.apache.camel.component.azure.storage.queue.QueueComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-azure-storage-queue","version":"4.8.1","scheme":"azure-storage-queue","extendsScheme":"","syntax":"azure-storage-queue:accountName/queueName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAzureStorageQueueRawHttpHeaders":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"HttpHeaders","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Returns non-parsed httpHeaders that can be used by the user.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#RAW_HTTP_HEADERS"},"CamelAzureStorageQueueMetadata":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(createQueue) Metadata to associate with the queue","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#METADATA"},"CamelAzureStorageQueueMessageId":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of the message.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#MESSAGE_ID"},"CamelAzureStorageQueueInsertionTime":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time the Message was inserted into the Queue.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#INSERTION_TIME"},"CamelAzureStorageQueueExpirationTime":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time that the Message will expire and be automatically deleted.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#EXPIRATION_TIME"},"CamelAzureStorageQueuePopReceipt":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(deleteMessage, updateMessage) Unique identifier that must match for the message to be deleted or updated. If deletion fails using this pop receipt then the message has been dequeued by another client.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#POP_RECEIPT"},"CamelAzureStorageQueueTimeNextVisible":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time that the message will again become visible in the Queue.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#TIME_NEXT_VISIBLE"},"CamelAzureStorageQueueDequeueCount":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of times the message has been dequeued.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#DEQUEUE_COUNT"},"CamelAzureStorageQueueOperation":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.azure.storage.queue.QueueOperationDefinition","enum":["listQueues","createQueue","deleteQueue","clearQueue","sendMessage","deleteMessage","receiveMessages","peekMessages","updateMessage"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(All) Specify the producer operation to execute, please see the doc on this page related to producer operation.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#QUEUE_OPERATION"},"CamelAzureStorageQueueName":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(All) Override the queue name.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#QUEUE_NAME"},"CamelAzureStorageQueueSegmentOptions":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"QueuesSegmentOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(listQueues) Options for listing queues","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#QUEUES_SEGMENT_OPTIONS"},"CamelAzureStorageQueueTimeout":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Duration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(All) An optional timeout value beyond which a RuntimeException will be raised.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#TIMEOUT"},"CamelAzureStorageQueueMaxMessages":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(receiveMessages, peekMessages) Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 messages.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#MAX_MESSAGES"},"CamelAzureStorageQueueVisibilityTimeout":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Duration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(sendMessage, receiveMessages, updateMessage) The timeout period for how long the message is invisible in the queue. If unset the value will default to 0 and the message will be instantly visible. The timeout must be between 0 seconds and 7 days.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#VISIBILITY_TIMEOUT"},"CamelAzureStorageQueueTimeToLive":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Duration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(sendMessage) How long the message will stay alive in the queue. If unset the value will default to 7 days, if -1 is passed the message will not expire. The time to live must be -1 or any positive number.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#TIME_TO_LIVE"},"CamelAzureStorageQueueCreateQueue":{"index":15,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(sendMessage) When is set to true, the queue will be automatically created when sending messages to the queue.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#CREATE_QUEUE"}},"properties":{"accountName":{"index":0,"kind":"path","displayName":"Account Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"Azure account name to be used for authentication with azure queue services"},"queueName":{"index":1,"kind":"path","displayName":"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.storage.queue.QueueConfiguration","configurationField":"configuration","description":"The queue resource name"},"credentialType":{"index":2,"kind":"parameter","displayName":"Credential Type","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.component.azure.storage.queue.CredentialType","enum":["SHARED_ACCOUNT_KEY","SHARED_KEY_CREDENTIAL","AZURE_IDENTITY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SHARED_ACCOUNT_KEY","configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"},"serviceClient":{"index":3,"kind":"parameter","displayName":"Service Client","group":"common","label":"common","required":false,"type":"object","javaType":"com.azure.storage.queue.QueueServiceClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"Service client to a storage account to interact with the queue service. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. This client contains all the operations for interacting with a queue account in Azure Storage. Operations allowed by the client are creating, listing, and deleting queues, retrieving and updating properties of the account, and retrieving statistics of the account."},"sendEmptyMessageWhenIdle":{"index":4,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":8,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"createQueue":{"index":9,"kind":"parameter","displayName":"Create Queue","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"When is set to true, the queue will be automatically created when sending messages to the queue."},"operation":{"index":10,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.azure.storage.queue.QueueOperationDefinition","enum":["listQueues","createQueue","deleteQueue","clearQueue","sendMessage","deleteMessage","receiveMessages","peekMessages","updateMessage"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"Queue service operation hint to the producer"},"lazyStartProducer":{"index":11,"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."},"maxMessages":{"index":12,"kind":"parameter","displayName":"Max Messages","group":"queue","label":"queue","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 messages."},"messageId":{"index":13,"kind":"parameter","displayName":"Message Id","group":"queue","label":"queue","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"The ID of the message to be deleted or updated."},"popReceipt":{"index":14,"kind":"parameter","displayName":"Pop Receipt","group":"queue","label":"queue","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"Unique identifier that must match for the message to be deleted or updated."},"timeout":{"index":15,"kind":"parameter","displayName":"Timeout","group":"queue","label":"queue","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"An optional timeout applied to the operation. If a response is not returned before the timeout concludes a RuntimeException will be thrown."},"timeToLive":{"index":16,"kind":"parameter","displayName":"Time To Live","group":"queue","label":"queue","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"How long the message will stay alive in the queue. If unset the value will default to 7 days, if -1 is passed the message will not expire. The time to live must be -1 or any positive number. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe."},"visibilityTimeout":{"index":17,"kind":"parameter","displayName":"Visibility Timeout","group":"queue","label":"queue","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"The timeout period for how long the message is invisible in the queue. The timeout must be between 1 seconds and 7 days. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe."},"backoffErrorThreshold":{"index":18,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":19,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":20,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":21,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":22,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":23,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":24,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":25,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":26,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":27,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":28,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":29,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":30,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":31,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":32,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"Access key for the associated azure account name to be used for authentication with azure queue services"},"credentials":{"index":33,"kind":"parameter","displayName":"Credentials","group":"security","label":"security","required":false,"type":"object","javaType":"com.azure.storage.common.StorageSharedKeyCredential","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information"}}} +{"component":{"kind":"component","name":"azure-storage-queue","title":"Azure Storage Queue Service","description":"Stores and retrieves messages to/from Azure Storage Queue.","deprecated":false,"firstVersion":"3.3.0","label":"cloud,messaging","javaType":"org.apache.camel.component.azure.storage.queue.QueueComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-azure-storage-queue","version":"4.8.2","scheme":"azure-storage-queue","extendsScheme":"","syntax":"azure-storage-queue:accountName/queueName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelAzureStorageQueueRawHttpHeaders":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"HttpHeaders","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Returns non-parsed httpHeaders that can be used by the user.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#RAW_HTTP_HEADERS"},"CamelAzureStorageQueueMetadata":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(createQueue) Metadata to associate with the queue","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#METADATA"},"CamelAzureStorageQueueMessageId":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of the message.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#MESSAGE_ID"},"CamelAzureStorageQueueInsertionTime":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time the Message was inserted into the Queue.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#INSERTION_TIME"},"CamelAzureStorageQueueExpirationTime":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time that the Message will expire and be automatically deleted.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#EXPIRATION_TIME"},"CamelAzureStorageQueuePopReceipt":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(deleteMessage, updateMessage) Unique identifier that must match for the message to be deleted or updated. If deletion fails using this pop receipt then the message has been dequeued by another client.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#POP_RECEIPT"},"CamelAzureStorageQueueTimeNextVisible":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time that the message will again become visible in the Queue.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#TIME_NEXT_VISIBLE"},"CamelAzureStorageQueueDequeueCount":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of times the message has been dequeued.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#DEQUEUE_COUNT"},"CamelAzureStorageQueueOperation":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.azure.storage.queue.QueueOperationDefinition","enum":["listQueues","createQueue","deleteQueue","clearQueue","sendMessage","deleteMessage","receiveMessages","peekMessages","updateMessage"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(All) Specify the producer operation to execute, please see the doc on this page related to producer operation.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#QUEUE_OPERATION"},"CamelAzureStorageQueueName":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(All) Override the queue name.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#QUEUE_NAME"},"CamelAzureStorageQueueSegmentOptions":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"QueuesSegmentOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(listQueues) Options for listing queues","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#QUEUES_SEGMENT_OPTIONS"},"CamelAzureStorageQueueTimeout":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Duration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(All) An optional timeout value beyond which a RuntimeException will be raised.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#TIMEOUT"},"CamelAzureStorageQueueMaxMessages":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(receiveMessages, peekMessages) Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 messages.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#MAX_MESSAGES"},"CamelAzureStorageQueueVisibilityTimeout":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Duration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(sendMessage, receiveMessages, updateMessage) The timeout period for how long the message is invisible in the queue. If unset the value will default to 0 and the message will be instantly visible. The timeout must be between 0 seconds and 7 days.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#VISIBILITY_TIMEOUT"},"CamelAzureStorageQueueTimeToLive":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Duration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(sendMessage) How long the message will stay alive in the queue. If unset the value will default to 7 days, if -1 is passed the message will not expire. The time to live must be -1 or any positive number.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#TIME_TO_LIVE"},"CamelAzureStorageQueueCreateQueue":{"index":15,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(sendMessage) When is set to true, the queue will be automatically created when sending messages to the queue.","constantName":"org.apache.camel.component.azure.storage.queue.QueueConstants#CREATE_QUEUE"}},"properties":{"accountName":{"index":0,"kind":"path","displayName":"Account Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"Azure account name to be used for authentication with azure queue services"},"queueName":{"index":1,"kind":"path","displayName":"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.storage.queue.QueueConfiguration","configurationField":"configuration","description":"The queue resource name"},"credentialType":{"index":2,"kind":"parameter","displayName":"Credential Type","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.component.azure.storage.queue.CredentialType","enum":["SHARED_ACCOUNT_KEY","SHARED_KEY_CREDENTIAL","AZURE_IDENTITY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SHARED_ACCOUNT_KEY","configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"Determines the credential strategy to adopt"},"serviceClient":{"index":3,"kind":"parameter","displayName":"Service Client","group":"common","label":"common","required":false,"type":"object","javaType":"com.azure.storage.queue.QueueServiceClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"Service client to a storage account to interact with the queue service. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. This client contains all the operations for interacting with a queue account in Azure Storage. Operations allowed by the client are creating, listing, and deleting queues, retrieving and updating properties of the account, and retrieving statistics of the account."},"sendEmptyMessageWhenIdle":{"index":4,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":8,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"createQueue":{"index":9,"kind":"parameter","displayName":"Create Queue","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"When is set to true, the queue will be automatically created when sending messages to the queue."},"operation":{"index":10,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.azure.storage.queue.QueueOperationDefinition","enum":["listQueues","createQueue","deleteQueue","clearQueue","sendMessage","deleteMessage","receiveMessages","peekMessages","updateMessage"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"Queue service operation hint to the producer"},"lazyStartProducer":{"index":11,"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."},"maxMessages":{"index":12,"kind":"parameter","displayName":"Max Messages","group":"queue","label":"queue","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 messages."},"messageId":{"index":13,"kind":"parameter","displayName":"Message Id","group":"queue","label":"queue","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"The ID of the message to be deleted or updated."},"popReceipt":{"index":14,"kind":"parameter","displayName":"Pop Receipt","group":"queue","label":"queue","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"Unique identifier that must match for the message to be deleted or updated."},"timeout":{"index":15,"kind":"parameter","displayName":"Timeout","group":"queue","label":"queue","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"An optional timeout applied to the operation. If a response is not returned before the timeout concludes a RuntimeException will be thrown."},"timeToLive":{"index":16,"kind":"parameter","displayName":"Time To Live","group":"queue","label":"queue","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"How long the message will stay alive in the queue. If unset the value will default to 7 days, if -1 is passed the message will not expire. The time to live must be -1 or any positive number. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe."},"visibilityTimeout":{"index":17,"kind":"parameter","displayName":"Visibility Timeout","group":"queue","label":"queue","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"The timeout period for how long the message is invisible in the queue. The timeout must be between 1 seconds and 7 days. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe."},"backoffErrorThreshold":{"index":18,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":19,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":20,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":21,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":22,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":23,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":24,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":25,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":26,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":27,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":28,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":29,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":30,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":31,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":32,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"Access key for the associated azure account name to be used for authentication with azure queue services"},"credentials":{"index":33,"kind":"parameter","displayName":"Credentials","group":"security","label":"security","required":false,"type":"object","javaType":"com.azure.storage.common.StorageSharedKeyCredential","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.storage.queue.QueueConfiguration","configurationField":"configuration","description":"StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information"}}} , -{"component":{"kind":"component","name":"bean","title":"Bean","description":"Invoke methods of Java beans stored in Camel registry.","deprecated":false,"firstVersion":"1.0.0","label":"core,script","javaType":"org.apache.camel.component.bean.BeanComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-bean","version":"4.8.1","scheme":"bean","extendsScheme":"","syntax":"bean:beanName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelBeanMethodName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the method to invoke.","constantName":"org.apache.camel.component.bean.BeanConstants#BEAN_METHOD_NAME"}},"properties":{"beanName":{"index":0,"kind":"path","displayName":"Bean Name","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the name of the bean to invoke"},"method":{"index":1,"kind":"parameter","displayName":"Method","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of the method to invoke on the bean"},"scope":{"index":2,"kind":"parameter","displayName":"Scope","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.BeanScope","enum":["Singleton","Request","Prototype"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Singleton","description":"Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple times while processing the request. The bean does not have to be thread-safe as the instance is only called from the same request. When using prototype scope, then the bean will be looked up or created per call. However in case of lookup then this is delegated to the bean registry such as Spring or CDI (if in use), which depends on their configuration can act as either singleton or prototype scope. so when using prototype then this depends on the delegated registry."},"lazyStartProducer":{"index":3,"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."},"parameters":{"index":4,"kind":"parameter","displayName":"Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"bean.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Used for configuring additional properties on the bean"}}} +{"component":{"kind":"component","name":"bean","title":"Bean","description":"Invoke methods of Java beans stored in Camel registry.","deprecated":false,"firstVersion":"1.0.0","label":"core,script","javaType":"org.apache.camel.component.bean.BeanComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-bean","version":"4.8.2","scheme":"bean","extendsScheme":"","syntax":"bean:beanName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelBeanMethodName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the method to invoke.","constantName":"org.apache.camel.component.bean.BeanConstants#BEAN_METHOD_NAME"}},"properties":{"beanName":{"index":0,"kind":"path","displayName":"Bean Name","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the name of the bean to invoke"},"method":{"index":1,"kind":"parameter","displayName":"Method","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of the method to invoke on the bean"},"scope":{"index":2,"kind":"parameter","displayName":"Scope","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.BeanScope","enum":["Singleton","Request","Prototype"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Singleton","description":"Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple times while processing the request. The bean does not have to be thread-safe as the instance is only called from the same request. When using prototype scope, then the bean will be looked up or created per call. However in case of lookup then this is delegated to the bean registry such as Spring or CDI (if in use), which depends on their configuration can act as either singleton or prototype scope. so when using prototype then this depends on the delegated registry."},"lazyStartProducer":{"index":3,"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."},"parameters":{"index":4,"kind":"parameter","displayName":"Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"bean.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Used for configuring additional properties on the bean"}}} , -{"component":{"kind":"component","name":"bean-validator","title":"Bean Validator","description":"Validate the message body using the Java Bean Validation API.","deprecated":false,"firstVersion":"2.3.0","label":"validation","javaType":"org.apache.camel.component.bean.validator.BeanValidatorComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-bean-validator","version":"4.8.1","scheme":"bean-validator","extendsScheme":"","syntax":"bean-validator:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Where label is an arbitrary text value describing the endpoint"},"group":{"index":1,"kind":"parameter","displayName":"Group","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"jakarta.validation.groups.Default","description":"To use a custom validation group"},"ignoreXmlConfiguration":{"index":2,"kind":"parameter","displayName":"Ignore Xml Configuration","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to ignore data from the META-INF/validation.xml file."},"lazyStartProducer":{"index":3,"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."},"constraintValidatorFactory":{"index":4,"kind":"parameter","displayName":"Constraint Validator Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.validation.ConstraintValidatorFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom ConstraintValidatorFactory"},"messageInterpolator":{"index":5,"kind":"parameter","displayName":"Message Interpolator","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.validation.MessageInterpolator","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom MessageInterpolator"},"traversableResolver":{"index":6,"kind":"parameter","displayName":"Traversable Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.validation.TraversableResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom TraversableResolver"},"validationProviderResolver":{"index":7,"kind":"parameter","displayName":"Validation Provider Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.validation.ValidationProviderResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a a custom ValidationProviderResolver"},"validatorFactory":{"index":8,"kind":"parameter","displayName":"Validator Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.validation.ValidatorFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom ValidatorFactory"}}} +{"component":{"kind":"component","name":"bean-validator","title":"Bean Validator","description":"Validate the message body using the Java Bean Validation API.","deprecated":false,"firstVersion":"2.3.0","label":"validation","javaType":"org.apache.camel.component.bean.validator.BeanValidatorComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-bean-validator","version":"4.8.2","scheme":"bean-validator","extendsScheme":"","syntax":"bean-validator:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"label":{"index":0,"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Where label is an arbitrary text value describing the endpoint"},"group":{"index":1,"kind":"parameter","displayName":"Group","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"jakarta.validation.groups.Default","description":"To use a custom validation group"},"ignoreXmlConfiguration":{"index":2,"kind":"parameter","displayName":"Ignore Xml Configuration","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to ignore data from the META-INF/validation.xml file."},"lazyStartProducer":{"index":3,"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."},"constraintValidatorFactory":{"index":4,"kind":"parameter","displayName":"Constraint Validator Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.validation.ConstraintValidatorFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom ConstraintValidatorFactory"},"messageInterpolator":{"index":5,"kind":"parameter","displayName":"Message Interpolator","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.validation.MessageInterpolator","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom MessageInterpolator"},"traversableResolver":{"index":6,"kind":"parameter","displayName":"Traversable Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.validation.TraversableResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom TraversableResolver"},"validationProviderResolver":{"index":7,"kind":"parameter","displayName":"Validation Provider Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.validation.ValidationProviderResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a a custom ValidationProviderResolver"},"validatorFactory":{"index":8,"kind":"parameter","displayName":"Validator Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.validation.ValidatorFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom ValidatorFactory"}}} , -{"component":{"kind":"component","name":"bonita","title":"Bonita","description":"Communicate with a remote Bonita BPM process engine.","deprecated":false,"firstVersion":"2.19.0","label":"workflow","javaType":"org.apache.camel.component.bonita.BonitaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-bonita","version":"4.8.1","scheme":"bonita","extendsScheme":"","syntax":"bonita:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.bonita.util.BonitaOperation","enum":["startCase"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.bonita.BonitaConfiguration","configurationField":"configuration","description":"Operation to use"},"hostname":{"index":1,"kind":"parameter","displayName":"Hostname","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.bonita.BonitaConfiguration","configurationField":"configuration","description":"Hostname where Bonita engine runs"},"port":{"index":2,"kind":"parameter","displayName":"Port","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"8080","configurationClass":"org.apache.camel.component.bonita.BonitaConfiguration","configurationField":"configuration","description":"Port of the server hosting Bonita engine"},"processName":{"index":3,"kind":"parameter","displayName":"Process Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.bonita.BonitaConfiguration","configurationField":"configuration","description":"Name of the process involved in the operation"},"lazyStartProducer":{"index":4,"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."},"password":{"index":5,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.bonita.BonitaConfiguration","configurationField":"configuration","description":"Password to authenticate to Bonita engine."},"username":{"index":6,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.bonita.BonitaConfiguration","configurationField":"configuration","description":"Username to authenticate to Bonita engine."}}} +{"component":{"kind":"component","name":"bonita","title":"Bonita","description":"Communicate with a remote Bonita BPM process engine.","deprecated":false,"firstVersion":"2.19.0","label":"workflow","javaType":"org.apache.camel.component.bonita.BonitaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-bonita","version":"4.8.2","scheme":"bonita","extendsScheme":"","syntax":"bonita:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.bonita.util.BonitaOperation","enum":["startCase"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.bonita.BonitaConfiguration","configurationField":"configuration","description":"Operation to use"},"hostname":{"index":1,"kind":"parameter","displayName":"Hostname","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.bonita.BonitaConfiguration","configurationField":"configuration","description":"Hostname where Bonita engine runs"},"port":{"index":2,"kind":"parameter","displayName":"Port","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"8080","configurationClass":"org.apache.camel.component.bonita.BonitaConfiguration","configurationField":"configuration","description":"Port of the server hosting Bonita engine"},"processName":{"index":3,"kind":"parameter","displayName":"Process Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.bonita.BonitaConfiguration","configurationField":"configuration","description":"Name of the process involved in the operation"},"lazyStartProducer":{"index":4,"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."},"password":{"index":5,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.bonita.BonitaConfiguration","configurationField":"configuration","description":"Password to authenticate to Bonita engine."},"username":{"index":6,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.bonita.BonitaConfiguration","configurationField":"configuration","description":"Username to authenticate to Bonita engine."}}} , -{"component":{"kind":"component","name":"box","title":"Box","description":"Upload, download and manage files, folders, groups, collaborations, etc. on box.com.","deprecated":false,"firstVersion":"2.14.0","label":"cloud,file,api","javaType":"org.apache.camel.component.box.BoxComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-box","version":"4.8.1","scheme":"box","extendsScheme":"","syntax":"box:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.box.internal.BoxApiName","enum":["COLLABORATIONS","COMMENTS","EVENT_LOGS","FILES","FOLDERS","GROUPS","EVENTS","SEARCH","TASKS","USERS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"Box application client ID"},"enterpriseId":{"index":3,"kind":"parameter","displayName":"Enterprise Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The enterprise ID to use for an App Enterprise."},"inBody":{"index":4,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"userId":{"index":5,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The user ID to use for an App User."},"exceptionHandler":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."},"httpParams":{"index":9,"kind":"parameter","displayName":"Http Params","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"Custom HTTP params for settings like proxy host"},"authenticationType":{"index":10,"kind":"parameter","displayName":"Authentication Type","group":"authentication","label":"authentication","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"APP_USER_AUTHENTICATION","configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens"},"accessTokenCache":{"index":11,"kind":"parameter","displayName":"Access Token Cache","group":"security","label":"advanced,security","required":false,"type":"object","javaType":"com.box.sdk.IAccessTokenCache","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"Custom Access Token Cache for storing and retrieving access tokens."},"clientSecret":{"index":12,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"Box application client secret"},"encryptionAlgorithm":{"index":13,"kind":"parameter","displayName":"Encryption Algorithm","group":"security","label":"advanced,security","required":false,"type":"object","javaType":"com.box.sdk.EncryptionAlgorithm","enum":["RSA_SHA_256","RSA_SHA_384","RSA_SHA_512"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"RSA_SHA_256","configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512"},"maxCacheEntries":{"index":14,"kind":"parameter","displayName":"Max Cache Entries","group":"security","label":"advanced,security","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The maximum number of access tokens in cache."},"privateKeyFile":{"index":15,"kind":"parameter","displayName":"Private Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The private key for generating the JWT signature."},"privateKeyPassword":{"index":16,"kind":"parameter","displayName":"Private Key Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The password for the private key."},"publicKeyId":{"index":17,"kind":"parameter","displayName":"Public Key Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The ID for public key for validating the JWT signature."},"sslContextParameters":{"index":18,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters."},"userName":{"index":19,"kind":"parameter","displayName":"User Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"Box user name, MUST be provided"},"userPassword":{"index":20,"kind":"parameter","displayName":"User Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call"}},"apis":{"collaborations":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box collaborations","aliases":["addFolderCollaboration=add","addFolderCollaborationByEmail=addByEmail","deleteCollaboration=delete","getFolderCollaborations=collaborations","getPendingCollaborations=pendingCollaborations","getCollaborationInfo=info","updateCollaborationInfo=updateInfo"],"methods":{"addFolderCollaboration":{"description":"Add a collaboration to this folder","signatures":["com.box.sdk.BoxCollaboration addFolderCollaboration(String folderId, com.box.sdk.BoxCollaborator collaborator, com.box.sdk.BoxCollaboration$Role role)"]},"addFolderCollaborationByEmail":{"description":"Add a collaboration to this folder","signatures":["com.box.sdk.BoxCollaboration addFolderCollaborationByEmail(String folderId, String email, com.box.sdk.BoxCollaboration$Role role)"]},"deleteCollaboration":{"description":"Delete collaboration","signatures":["void deleteCollaboration(String collaborationId)"]},"getCollaborationInfo":{"description":"Get collaboration information","signatures":["com.box.sdk.BoxCollaboration$Info getCollaborationInfo(String collaborationId)"]},"getFolderCollaborations":{"description":"Get information about all of the collaborations for folder","signatures":["java.util.Collection getFolderCollaborations(String folderId)"]},"updateCollaborationInfo":{"description":"Update collaboration information","signatures":["com.box.sdk.BoxCollaboration updateCollaborationInfo(String collaborationId, com.box.sdk.BoxCollaboration$Info info)"]}}},"comments":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box comments","aliases":["addFileComment=add","changeCommentMessage=updateMessage","deleteComment=delete","getCommentInfo=info","getFileComments=comments","replyToComment=reply"],"methods":{"addFileComment":{"description":"Add comment to file","signatures":["com.box.sdk.BoxFile addFileComment(String fileId, String message)"]},"changeCommentMessage":{"description":"Change comment message","signatures":["com.box.sdk.BoxComment changeCommentMessage(String commentId, String message)"]},"deleteComment":{"description":"Delete comment","signatures":["void deleteComment(String commentId)"]},"getCommentInfo":{"description":"Get comment information","signatures":["com.box.sdk.BoxComment$Info getCommentInfo(String commentId)"]},"getFileComments":{"description":"Get a list of any comments on this file","signatures":["java.util.List getFileComments(String fileId)"]},"replyToComment":{"description":"Reply to a comment","signatures":["com.box.sdk.BoxComment replyToComment(String commentId, String message)"]}}},"event-logs":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to read Box enterprise (admin) event logs","aliases":["getEnterpriseEvents=events"],"methods":{"getEnterpriseEvents":{"description":"Create an event stream with optional starting initial position and add listener that will be notified when an event is received","signatures":["java.util.List getEnterpriseEvents(String position, java.util.Date after, java.util.Date before, com.box.sdk.BoxEvent$EventType[] types)"]}}},"events":{"consumerOnly":true,"producerOnly":false,"description":"Provides operations to manage Box events","methods":{"listen":{"description":"Create an event stream with optional starting initial position and add listener that will be notified when an event is received","signatures":["void listen(com.box.sdk.EventListener listener, Long startingPosition)"]}}},"files":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box files","aliases":["uploadFile=upload","downloadFile=download","copyFile=copy","moveFile=move","renameFile=rename","createFileSharedLink=link","deleteFile=delete","uploadNewFileVersion=uploadVersion","promoteFileVersion=promoteVersion","getFileVersions=versions","downloadPreviousFileVersion=downloadVersion","deleteFileVersion=deleteVersion","getFileInfo=info","updateFileInfo=updateInfo","createFileMetadata=createMetadata","getFileMetadata=metadata","updateFileMetadata=updateMetadata","deleteFileMetadata=deleteMetadata","getDownloadUrl=url","getPreviewLink=preview","getFileThumbnail=thumbnail","checkUpload=canUpload"],"methods":{"checkUpload":{"description":"Does a pre-verification before upload, to check if the filename already exists or if there is permission to upload","signatures":["void checkUpload(String fileName, String parentFolderId, Long size)"]},"copyFile":{"description":"Copy file to destination folder while optionally giving it a new name","signatures":["com.box.sdk.BoxFile copyFile(String fileId, String destinationFolderId, String newName)"]},"createFileMetadata":{"description":"Create metadata for file in either the global properties template or the specified template type","signatures":["com.box.sdk.Metadata createFileMetadata(String fileId, com.box.sdk.Metadata metadata, String typeName)"]},"createFileSharedLink":{"description":"Create a shared link to file","signatures":["com.box.sdk.BoxSharedLink createFileSharedLink(String fileId, com.box.sdk.BoxSharedLink$Access access, java.util.Date unshareDate, com.box.sdk.BoxSharedLink$Permissions permissions)"]},"deleteFile":{"description":"Delete the file","signatures":["void deleteFile(String fileId)"]},"deleteFileMetadata":{"description":"Delete the file properties metadata","signatures":["void deleteFileMetadata(String fileId)"]},"deleteFileVersion":{"description":"Delete a file version","signatures":["void deleteFileVersion(String fileId, Integer version)"]},"downloadFile":{"description":"Download a file","signatures":["java.io.OutputStream downloadFile(String fileId, java.io.OutputStream output, Long rangeStart, Long rangeEnd, com.box.sdk.ProgressListener listener)"]},"downloadPreviousFileVersion":{"description":"Download a previous version of file","signatures":["java.io.OutputStream downloadPreviousFileVersion(String fileId, Integer version, java.io.OutputStream output, com.box.sdk.ProgressListener listener)"]},"getDownloadURL":{"description":"Get an expiring URL for downloading a file directly from Box","signatures":["java.net.URL getDownloadURL(String fileId)"]},"getFileInfo":{"description":"Get file information","signatures":["com.box.sdk.BoxFile$Info getFileInfo(String fileId, String[] fields)"]},"getFileMetadata":{"description":"Gets the file properties metadata","signatures":["com.box.sdk.Metadata getFileMetadata(String fileId, String typeName)"]},"getFilePreviewLink":{"description":"Get an expiring URL for creating an embedded preview session","signatures":["java.net.URL getFilePreviewLink(String fileId)"]},"getFileVersions":{"description":"Get any previous versions of file","signatures":["java.util.Collection getFileVersions(String fileId)"]},"moveFile":{"description":"Move file to destination folder while optionally giving it a new name","signatures":["com.box.sdk.BoxFile moveFile(String fileId, String destinationFolderId, String newName)"]},"promoteFileVersion":{"description":"Promote a previous version of file","signatures":["com.box.sdk.BoxFileVersion promoteFileVersion(String fileId, Integer version)"]},"renameFile":{"description":"Rename file giving it the name newName","signatures":["com.box.sdk.BoxFile renameFile(String fileId, String newFileName)"]},"updateFileInfo":{"description":"Update file information","signatures":["com.box.sdk.BoxFile updateFileInfo(String fileId, com.box.sdk.BoxFile$Info info)"]},"updateFileMetadata":{"description":"Update the file properties metadata","signatures":["com.box.sdk.Metadata updateFileMetadata(String fileId, com.box.sdk.Metadata metadata)"]},"uploadFile":{"description":"Upload a new file to parent folder","signatures":["com.box.sdk.BoxFile uploadFile(String parentFolderId, java.io.InputStream content, String fileName, java.util.Date created, java.util.Date modified, Long size, Boolean check, com.box.sdk.ProgressListener listener)"]},"uploadNewFileVersion":{"description":"Upload a new version of file","signatures":["com.box.sdk.BoxFile uploadNewFileVersion(String fileId, java.io.InputStream fileContent, java.util.Date modified, Long fileSize, com.box.sdk.ProgressListener listener)"]}}},"folders":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box folders","aliases":["getRootFolder=root","createFolder=create","copyFolder=copy","moveFolder=move","renameFolder=rename","createFolderSharedLink=link","deleteFolder=delete","getFolder=folder","getFolderInfo=info","getFolderItems=items","updateFolderInfo=updateInfo"],"methods":{"copyFolder":{"description":"Copy folder to destination folder while optionally giving it a new name","signatures":["com.box.sdk.BoxFolder copyFolder(String folderId, String destinationFolderId, String newName)"]},"createFolder":{"description":"Create a folder specified by path from parent folder with given parentFolderId, creating intermediate directories as required","signatures":["com.box.sdk.BoxFolder createFolder(String parentFolderId, String folderName)","com.box.sdk.BoxFolder createFolder(String parentFolderId, String[] path)"]},"createFolderSharedLink":{"description":"Create a shared link to folder","signatures":["com.box.sdk.BoxSharedLink createFolderSharedLink(String folderId, com.box.sdk.BoxSharedLink$Access access, java.util.Date unshareDate, com.box.sdk.BoxSharedLink$Permissions permissions)"]},"deleteFolder":{"description":"Delete folder","signatures":["void deleteFolder(String folderId)"]},"getFolder":{"description":"Return the Box folder referenced by path","signatures":["com.box.sdk.BoxFolder getFolder(String[] path)"]},"getFolderInfo":{"description":"Get folder information","signatures":["com.box.sdk.BoxFolder$Info getFolderInfo(String folderId, String[] fields)"]},"getFolderItems":{"description":"Returns a specific range of child items in folder and specifies which fields of each item to retrieve","signatures":["java.util.Collection getFolderItems(String folderId, Long offset, Long limit, String[] fields)"]},"moveFolder":{"description":"Move folder to destination folder while optionally giving it a new name","signatures":["com.box.sdk.BoxFolder moveFolder(String folderId, String destinationFolderId, String newName)"]},"renameFolder":{"description":"Rename folder giving it the name newName","signatures":["com.box.sdk.BoxFolder renameFolder(String folderId, String newFolderName)"]},"updateFolderInfo":{"description":"Update folder information","signatures":["com.box.sdk.BoxFolder updateFolderInfo(String folderId, com.box.sdk.BoxFolder$Info info)"]}}},"groups":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box groups","aliases":["createGroup=create","deleteGroup=delete","getAllGroups=groups","getGroupInfo=info","addGroupMembership=addMembership","deleteGroupMembership=deleteMembership","getGroupMemberships=memberships","getGroupMembershipInfo=membershipInfo","updateGroupMembershipInfo=updateMembershipInfo"],"methods":{"addGroupMembership":{"description":"Add a member to group with the specified role","signatures":["com.box.sdk.BoxGroupMembership addGroupMembership(String groupId, String userId, com.box.sdk.BoxGroupMembership$GroupRole role)"]},"createGroup":{"description":"Create a new group with a specified name and optional additional parameters","signatures":["com.box.sdk.BoxGroup createGroup(String name, String provenance, String externalSyncIdentifier, String description, String invitabilityLevel, String memberViewabilityLevel)"]},"deleteGroup":{"description":"Delete group","signatures":["void deleteGroup(String groupId)"]},"deleteGroupMembership":{"description":"Delete group membership","signatures":["void deleteGroupMembership(String groupMembershipId)"]},"getGroupInfo":{"description":"Get group information","signatures":["com.box.sdk.BoxGroup$Info getGroupInfo(String groupId)"]},"getGroupMembershipInfo":{"description":"Get group membership information","signatures":["com.box.sdk.BoxGroupMembership$Info getGroupMembershipInfo(String groupMembershipId)"]},"getGroupMemberships":{"description":"Get information about all of the group memberships for this group","signatures":["java.util.Collection getGroupMemberships(String groupId)"]},"updateGroupInfo":{"description":"Update group information","signatures":["com.box.sdk.BoxGroup updateGroupInfo(String groupId, com.box.sdk.BoxGroup$Info groupInfo)"]},"updateGroupMembershipInfo":{"description":"Update group membership information","signatures":["com.box.sdk.BoxGroupMembership updateGroupMembershipInfo(String groupMembershipId, com.box.sdk.BoxGroupMembership$Info info)"]}}},"search":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box searches","aliases":["searchFolder=search"],"methods":{"searchFolder":{"description":"Search folder and all descendant folders using the given query","signatures":["java.util.Collection searchFolder(String folderId, String query)"]}}},"tasks":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box tasks","aliases":["addFileTask=add","deleteTask=delete","getFileTasks=tasks","getTaskInfo=info","updateTaskInfo=updateInfo","addAssignmentToTask=addAssignment","deleteTaskAssignment=deleteAssignment","getTaskAssignments=assignments","getTaskAssignmentInfo=assignmentInfo"],"methods":{"addAssignmentToTask":{"description":"Add assignment for task","signatures":["com.box.sdk.BoxTask addAssignmentToTask(String taskId, com.box.sdk.BoxUser assignTo)"]},"addFileTask":{"description":"Add task to file","signatures":["com.box.sdk.BoxTask addFileTask(String fileId, com.box.sdk.BoxTask$Action action, java.util.Date dueAt, String message)"]},"deleteTask":{"description":"Delete task","signatures":["void deleteTask(String taskId)"]},"deleteTaskAssignment":{"description":"Delete task assignment","signatures":["void deleteTaskAssignment(String taskAssignmentId)"]},"getFileTasks":{"description":"Get a list of any tasks on file","signatures":["java.util.List getFileTasks(String fileId)"]},"getTaskAssignmentInfo":{"description":"Get task assignment information","signatures":["com.box.sdk.BoxTaskAssignment$Info getTaskAssignmentInfo(String taskAssignmentId)"]},"getTaskAssignments":{"description":"Get a list of any assignments for task","signatures":["java.util.List getTaskAssignments(String taskId)"]},"getTaskInfo":{"description":"Get task information","signatures":["com.box.sdk.BoxTask$Info getTaskInfo(String taskId)"]},"updateTaskInfo":{"description":"Update task information","signatures":["com.box.sdk.BoxTask updateTaskInfo(String taskId, com.box.sdk.BoxTask$Info info)"]}}},"users":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box users","aliases":["getCurrentUser=currentUser","getAllEnterpriseOrExternalUsers=users","createAppUser=create","createEnterpriseUser=create","deleteUser=delete","addUserEmailAlias=addEmailAlias","getUserEmailAlias=emailAlias","deleteUserEmailAlias=deleteEmailAlias","getUserInfo=info","updateUserInfo=updateInfo"],"methods":{"addUserEmailAlias":{"description":"Add a new email alias to user's account","signatures":["com.box.sdk.EmailAlias addUserEmailAlias(String userId, String email)"]},"createAppUser":{"description":"Provision a new app user in an enterprise with additional user information using Box Developer Edition","signatures":["com.box.sdk.BoxUser createAppUser(String name, com.box.sdk.CreateUserParams params)"]},"createEnterpriseUser":{"description":"Provision a new user in an enterprise with additional user information","signatures":["com.box.sdk.BoxUser createEnterpriseUser(String login, String name, com.box.sdk.CreateUserParams params)"]},"deleteUser":{"description":"Delete user from an enterprise account","signatures":["void deleteUser(String userId, boolean notifyUser, boolean force)"]},"deleteUserEmailAlias":{"description":"Delete an email alias from user's account","signatures":["void deleteUserEmailAlias(String userId, String emailAliasId)"]},"getAllEnterpriseOrExternalUsers":{"description":"Get any managed users that match the filter term as well as any external users that match the filter term","signatures":["java.util.List getAllEnterpriseOrExternalUsers(String filterTerm, String[] fields)"]},"getUserEmailAlias":{"description":"Get a collection of all the email aliases for user","signatures":["java.util.Collection getUserEmailAlias(String userId)"]},"getUserInfo":{"description":"Get user information","signatures":["com.box.sdk.BoxUser$Info getUserInfo(String userId)"]},"moveFolderToUser":{"description":"Move root folder for specified user to current user","signatures":["com.box.sdk.BoxFolder$Info moveFolderToUser(String userId, String sourceUserId)"]},"updateUserInfo":{"description":"Update user information","signatures":["com.box.sdk.BoxUser updateUserInfo(String userId, com.box.sdk.BoxUser$Info info)"]}}}},"apiProperties":{"collaborations":{"methods":{"addFolderCollaboration":{"properties":{"collaborator":{"index":0,"kind":"parameter","displayName":"Collaborator","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxCollaborator","deprecated":false,"autowired":false,"secret":false,"description":"The collaborator to add","optional":false},"folderId":{"index":1,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to add collaboration to","optional":false},"role":{"index":2,"kind":"parameter","displayName":"Role","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxCollaboration.Role","enum":["EDITOR","VIEWER","PREVIEWER","UPLOADER","PREVIEWER_UPLOADER","VIEWER_UPLOADER","CO_OWNER","OWNER"],"deprecated":false,"autowired":false,"secret":false,"description":"The role of the collaborator","optional":false}}},"addFolderCollaborationByEmail":{"properties":{"email":{"index":0,"kind":"parameter","displayName":"Email","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The email address of the collaborator to add","optional":false},"folderId":{"index":1,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to add collaboration to","optional":false},"role":{"index":2,"kind":"parameter","displayName":"Role","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxCollaboration.Role","enum":["EDITOR","VIEWER","PREVIEWER","UPLOADER","PREVIEWER_UPLOADER","VIEWER_UPLOADER","CO_OWNER","OWNER"],"deprecated":false,"autowired":false,"secret":false,"description":"The role of the collaborator","optional":false}}},"deleteCollaboration":{"properties":{"collaborationId":{"index":0,"kind":"parameter","displayName":"Collaboration Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of comment to change","optional":false}}},"getCollaborationInfo":{"properties":{"collaborationId":{"index":0,"kind":"parameter","displayName":"Collaboration Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of collaboration","optional":false}}},"getFolderCollaborations":{"properties":{"folderId":{"index":0,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to get collaborations information on","optional":false}}},"updateCollaborationInfo":{"properties":{"collaborationId":{"index":0,"kind":"parameter","displayName":"Collaboration Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of collaboration","optional":false},"info":{"index":1,"kind":"parameter","displayName":"Info","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxCollaboration.Info","deprecated":false,"autowired":false,"secret":false,"description":"Collaboration information to update","optional":false}}}}},"comments":{"methods":{"addFileComment":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false},"message":{"index":1,"kind":"parameter","displayName":"Message","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The comment's message","optional":false}}},"changeCommentMessage":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of comment to change","optional":false},"message":{"index":1,"kind":"parameter","displayName":"Message","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The new message for the comment","optional":false}}},"deleteComment":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of comment to delete","optional":false}}},"getCommentInfo":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of comment","optional":false}}},"getFileComments":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false}}},"replyToComment":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of comment to reply to","optional":false},"message":{"index":1,"kind":"parameter","displayName":"Message","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The message for the reply","optional":false}}}}},"event-logs":{"methods":{"getEnterpriseEvents":{"properties":{"after":{"index":0,"kind":"parameter","displayName":"After","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The lower bound on the timestamp of the events returned","optional":false},"before":{"index":1,"kind":"parameter","displayName":"Before","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The upper bound on the timestamp of the events returned","optional":false},"position":{"index":2,"kind":"parameter","displayName":"Position","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The starting position of the event stream. May be null in which case all events within bounds returned.","optional":true},"types":{"index":3,"kind":"parameter","displayName":"Types","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxEvent.EventType[]","deprecated":false,"autowired":false,"secret":false,"description":"An optional list of event types to filter by","optional":true}}}}},"events":{"methods":{"listen":{"properties":{"startingPosition":{"index":0,"kind":"parameter","displayName":"Starting Position","group":"consumer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The starting position of the event stream","optional":true}}}}},"files":{"methods":{"checkUpload":{"properties":{"fileName":{"index":0,"kind":"parameter","displayName":"File Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name to give the uploaded file","optional":false},"parentFolderId":{"index":1,"kind":"parameter","displayName":"Parent Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of parent folder","optional":false},"size":{"index":2,"kind":"parameter","displayName":"Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The size of the file's content used for monitoring the upload's progress","optional":true}}},"copyFile":{"properties":{"destinationFolderId":{"index":0,"kind":"parameter","displayName":"Destination Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the destination folder","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to copy","optional":false},"newName":{"index":2,"kind":"parameter","displayName":"New Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The new name for copied file; if newName is null, the copied file has same name as the original.","optional":true}}},"createFileMetadata":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the file to create metadata for","optional":false},"metadata":{"index":1,"kind":"parameter","displayName":"Metadata","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.Metadata","deprecated":false,"autowired":false,"secret":false,"description":"The new metadata values","optional":false},"typeName":{"index":2,"kind":"parameter","displayName":"Type Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The metadata template type name; if null the global properties template type is used.","optional":true}}},"createFileSharedLink":{"properties":{"access":{"index":0,"kind":"parameter","displayName":"Access","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxSharedLink.Access","enum":["DEFAULT","OPEN","COMPANY","COLLABORATORS"],"deprecated":false,"autowired":false,"secret":false,"description":"The access level of the shared link","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the file to create shared link on","optional":false},"permissions":{"index":2,"kind":"parameter","displayName":"Permissions","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxSharedLink.Permissions","deprecated":false,"autowired":false,"secret":false,"description":"The permissions of the created link; if permissions is null then the created shared link is created with default permissions.","optional":true},"unshareDate":{"index":3,"kind":"parameter","displayName":"Unshare Date","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The date and time at which time the created shared link will expire; if unsharedDate is null then a non-expiring link is created.","optional":true}}},"deleteFile":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to delete","optional":false}}},"deleteFileMetadata":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to delete","optional":false}}},"deleteFileVersion":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file with version to delete","optional":false},"version":{"index":1,"kind":"parameter","displayName":"Version","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The version of file to delete; initial version of file has value of 0, second version of file is 1 and so on.","optional":false}}},"downloadFile":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false},"listener":{"index":1,"kind":"parameter","displayName":"Listener","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.ProgressListener","deprecated":false,"autowired":false,"secret":false,"description":"A listener for monitoring the download's progress; if null the download's progress will not be monitored.","optional":true},"output":{"index":2,"kind":"parameter","displayName":"Output","group":"producer","label":"","required":false,"type":"object","javaType":"java.io.OutputStream","deprecated":false,"autowired":false,"secret":false,"description":"The stream to which the file contents will be written","optional":false},"rangeEnd":{"index":3,"kind":"parameter","displayName":"Range End","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The byte offset in file at which to stop the download; if null the entire contents of file will be downloaded.","optional":true},"rangeStart":{"index":4,"kind":"parameter","displayName":"Range Start","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The byte offset in file at which to start the download; if null the entire contents of file will be downloaded.","optional":true}}},"downloadPreviousFileVersion":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false},"listener":{"index":1,"kind":"parameter","displayName":"Listener","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.ProgressListener","deprecated":false,"autowired":false,"secret":false,"description":"A listener for monitoring the download's progress; if null the download's progress will not be monitored.","optional":true},"output":{"index":2,"kind":"parameter","displayName":"Output","group":"producer","label":"","required":false,"type":"object","javaType":"java.io.OutputStream","deprecated":false,"autowired":false,"secret":false,"description":"The stream to which the version contents will be written","optional":false},"version":{"index":3,"kind":"parameter","displayName":"Version","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The version of file to download; initial version of file has value of 0, second version of file is 1 and so on.","optional":false}}},"getDownloadURL":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false}}},"getFileInfo":{"properties":{"fields":{"index":0,"kind":"parameter","displayName":"Fields","group":"producer","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"The information fields to retrieve; if null all information fields are retrieved.","optional":true},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false}}},"getFileMetadata":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the file to retrieve metadata for","optional":false},"typeName":{"index":1,"kind":"parameter","displayName":"Type Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The metadata template type name; if null the global properties template type is used.","optional":true}}},"getFilePreviewLink":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the file to get preview link on","optional":false}}},"getFileVersions":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false}}},"moveFile":{"properties":{"destinationFolderId":{"index":0,"kind":"parameter","displayName":"Destination Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the destination folder","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to move","optional":false},"newName":{"index":2,"kind":"parameter","displayName":"New Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The new name of moved file; if newName is null, the moved file has same name as the original.","optional":true}}},"promoteFileVersion":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false},"version":{"index":1,"kind":"parameter","displayName":"Version","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The version of file to promote; initial version of file has value of 0, second version of file is 1 and so on.","optional":false}}},"renameFile":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to rename","optional":false},"newFileName":{"index":1,"kind":"parameter","displayName":"New File Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The new name of file","optional":false}}},"updateFileInfo":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to update","optional":false},"info":{"index":1,"kind":"parameter","displayName":"Info","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxFile.Info","deprecated":false,"autowired":false,"secret":false,"description":"The updated information","optional":false}}},"updateFileMetadata":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to delete","optional":false},"metadata":{"index":1,"kind":"parameter","displayName":"Metadata","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.Metadata","deprecated":false,"autowired":false,"secret":false,"description":"The new metadata values","optional":false}}},"uploadFile":{"properties":{"check":{"index":0,"kind":"parameter","displayName":"Check","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"If the file name is already used, call the uploadNewVersion instead.","optional":true},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"producer","label":"","required":false,"type":"object","javaType":"java.io.InputStream","deprecated":false,"autowired":false,"secret":false,"description":"A stream containing contents of the file to upload","optional":false},"created":{"index":2,"kind":"parameter","displayName":"Created","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The content created date that will be given to the uploaded file","optional":true},"fileName":{"index":3,"kind":"parameter","displayName":"File Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name to give the uploaded file","optional":false},"listener":{"index":4,"kind":"parameter","displayName":"Listener","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.ProgressListener","deprecated":false,"autowired":false,"secret":false,"description":"A listener for monitoring the upload's progress","optional":true},"modified":{"index":5,"kind":"parameter","displayName":"Modified","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The content modified date that will be given to the uploaded file","optional":true},"parentFolderId":{"index":6,"kind":"parameter","displayName":"Parent Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of parent folder","optional":false},"size":{"index":7,"kind":"parameter","displayName":"Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The size of the file's content used for monitoring the upload's progress","optional":true}}},"uploadNewFileVersion":{"properties":{"fileContent":{"index":0,"kind":"parameter","displayName":"File Content","group":"producer","label":"","required":false,"type":"object","javaType":"java.io.InputStream","deprecated":false,"autowired":false,"secret":false,"description":"A stream containing contents of the file to upload","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false},"fileSize":{"index":2,"kind":"parameter","displayName":"File Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The size of the file's content used for monitoring the upload's progress","optional":true},"listener":{"index":3,"kind":"parameter","displayName":"Listener","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.ProgressListener","deprecated":false,"autowired":false,"secret":false,"description":"A listener for monitoring the upload's progress","optional":true},"modified":{"index":4,"kind":"parameter","displayName":"Modified","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The content modified date that will be given to the uploaded file","optional":true}}}}},"folders":{"methods":{"copyFolder":{"properties":{"destinationFolderId":{"index":0,"kind":"parameter","displayName":"Destination Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the destination folder","optional":false},"folderId":{"index":1,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to copy","optional":false},"newName":{"index":2,"kind":"parameter","displayName":"New Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The new name for copied folder; if newName is null, the copied folder has same name as the original.","optional":true}}},"createFolder":{"properties":{"folderName":{"index":0,"kind":"parameter","displayName":"Folder Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of created folder","optional":false},"parentFolderId":{"index":1,"kind":"parameter","displayName":"Parent Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of parent folder","optional":false},"path":{"index":2,"kind":"parameter","displayName":"Path","group":"producer","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"Sequence of Box folder names from parent folder to returned folder","optional":false}}},"createFolderSharedLink":{"properties":{"access":{"index":0,"kind":"parameter","displayName":"Access","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxSharedLink.Access","enum":["DEFAULT","OPEN","COMPANY","COLLABORATORS"],"deprecated":false,"autowired":false,"secret":false,"description":"The access level of the shared link","optional":false},"folderId":{"index":1,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to create shared link on","optional":false},"permissions":{"index":2,"kind":"parameter","displayName":"Permissions","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxSharedLink.Permissions","deprecated":false,"autowired":false,"secret":false,"description":"The permissions of the created link; if permissions is null then the created shared link is create with default permissions.","optional":false},"unshareDate":{"index":3,"kind":"parameter","displayName":"Unshare Date","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The date and time at which time the created shared link will expire; if unsharedDate is null then a non-expiring link is created.","optional":false}}},"deleteFolder":{"properties":{"folderId":{"index":0,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to delete","optional":false}}},"getFolder":{"properties":{"path":{"index":0,"kind":"parameter","displayName":"Path","group":"producer","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"Sequence of Box folder names from root folder to returned folder","optional":false}}},"getFolderInfo":{"properties":{"fields":{"index":0,"kind":"parameter","displayName":"Fields","group":"producer","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"The information fields to retrieve; if null all information fields are retrieved.","optional":true},"folderId":{"index":1,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder","optional":false}}},"getFolderItems":{"properties":{"fields":{"index":0,"kind":"parameter","displayName":"Fields","group":"producer","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"The item fields to retrieve for each child item; if null all item fields are retrieved.","optional":true},"folderId":{"index":1,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder","optional":false},"limit":{"index":2,"kind":"parameter","displayName":"Limit","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The maximum number of children to retrieve after the offset; if null all child items are retrieved.","optional":true},"offset":{"index":3,"kind":"parameter","displayName":"Offset","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The index of first child item to retrieve; if null all child items are retrieved.","optional":true}}},"moveFolder":{"properties":{"destinationFolderId":{"index":0,"kind":"parameter","displayName":"Destination Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the destination folder","optional":false},"folderId":{"index":1,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to move","optional":false},"newName":{"index":2,"kind":"parameter","displayName":"New Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The new name of moved folder; if newName is null, the moved folder has same name as the original.","optional":true}}},"renameFolder":{"properties":{"folderId":{"index":0,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to rename","optional":false},"newFolderName":{"index":1,"kind":"parameter","displayName":"New Folder Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The new name of folder","optional":false}}},"updateFolderInfo":{"properties":{"folderId":{"index":0,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to update","optional":false},"info":{"index":1,"kind":"parameter","displayName":"Info","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxFolder.Info","deprecated":false,"autowired":false,"secret":false,"description":"The updated information","optional":false}}}}},"groups":{"methods":{"addGroupMembership":{"properties":{"groupId":{"index":0,"kind":"parameter","displayName":"Group Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group","optional":false},"role":{"index":1,"kind":"parameter","displayName":"Role","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxGroupMembership.GroupRole","enum":["ADMIN","MEMBER"],"deprecated":false,"autowired":false,"secret":false,"description":"The role of the user in this group. Can be null to assign the default role.","optional":true},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user to be added to group","optional":false}}},"createGroup":{"properties":{"description":{"index":0,"kind":"parameter","displayName":"Description","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The description of the new group","optional":true},"externalSyncIdentifier":{"index":1,"kind":"parameter","displayName":"External Sync Identifier","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The external_sync_identifier of the new group","optional":true},"invitabilityLevel":{"index":2,"kind":"parameter","displayName":"Invitability Level","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The invitibility_level of the new group","optional":true},"memberViewabilityLevel":{"index":3,"kind":"parameter","displayName":"Member Viewability Level","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The member_viewability_level of the new group","optional":true},"name":{"index":4,"kind":"parameter","displayName":"Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the new group","optional":false},"provenance":{"index":5,"kind":"parameter","displayName":"Provenance","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The provenance of the new group","optional":true}}},"deleteGroup":{"properties":{"groupId":{"index":0,"kind":"parameter","displayName":"Group Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group to delete","optional":false}}},"deleteGroupMembership":{"properties":{"groupMembershipId":{"index":0,"kind":"parameter","displayName":"Group Membership Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group membership to delete","optional":false}}},"getGroupInfo":{"properties":{"groupId":{"index":0,"kind":"parameter","displayName":"Group Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group","optional":false}}},"getGroupMembershipInfo":{"properties":{"groupMembershipId":{"index":0,"kind":"parameter","displayName":"Group Membership Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group membership","optional":false}}},"getGroupMemberships":{"properties":{"groupId":{"index":0,"kind":"parameter","displayName":"Group Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group","optional":false}}},"updateGroupInfo":{"properties":{"groupId":{"index":0,"kind":"parameter","displayName":"Group Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group to update","optional":false},"groupInfo":{"index":1,"kind":"parameter","displayName":"Group Info","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxGroup.Info","deprecated":false,"autowired":false,"secret":false,"description":"The updated information","optional":false}}},"updateGroupMembershipInfo":{"properties":{"groupMembershipId":{"index":0,"kind":"parameter","displayName":"Group Membership Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group membership to update","optional":false},"info":{"index":1,"kind":"parameter","displayName":"Info","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxGroupMembership.Info","deprecated":false,"autowired":false,"secret":false,"description":"The updated information","optional":false}}}}},"search":{"methods":{"searchFolder":{"properties":{"folderId":{"index":0,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder searched","optional":false},"query":{"index":1,"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The search query","optional":false}}}}},"tasks":{"methods":{"addAssignmentToTask":{"properties":{"assignTo":{"index":0,"kind":"parameter","displayName":"Assign To","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxUser","deprecated":false,"autowired":false,"secret":false,"description":"The user to assign to task","optional":false},"taskId":{"index":1,"kind":"parameter","displayName":"Task Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of task to add assignment for","optional":false}}},"addFileTask":{"properties":{"action":{"index":0,"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxTask.Action","enum":["REVIEW","COMPLETE"],"deprecated":false,"autowired":false,"secret":false,"description":"The action the task assignee will be prompted to do","optional":false},"dueAt":{"index":1,"kind":"parameter","displayName":"Due At","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The day at which this task is due","optional":false},"fileId":{"index":2,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to add task to","optional":false},"message":{"index":3,"kind":"parameter","displayName":"Message","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An optional message to include with the task","optional":true}}},"deleteTask":{"properties":{"taskId":{"index":0,"kind":"parameter","displayName":"Task Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of task to delete","optional":false}}},"deleteTaskAssignment":{"properties":{"taskAssignmentId":{"index":0,"kind":"parameter","displayName":"Task Assignment Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of task assignment to delete","optional":false}}},"getFileTasks":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false}}},"getTaskAssignmentInfo":{"properties":{"taskAssignmentId":{"index":0,"kind":"parameter","displayName":"Task Assignment Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of task assignment","optional":false}}},"getTaskAssignments":{"properties":{"taskId":{"index":0,"kind":"parameter","displayName":"Task Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of task","optional":false}}},"getTaskInfo":{"properties":{"taskId":{"index":0,"kind":"parameter","displayName":"Task Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of task","optional":false}}},"updateTaskInfo":{"properties":{"info":{"index":0,"kind":"parameter","displayName":"Info","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxTask.Info","deprecated":false,"autowired":false,"secret":false,"description":"The updated information","optional":false},"taskId":{"index":1,"kind":"parameter","displayName":"Task Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of task","optional":false}}}}},"users":{"methods":{"addUserEmailAlias":{"properties":{"email":{"index":0,"kind":"parameter","displayName":"Email","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The email address to add as an alias","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user","optional":false}}},"createAppUser":{"properties":{"name":{"index":0,"kind":"parameter","displayName":"Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the user","optional":false},"params":{"index":1,"kind":"parameter","displayName":"Params","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.CreateUserParams","deprecated":false,"autowired":false,"secret":false,"description":"Additional user information","optional":true}}},"createEnterpriseUser":{"properties":{"login":{"index":0,"kind":"parameter","displayName":"Login","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The email address the user will use to login","optional":false},"name":{"index":1,"kind":"parameter","displayName":"Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the user","optional":false},"params":{"index":2,"kind":"parameter","displayName":"Params","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.CreateUserParams","deprecated":false,"autowired":false,"secret":false,"description":"Additional user information","optional":true}}},"deleteUser":{"properties":{"force":{"index":0,"kind":"parameter","displayName":"Force","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Whether or not this user should be deleted even if they still own files","optional":false},"notifyUser":{"index":1,"kind":"parameter","displayName":"Notify User","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Whether or not to send an email notification to the user that their account has been deleted","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user to delete","optional":false}}},"deleteUserEmailAlias":{"properties":{"emailAliasId":{"index":0,"kind":"parameter","displayName":"Email Alias Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the email alias to delete","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user","optional":false}}},"getAllEnterpriseOrExternalUsers":{"properties":{"fields":{"index":0,"kind":"parameter","displayName":"Fields","group":"producer","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"The fields to retrieve. Leave this out for the standard fields.","optional":true},"filterTerm":{"index":1,"kind":"parameter","displayName":"Filter Term","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The filter term to lookup users by (login for external, login or name for managed); if null all managed users are returned.","optional":true}}},"getUserEmailAlias":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user","optional":false}}},"getUserInfo":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user","optional":false}}},"moveFolderToUser":{"properties":{"sourceUserId":{"index":0,"kind":"parameter","displayName":"Source User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user id of the user whose files will be the source for this operation","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user","optional":false}}},"updateUserInfo":{"properties":{"info":{"index":0,"kind":"parameter","displayName":"Info","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxUser.Info","deprecated":false,"autowired":false,"secret":false,"description":"The updated information","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user to update","optional":false}}}}}}} +{"component":{"kind":"component","name":"box","title":"Box","description":"Upload, download and manage files, folders, groups, collaborations, etc. on box.com.","deprecated":false,"firstVersion":"2.14.0","label":"cloud,file,api","javaType":"org.apache.camel.component.box.BoxComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-box","version":"4.8.2","scheme":"box","extendsScheme":"","syntax":"box:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.box.internal.BoxApiName","enum":["COLLABORATIONS","COMMENTS","EVENT_LOGS","FILES","FOLDERS","GROUPS","EVENTS","SEARCH","TASKS","USERS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"Box application client ID"},"enterpriseId":{"index":3,"kind":"parameter","displayName":"Enterprise Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The enterprise ID to use for an App Enterprise."},"inBody":{"index":4,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"userId":{"index":5,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The user ID to use for an App User."},"exceptionHandler":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."},"httpParams":{"index":9,"kind":"parameter","displayName":"Http Params","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"Custom HTTP params for settings like proxy host"},"authenticationType":{"index":10,"kind":"parameter","displayName":"Authentication Type","group":"authentication","label":"authentication","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"APP_USER_AUTHENTICATION","configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens"},"accessTokenCache":{"index":11,"kind":"parameter","displayName":"Access Token Cache","group":"security","label":"advanced,security","required":false,"type":"object","javaType":"com.box.sdk.IAccessTokenCache","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"Custom Access Token Cache for storing and retrieving access tokens."},"clientSecret":{"index":12,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"Box application client secret"},"encryptionAlgorithm":{"index":13,"kind":"parameter","displayName":"Encryption Algorithm","group":"security","label":"advanced,security","required":false,"type":"object","javaType":"com.box.sdk.EncryptionAlgorithm","enum":["RSA_SHA_256","RSA_SHA_384","RSA_SHA_512"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"RSA_SHA_256","configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512"},"maxCacheEntries":{"index":14,"kind":"parameter","displayName":"Max Cache Entries","group":"security","label":"advanced,security","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The maximum number of access tokens in cache."},"privateKeyFile":{"index":15,"kind":"parameter","displayName":"Private Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The private key for generating the JWT signature."},"privateKeyPassword":{"index":16,"kind":"parameter","displayName":"Private Key Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The password for the private key."},"publicKeyId":{"index":17,"kind":"parameter","displayName":"Public Key Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"The ID for public key for validating the JWT signature."},"sslContextParameters":{"index":18,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters."},"userName":{"index":19,"kind":"parameter","displayName":"User Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"Box user name, MUST be provided"},"userPassword":{"index":20,"kind":"parameter","displayName":"User Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.box.BoxConfiguration","configurationField":"configuration","description":"Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call"}},"apis":{"collaborations":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box collaborations","aliases":["addFolderCollaboration=add","addFolderCollaborationByEmail=addByEmail","deleteCollaboration=delete","getFolderCollaborations=collaborations","getPendingCollaborations=pendingCollaborations","getCollaborationInfo=info","updateCollaborationInfo=updateInfo"],"methods":{"addFolderCollaboration":{"description":"Add a collaboration to this folder","signatures":["com.box.sdk.BoxCollaboration addFolderCollaboration(String folderId, com.box.sdk.BoxCollaborator collaborator, com.box.sdk.BoxCollaboration$Role role)"]},"addFolderCollaborationByEmail":{"description":"Add a collaboration to this folder","signatures":["com.box.sdk.BoxCollaboration addFolderCollaborationByEmail(String folderId, String email, com.box.sdk.BoxCollaboration$Role role)"]},"deleteCollaboration":{"description":"Delete collaboration","signatures":["void deleteCollaboration(String collaborationId)"]},"getCollaborationInfo":{"description":"Get collaboration information","signatures":["com.box.sdk.BoxCollaboration$Info getCollaborationInfo(String collaborationId)"]},"getFolderCollaborations":{"description":"Get information about all of the collaborations for folder","signatures":["java.util.Collection getFolderCollaborations(String folderId)"]},"updateCollaborationInfo":{"description":"Update collaboration information","signatures":["com.box.sdk.BoxCollaboration updateCollaborationInfo(String collaborationId, com.box.sdk.BoxCollaboration$Info info)"]}}},"comments":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box comments","aliases":["addFileComment=add","changeCommentMessage=updateMessage","deleteComment=delete","getCommentInfo=info","getFileComments=comments","replyToComment=reply"],"methods":{"addFileComment":{"description":"Add comment to file","signatures":["com.box.sdk.BoxFile addFileComment(String fileId, String message)"]},"changeCommentMessage":{"description":"Change comment message","signatures":["com.box.sdk.BoxComment changeCommentMessage(String commentId, String message)"]},"deleteComment":{"description":"Delete comment","signatures":["void deleteComment(String commentId)"]},"getCommentInfo":{"description":"Get comment information","signatures":["com.box.sdk.BoxComment$Info getCommentInfo(String commentId)"]},"getFileComments":{"description":"Get a list of any comments on this file","signatures":["java.util.List getFileComments(String fileId)"]},"replyToComment":{"description":"Reply to a comment","signatures":["com.box.sdk.BoxComment replyToComment(String commentId, String message)"]}}},"event-logs":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to read Box enterprise (admin) event logs","aliases":["getEnterpriseEvents=events"],"methods":{"getEnterpriseEvents":{"description":"Create an event stream with optional starting initial position and add listener that will be notified when an event is received","signatures":["java.util.List getEnterpriseEvents(String position, java.util.Date after, java.util.Date before, com.box.sdk.BoxEvent$EventType[] types)"]}}},"events":{"consumerOnly":true,"producerOnly":false,"description":"Provides operations to manage Box events","methods":{"listen":{"description":"Create an event stream with optional starting initial position and add listener that will be notified when an event is received","signatures":["void listen(com.box.sdk.EventListener listener, Long startingPosition)"]}}},"files":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box files","aliases":["uploadFile=upload","downloadFile=download","copyFile=copy","moveFile=move","renameFile=rename","createFileSharedLink=link","deleteFile=delete","uploadNewFileVersion=uploadVersion","promoteFileVersion=promoteVersion","getFileVersions=versions","downloadPreviousFileVersion=downloadVersion","deleteFileVersion=deleteVersion","getFileInfo=info","updateFileInfo=updateInfo","createFileMetadata=createMetadata","getFileMetadata=metadata","updateFileMetadata=updateMetadata","deleteFileMetadata=deleteMetadata","getDownloadUrl=url","getPreviewLink=preview","getFileThumbnail=thumbnail","checkUpload=canUpload"],"methods":{"checkUpload":{"description":"Does a pre-verification before upload, to check if the filename already exists or if there is permission to upload","signatures":["void checkUpload(String fileName, String parentFolderId, Long size)"]},"copyFile":{"description":"Copy file to destination folder while optionally giving it a new name","signatures":["com.box.sdk.BoxFile copyFile(String fileId, String destinationFolderId, String newName)"]},"createFileMetadata":{"description":"Create metadata for file in either the global properties template or the specified template type","signatures":["com.box.sdk.Metadata createFileMetadata(String fileId, com.box.sdk.Metadata metadata, String typeName)"]},"createFileSharedLink":{"description":"Create a shared link to file","signatures":["com.box.sdk.BoxSharedLink createFileSharedLink(String fileId, com.box.sdk.BoxSharedLink$Access access, java.util.Date unshareDate, com.box.sdk.BoxSharedLink$Permissions permissions)"]},"deleteFile":{"description":"Delete the file","signatures":["void deleteFile(String fileId)"]},"deleteFileMetadata":{"description":"Delete the file properties metadata","signatures":["void deleteFileMetadata(String fileId)"]},"deleteFileVersion":{"description":"Delete a file version","signatures":["void deleteFileVersion(String fileId, Integer version)"]},"downloadFile":{"description":"Download a file","signatures":["java.io.OutputStream downloadFile(String fileId, java.io.OutputStream output, Long rangeStart, Long rangeEnd, com.box.sdk.ProgressListener listener)"]},"downloadPreviousFileVersion":{"description":"Download a previous version of file","signatures":["java.io.OutputStream downloadPreviousFileVersion(String fileId, Integer version, java.io.OutputStream output, com.box.sdk.ProgressListener listener)"]},"getDownloadURL":{"description":"Get an expiring URL for downloading a file directly from Box","signatures":["java.net.URL getDownloadURL(String fileId)"]},"getFileInfo":{"description":"Get file information","signatures":["com.box.sdk.BoxFile$Info getFileInfo(String fileId, String[] fields)"]},"getFileMetadata":{"description":"Gets the file properties metadata","signatures":["com.box.sdk.Metadata getFileMetadata(String fileId, String typeName)"]},"getFilePreviewLink":{"description":"Get an expiring URL for creating an embedded preview session","signatures":["java.net.URL getFilePreviewLink(String fileId)"]},"getFileVersions":{"description":"Get any previous versions of file","signatures":["java.util.Collection getFileVersions(String fileId)"]},"moveFile":{"description":"Move file to destination folder while optionally giving it a new name","signatures":["com.box.sdk.BoxFile moveFile(String fileId, String destinationFolderId, String newName)"]},"promoteFileVersion":{"description":"Promote a previous version of file","signatures":["com.box.sdk.BoxFileVersion promoteFileVersion(String fileId, Integer version)"]},"renameFile":{"description":"Rename file giving it the name newName","signatures":["com.box.sdk.BoxFile renameFile(String fileId, String newFileName)"]},"updateFileInfo":{"description":"Update file information","signatures":["com.box.sdk.BoxFile updateFileInfo(String fileId, com.box.sdk.BoxFile$Info info)"]},"updateFileMetadata":{"description":"Update the file properties metadata","signatures":["com.box.sdk.Metadata updateFileMetadata(String fileId, com.box.sdk.Metadata metadata)"]},"uploadFile":{"description":"Upload a new file to parent folder","signatures":["com.box.sdk.BoxFile uploadFile(String parentFolderId, java.io.InputStream content, String fileName, java.util.Date created, java.util.Date modified, Long size, Boolean check, com.box.sdk.ProgressListener listener)"]},"uploadNewFileVersion":{"description":"Upload a new version of file","signatures":["com.box.sdk.BoxFile uploadNewFileVersion(String fileId, java.io.InputStream fileContent, java.util.Date modified, Long fileSize, com.box.sdk.ProgressListener listener)"]}}},"folders":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box folders","aliases":["getRootFolder=root","createFolder=create","copyFolder=copy","moveFolder=move","renameFolder=rename","createFolderSharedLink=link","deleteFolder=delete","getFolder=folder","getFolderInfo=info","getFolderItems=items","updateFolderInfo=updateInfo"],"methods":{"copyFolder":{"description":"Copy folder to destination folder while optionally giving it a new name","signatures":["com.box.sdk.BoxFolder copyFolder(String folderId, String destinationFolderId, String newName)"]},"createFolder":{"description":"Create a folder specified by path from parent folder with given parentFolderId, creating intermediate directories as required","signatures":["com.box.sdk.BoxFolder createFolder(String parentFolderId, String folderName)","com.box.sdk.BoxFolder createFolder(String parentFolderId, String[] path)"]},"createFolderSharedLink":{"description":"Create a shared link to folder","signatures":["com.box.sdk.BoxSharedLink createFolderSharedLink(String folderId, com.box.sdk.BoxSharedLink$Access access, java.util.Date unshareDate, com.box.sdk.BoxSharedLink$Permissions permissions)"]},"deleteFolder":{"description":"Delete folder","signatures":["void deleteFolder(String folderId)"]},"getFolder":{"description":"Return the Box folder referenced by path","signatures":["com.box.sdk.BoxFolder getFolder(String[] path)"]},"getFolderInfo":{"description":"Get folder information","signatures":["com.box.sdk.BoxFolder$Info getFolderInfo(String folderId, String[] fields)"]},"getFolderItems":{"description":"Returns a specific range of child items in folder and specifies which fields of each item to retrieve","signatures":["java.util.Collection getFolderItems(String folderId, Long offset, Long limit, String[] fields)"]},"moveFolder":{"description":"Move folder to destination folder while optionally giving it a new name","signatures":["com.box.sdk.BoxFolder moveFolder(String folderId, String destinationFolderId, String newName)"]},"renameFolder":{"description":"Rename folder giving it the name newName","signatures":["com.box.sdk.BoxFolder renameFolder(String folderId, String newFolderName)"]},"updateFolderInfo":{"description":"Update folder information","signatures":["com.box.sdk.BoxFolder updateFolderInfo(String folderId, com.box.sdk.BoxFolder$Info info)"]}}},"groups":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box groups","aliases":["createGroup=create","deleteGroup=delete","getAllGroups=groups","getGroupInfo=info","addGroupMembership=addMembership","deleteGroupMembership=deleteMembership","getGroupMemberships=memberships","getGroupMembershipInfo=membershipInfo","updateGroupMembershipInfo=updateMembershipInfo"],"methods":{"addGroupMembership":{"description":"Add a member to group with the specified role","signatures":["com.box.sdk.BoxGroupMembership addGroupMembership(String groupId, String userId, com.box.sdk.BoxGroupMembership$GroupRole role)"]},"createGroup":{"description":"Create a new group with a specified name and optional additional parameters","signatures":["com.box.sdk.BoxGroup createGroup(String name, String provenance, String externalSyncIdentifier, String description, String invitabilityLevel, String memberViewabilityLevel)"]},"deleteGroup":{"description":"Delete group","signatures":["void deleteGroup(String groupId)"]},"deleteGroupMembership":{"description":"Delete group membership","signatures":["void deleteGroupMembership(String groupMembershipId)"]},"getGroupInfo":{"description":"Get group information","signatures":["com.box.sdk.BoxGroup$Info getGroupInfo(String groupId)"]},"getGroupMembershipInfo":{"description":"Get group membership information","signatures":["com.box.sdk.BoxGroupMembership$Info getGroupMembershipInfo(String groupMembershipId)"]},"getGroupMemberships":{"description":"Get information about all of the group memberships for this group","signatures":["java.util.Collection getGroupMemberships(String groupId)"]},"updateGroupInfo":{"description":"Update group information","signatures":["com.box.sdk.BoxGroup updateGroupInfo(String groupId, com.box.sdk.BoxGroup$Info groupInfo)"]},"updateGroupMembershipInfo":{"description":"Update group membership information","signatures":["com.box.sdk.BoxGroupMembership updateGroupMembershipInfo(String groupMembershipId, com.box.sdk.BoxGroupMembership$Info info)"]}}},"search":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box searches","aliases":["searchFolder=search"],"methods":{"searchFolder":{"description":"Search folder and all descendant folders using the given query","signatures":["java.util.Collection searchFolder(String folderId, String query)"]}}},"tasks":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box tasks","aliases":["addFileTask=add","deleteTask=delete","getFileTasks=tasks","getTaskInfo=info","updateTaskInfo=updateInfo","addAssignmentToTask=addAssignment","deleteTaskAssignment=deleteAssignment","getTaskAssignments=assignments","getTaskAssignmentInfo=assignmentInfo"],"methods":{"addAssignmentToTask":{"description":"Add assignment for task","signatures":["com.box.sdk.BoxTask addAssignmentToTask(String taskId, com.box.sdk.BoxUser assignTo)"]},"addFileTask":{"description":"Add task to file","signatures":["com.box.sdk.BoxTask addFileTask(String fileId, com.box.sdk.BoxTask$Action action, java.util.Date dueAt, String message)"]},"deleteTask":{"description":"Delete task","signatures":["void deleteTask(String taskId)"]},"deleteTaskAssignment":{"description":"Delete task assignment","signatures":["void deleteTaskAssignment(String taskAssignmentId)"]},"getFileTasks":{"description":"Get a list of any tasks on file","signatures":["java.util.List getFileTasks(String fileId)"]},"getTaskAssignmentInfo":{"description":"Get task assignment information","signatures":["com.box.sdk.BoxTaskAssignment$Info getTaskAssignmentInfo(String taskAssignmentId)"]},"getTaskAssignments":{"description":"Get a list of any assignments for task","signatures":["java.util.List getTaskAssignments(String taskId)"]},"getTaskInfo":{"description":"Get task information","signatures":["com.box.sdk.BoxTask$Info getTaskInfo(String taskId)"]},"updateTaskInfo":{"description":"Update task information","signatures":["com.box.sdk.BoxTask updateTaskInfo(String taskId, com.box.sdk.BoxTask$Info info)"]}}},"users":{"consumerOnly":false,"producerOnly":true,"description":"Provides operations to manage Box users","aliases":["getCurrentUser=currentUser","getAllEnterpriseOrExternalUsers=users","createAppUser=create","createEnterpriseUser=create","deleteUser=delete","addUserEmailAlias=addEmailAlias","getUserEmailAlias=emailAlias","deleteUserEmailAlias=deleteEmailAlias","getUserInfo=info","updateUserInfo=updateInfo"],"methods":{"addUserEmailAlias":{"description":"Add a new email alias to user's account","signatures":["com.box.sdk.EmailAlias addUserEmailAlias(String userId, String email)"]},"createAppUser":{"description":"Provision a new app user in an enterprise with additional user information using Box Developer Edition","signatures":["com.box.sdk.BoxUser createAppUser(String name, com.box.sdk.CreateUserParams params)"]},"createEnterpriseUser":{"description":"Provision a new user in an enterprise with additional user information","signatures":["com.box.sdk.BoxUser createEnterpriseUser(String login, String name, com.box.sdk.CreateUserParams params)"]},"deleteUser":{"description":"Delete user from an enterprise account","signatures":["void deleteUser(String userId, boolean notifyUser, boolean force)"]},"deleteUserEmailAlias":{"description":"Delete an email alias from user's account","signatures":["void deleteUserEmailAlias(String userId, String emailAliasId)"]},"getAllEnterpriseOrExternalUsers":{"description":"Get any managed users that match the filter term as well as any external users that match the filter term","signatures":["java.util.List getAllEnterpriseOrExternalUsers(String filterTerm, String[] fields)"]},"getUserEmailAlias":{"description":"Get a collection of all the email aliases for user","signatures":["java.util.Collection getUserEmailAlias(String userId)"]},"getUserInfo":{"description":"Get user information","signatures":["com.box.sdk.BoxUser$Info getUserInfo(String userId)"]},"moveFolderToUser":{"description":"Move root folder for specified user to current user","signatures":["com.box.sdk.BoxFolder$Info moveFolderToUser(String userId, String sourceUserId)"]},"updateUserInfo":{"description":"Update user information","signatures":["com.box.sdk.BoxUser updateUserInfo(String userId, com.box.sdk.BoxUser$Info info)"]}}}},"apiProperties":{"collaborations":{"methods":{"addFolderCollaboration":{"properties":{"collaborator":{"index":0,"kind":"parameter","displayName":"Collaborator","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxCollaborator","deprecated":false,"autowired":false,"secret":false,"description":"The collaborator to add","optional":false},"folderId":{"index":1,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to add collaboration to","optional":false},"role":{"index":2,"kind":"parameter","displayName":"Role","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxCollaboration.Role","enum":["EDITOR","VIEWER","PREVIEWER","UPLOADER","PREVIEWER_UPLOADER","VIEWER_UPLOADER","CO_OWNER","OWNER"],"deprecated":false,"autowired":false,"secret":false,"description":"The role of the collaborator","optional":false}}},"addFolderCollaborationByEmail":{"properties":{"email":{"index":0,"kind":"parameter","displayName":"Email","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The email address of the collaborator to add","optional":false},"folderId":{"index":1,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to add collaboration to","optional":false},"role":{"index":2,"kind":"parameter","displayName":"Role","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxCollaboration.Role","enum":["EDITOR","VIEWER","PREVIEWER","UPLOADER","PREVIEWER_UPLOADER","VIEWER_UPLOADER","CO_OWNER","OWNER"],"deprecated":false,"autowired":false,"secret":false,"description":"The role of the collaborator","optional":false}}},"deleteCollaboration":{"properties":{"collaborationId":{"index":0,"kind":"parameter","displayName":"Collaboration Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of comment to change","optional":false}}},"getCollaborationInfo":{"properties":{"collaborationId":{"index":0,"kind":"parameter","displayName":"Collaboration Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of collaboration","optional":false}}},"getFolderCollaborations":{"properties":{"folderId":{"index":0,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to get collaborations information on","optional":false}}},"updateCollaborationInfo":{"properties":{"collaborationId":{"index":0,"kind":"parameter","displayName":"Collaboration Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of collaboration","optional":false},"info":{"index":1,"kind":"parameter","displayName":"Info","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxCollaboration.Info","deprecated":false,"autowired":false,"secret":false,"description":"Collaboration information to update","optional":false}}}}},"comments":{"methods":{"addFileComment":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false},"message":{"index":1,"kind":"parameter","displayName":"Message","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The comment's message","optional":false}}},"changeCommentMessage":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of comment to change","optional":false},"message":{"index":1,"kind":"parameter","displayName":"Message","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The new message for the comment","optional":false}}},"deleteComment":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of comment to delete","optional":false}}},"getCommentInfo":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of comment","optional":false}}},"getFileComments":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false}}},"replyToComment":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of comment to reply to","optional":false},"message":{"index":1,"kind":"parameter","displayName":"Message","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The message for the reply","optional":false}}}}},"event-logs":{"methods":{"getEnterpriseEvents":{"properties":{"after":{"index":0,"kind":"parameter","displayName":"After","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The lower bound on the timestamp of the events returned","optional":false},"before":{"index":1,"kind":"parameter","displayName":"Before","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The upper bound on the timestamp of the events returned","optional":false},"position":{"index":2,"kind":"parameter","displayName":"Position","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The starting position of the event stream. May be null in which case all events within bounds returned.","optional":true},"types":{"index":3,"kind":"parameter","displayName":"Types","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxEvent.EventType[]","deprecated":false,"autowired":false,"secret":false,"description":"An optional list of event types to filter by","optional":true}}}}},"events":{"methods":{"listen":{"properties":{"startingPosition":{"index":0,"kind":"parameter","displayName":"Starting Position","group":"consumer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The starting position of the event stream","optional":true}}}}},"files":{"methods":{"checkUpload":{"properties":{"fileName":{"index":0,"kind":"parameter","displayName":"File Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name to give the uploaded file","optional":false},"parentFolderId":{"index":1,"kind":"parameter","displayName":"Parent Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of parent folder","optional":false},"size":{"index":2,"kind":"parameter","displayName":"Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The size of the file's content used for monitoring the upload's progress","optional":true}}},"copyFile":{"properties":{"destinationFolderId":{"index":0,"kind":"parameter","displayName":"Destination Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the destination folder","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to copy","optional":false},"newName":{"index":2,"kind":"parameter","displayName":"New Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The new name for copied file; if newName is null, the copied file has same name as the original.","optional":true}}},"createFileMetadata":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the file to create metadata for","optional":false},"metadata":{"index":1,"kind":"parameter","displayName":"Metadata","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.Metadata","deprecated":false,"autowired":false,"secret":false,"description":"The new metadata values","optional":false},"typeName":{"index":2,"kind":"parameter","displayName":"Type Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The metadata template type name; if null the global properties template type is used.","optional":true}}},"createFileSharedLink":{"properties":{"access":{"index":0,"kind":"parameter","displayName":"Access","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxSharedLink.Access","enum":["DEFAULT","OPEN","COMPANY","COLLABORATORS"],"deprecated":false,"autowired":false,"secret":false,"description":"The access level of the shared link","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the file to create shared link on","optional":false},"permissions":{"index":2,"kind":"parameter","displayName":"Permissions","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxSharedLink.Permissions","deprecated":false,"autowired":false,"secret":false,"description":"The permissions of the created link; if permissions is null then the created shared link is created with default permissions.","optional":true},"unshareDate":{"index":3,"kind":"parameter","displayName":"Unshare Date","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The date and time at which time the created shared link will expire; if unsharedDate is null then a non-expiring link is created.","optional":true}}},"deleteFile":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to delete","optional":false}}},"deleteFileMetadata":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to delete","optional":false}}},"deleteFileVersion":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file with version to delete","optional":false},"version":{"index":1,"kind":"parameter","displayName":"Version","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The version of file to delete; initial version of file has value of 0, second version of file is 1 and so on.","optional":false}}},"downloadFile":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false},"listener":{"index":1,"kind":"parameter","displayName":"Listener","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.ProgressListener","deprecated":false,"autowired":false,"secret":false,"description":"A listener for monitoring the download's progress; if null the download's progress will not be monitored.","optional":true},"output":{"index":2,"kind":"parameter","displayName":"Output","group":"producer","label":"","required":false,"type":"object","javaType":"java.io.OutputStream","deprecated":false,"autowired":false,"secret":false,"description":"The stream to which the file contents will be written","optional":false},"rangeEnd":{"index":3,"kind":"parameter","displayName":"Range End","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The byte offset in file at which to stop the download; if null the entire contents of file will be downloaded.","optional":true},"rangeStart":{"index":4,"kind":"parameter","displayName":"Range Start","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The byte offset in file at which to start the download; if null the entire contents of file will be downloaded.","optional":true}}},"downloadPreviousFileVersion":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false},"listener":{"index":1,"kind":"parameter","displayName":"Listener","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.ProgressListener","deprecated":false,"autowired":false,"secret":false,"description":"A listener for monitoring the download's progress; if null the download's progress will not be monitored.","optional":true},"output":{"index":2,"kind":"parameter","displayName":"Output","group":"producer","label":"","required":false,"type":"object","javaType":"java.io.OutputStream","deprecated":false,"autowired":false,"secret":false,"description":"The stream to which the version contents will be written","optional":false},"version":{"index":3,"kind":"parameter","displayName":"Version","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The version of file to download; initial version of file has value of 0, second version of file is 1 and so on.","optional":false}}},"getDownloadURL":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false}}},"getFileInfo":{"properties":{"fields":{"index":0,"kind":"parameter","displayName":"Fields","group":"producer","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"The information fields to retrieve; if null all information fields are retrieved.","optional":true},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false}}},"getFileMetadata":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the file to retrieve metadata for","optional":false},"typeName":{"index":1,"kind":"parameter","displayName":"Type Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The metadata template type name; if null the global properties template type is used.","optional":true}}},"getFilePreviewLink":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the file to get preview link on","optional":false}}},"getFileVersions":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false}}},"moveFile":{"properties":{"destinationFolderId":{"index":0,"kind":"parameter","displayName":"Destination Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the destination folder","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to move","optional":false},"newName":{"index":2,"kind":"parameter","displayName":"New Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The new name of moved file; if newName is null, the moved file has same name as the original.","optional":true}}},"promoteFileVersion":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false},"version":{"index":1,"kind":"parameter","displayName":"Version","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The version of file to promote; initial version of file has value of 0, second version of file is 1 and so on.","optional":false}}},"renameFile":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to rename","optional":false},"newFileName":{"index":1,"kind":"parameter","displayName":"New File Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The new name of file","optional":false}}},"updateFileInfo":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to update","optional":false},"info":{"index":1,"kind":"parameter","displayName":"Info","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxFile.Info","deprecated":false,"autowired":false,"secret":false,"description":"The updated information","optional":false}}},"updateFileMetadata":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to delete","optional":false},"metadata":{"index":1,"kind":"parameter","displayName":"Metadata","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.Metadata","deprecated":false,"autowired":false,"secret":false,"description":"The new metadata values","optional":false}}},"uploadFile":{"properties":{"check":{"index":0,"kind":"parameter","displayName":"Check","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"If the file name is already used, call the uploadNewVersion instead.","optional":true},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"producer","label":"","required":false,"type":"object","javaType":"java.io.InputStream","deprecated":false,"autowired":false,"secret":false,"description":"A stream containing contents of the file to upload","optional":false},"created":{"index":2,"kind":"parameter","displayName":"Created","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The content created date that will be given to the uploaded file","optional":true},"fileName":{"index":3,"kind":"parameter","displayName":"File Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name to give the uploaded file","optional":false},"listener":{"index":4,"kind":"parameter","displayName":"Listener","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.ProgressListener","deprecated":false,"autowired":false,"secret":false,"description":"A listener for monitoring the upload's progress","optional":true},"modified":{"index":5,"kind":"parameter","displayName":"Modified","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The content modified date that will be given to the uploaded file","optional":true},"parentFolderId":{"index":6,"kind":"parameter","displayName":"Parent Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of parent folder","optional":false},"size":{"index":7,"kind":"parameter","displayName":"Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The size of the file's content used for monitoring the upload's progress","optional":true}}},"uploadNewFileVersion":{"properties":{"fileContent":{"index":0,"kind":"parameter","displayName":"File Content","group":"producer","label":"","required":false,"type":"object","javaType":"java.io.InputStream","deprecated":false,"autowired":false,"secret":false,"description":"A stream containing contents of the file to upload","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false},"fileSize":{"index":2,"kind":"parameter","displayName":"File Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The size of the file's content used for monitoring the upload's progress","optional":true},"listener":{"index":3,"kind":"parameter","displayName":"Listener","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.ProgressListener","deprecated":false,"autowired":false,"secret":false,"description":"A listener for monitoring the upload's progress","optional":true},"modified":{"index":4,"kind":"parameter","displayName":"Modified","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The content modified date that will be given to the uploaded file","optional":true}}}}},"folders":{"methods":{"copyFolder":{"properties":{"destinationFolderId":{"index":0,"kind":"parameter","displayName":"Destination Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the destination folder","optional":false},"folderId":{"index":1,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to copy","optional":false},"newName":{"index":2,"kind":"parameter","displayName":"New Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The new name for copied folder; if newName is null, the copied folder has same name as the original.","optional":true}}},"createFolder":{"properties":{"folderName":{"index":0,"kind":"parameter","displayName":"Folder Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of created folder","optional":false},"parentFolderId":{"index":1,"kind":"parameter","displayName":"Parent Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of parent folder","optional":false},"path":{"index":2,"kind":"parameter","displayName":"Path","group":"producer","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"Sequence of Box folder names from parent folder to returned folder","optional":false}}},"createFolderSharedLink":{"properties":{"access":{"index":0,"kind":"parameter","displayName":"Access","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxSharedLink.Access","enum":["DEFAULT","OPEN","COMPANY","COLLABORATORS"],"deprecated":false,"autowired":false,"secret":false,"description":"The access level of the shared link","optional":false},"folderId":{"index":1,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to create shared link on","optional":false},"permissions":{"index":2,"kind":"parameter","displayName":"Permissions","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxSharedLink.Permissions","deprecated":false,"autowired":false,"secret":false,"description":"The permissions of the created link; if permissions is null then the created shared link is create with default permissions.","optional":false},"unshareDate":{"index":3,"kind":"parameter","displayName":"Unshare Date","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The date and time at which time the created shared link will expire; if unsharedDate is null then a non-expiring link is created.","optional":false}}},"deleteFolder":{"properties":{"folderId":{"index":0,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to delete","optional":false}}},"getFolder":{"properties":{"path":{"index":0,"kind":"parameter","displayName":"Path","group":"producer","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"Sequence of Box folder names from root folder to returned folder","optional":false}}},"getFolderInfo":{"properties":{"fields":{"index":0,"kind":"parameter","displayName":"Fields","group":"producer","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"The information fields to retrieve; if null all information fields are retrieved.","optional":true},"folderId":{"index":1,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder","optional":false}}},"getFolderItems":{"properties":{"fields":{"index":0,"kind":"parameter","displayName":"Fields","group":"producer","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"The item fields to retrieve for each child item; if null all item fields are retrieved.","optional":true},"folderId":{"index":1,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder","optional":false},"limit":{"index":2,"kind":"parameter","displayName":"Limit","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The maximum number of children to retrieve after the offset; if null all child items are retrieved.","optional":true},"offset":{"index":3,"kind":"parameter","displayName":"Offset","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The index of first child item to retrieve; if null all child items are retrieved.","optional":true}}},"moveFolder":{"properties":{"destinationFolderId":{"index":0,"kind":"parameter","displayName":"Destination Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the destination folder","optional":false},"folderId":{"index":1,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to move","optional":false},"newName":{"index":2,"kind":"parameter","displayName":"New Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The new name of moved folder; if newName is null, the moved folder has same name as the original.","optional":true}}},"renameFolder":{"properties":{"folderId":{"index":0,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to rename","optional":false},"newFolderName":{"index":1,"kind":"parameter","displayName":"New Folder Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The new name of folder","optional":false}}},"updateFolderInfo":{"properties":{"folderId":{"index":0,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder to update","optional":false},"info":{"index":1,"kind":"parameter","displayName":"Info","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxFolder.Info","deprecated":false,"autowired":false,"secret":false,"description":"The updated information","optional":false}}}}},"groups":{"methods":{"addGroupMembership":{"properties":{"groupId":{"index":0,"kind":"parameter","displayName":"Group Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group","optional":false},"role":{"index":1,"kind":"parameter","displayName":"Role","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxGroupMembership.GroupRole","enum":["ADMIN","MEMBER"],"deprecated":false,"autowired":false,"secret":false,"description":"The role of the user in this group. Can be null to assign the default role.","optional":true},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user to be added to group","optional":false}}},"createGroup":{"properties":{"description":{"index":0,"kind":"parameter","displayName":"Description","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The description of the new group","optional":true},"externalSyncIdentifier":{"index":1,"kind":"parameter","displayName":"External Sync Identifier","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The external_sync_identifier of the new group","optional":true},"invitabilityLevel":{"index":2,"kind":"parameter","displayName":"Invitability Level","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The invitibility_level of the new group","optional":true},"memberViewabilityLevel":{"index":3,"kind":"parameter","displayName":"Member Viewability Level","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The member_viewability_level of the new group","optional":true},"name":{"index":4,"kind":"parameter","displayName":"Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the new group","optional":false},"provenance":{"index":5,"kind":"parameter","displayName":"Provenance","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The provenance of the new group","optional":true}}},"deleteGroup":{"properties":{"groupId":{"index":0,"kind":"parameter","displayName":"Group Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group to delete","optional":false}}},"deleteGroupMembership":{"properties":{"groupMembershipId":{"index":0,"kind":"parameter","displayName":"Group Membership Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group membership to delete","optional":false}}},"getGroupInfo":{"properties":{"groupId":{"index":0,"kind":"parameter","displayName":"Group Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group","optional":false}}},"getGroupMembershipInfo":{"properties":{"groupMembershipId":{"index":0,"kind":"parameter","displayName":"Group Membership Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group membership","optional":false}}},"getGroupMemberships":{"properties":{"groupId":{"index":0,"kind":"parameter","displayName":"Group Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group","optional":false}}},"updateGroupInfo":{"properties":{"groupId":{"index":0,"kind":"parameter","displayName":"Group Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group to update","optional":false},"groupInfo":{"index":1,"kind":"parameter","displayName":"Group Info","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxGroup.Info","deprecated":false,"autowired":false,"secret":false,"description":"The updated information","optional":false}}},"updateGroupMembershipInfo":{"properties":{"groupMembershipId":{"index":0,"kind":"parameter","displayName":"Group Membership Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of group membership to update","optional":false},"info":{"index":1,"kind":"parameter","displayName":"Info","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxGroupMembership.Info","deprecated":false,"autowired":false,"secret":false,"description":"The updated information","optional":false}}}}},"search":{"methods":{"searchFolder":{"properties":{"folderId":{"index":0,"kind":"parameter","displayName":"Folder Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of folder searched","optional":false},"query":{"index":1,"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The search query","optional":false}}}}},"tasks":{"methods":{"addAssignmentToTask":{"properties":{"assignTo":{"index":0,"kind":"parameter","displayName":"Assign To","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxUser","deprecated":false,"autowired":false,"secret":false,"description":"The user to assign to task","optional":false},"taskId":{"index":1,"kind":"parameter","displayName":"Task Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of task to add assignment for","optional":false}}},"addFileTask":{"properties":{"action":{"index":0,"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxTask.Action","enum":["REVIEW","COMPLETE"],"deprecated":false,"autowired":false,"secret":false,"description":"The action the task assignee will be prompted to do","optional":false},"dueAt":{"index":1,"kind":"parameter","displayName":"Due At","group":"producer","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"The day at which this task is due","optional":false},"fileId":{"index":2,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file to add task to","optional":false},"message":{"index":3,"kind":"parameter","displayName":"Message","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An optional message to include with the task","optional":true}}},"deleteTask":{"properties":{"taskId":{"index":0,"kind":"parameter","displayName":"Task Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of task to delete","optional":false}}},"deleteTaskAssignment":{"properties":{"taskAssignmentId":{"index":0,"kind":"parameter","displayName":"Task Assignment Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of task assignment to delete","optional":false}}},"getFileTasks":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of file","optional":false}}},"getTaskAssignmentInfo":{"properties":{"taskAssignmentId":{"index":0,"kind":"parameter","displayName":"Task Assignment Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of task assignment","optional":false}}},"getTaskAssignments":{"properties":{"taskId":{"index":0,"kind":"parameter","displayName":"Task Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of task","optional":false}}},"getTaskInfo":{"properties":{"taskId":{"index":0,"kind":"parameter","displayName":"Task Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of task","optional":false}}},"updateTaskInfo":{"properties":{"info":{"index":0,"kind":"parameter","displayName":"Info","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxTask.Info","deprecated":false,"autowired":false,"secret":false,"description":"The updated information","optional":false},"taskId":{"index":1,"kind":"parameter","displayName":"Task Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of task","optional":false}}}}},"users":{"methods":{"addUserEmailAlias":{"properties":{"email":{"index":0,"kind":"parameter","displayName":"Email","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The email address to add as an alias","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user","optional":false}}},"createAppUser":{"properties":{"name":{"index":0,"kind":"parameter","displayName":"Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the user","optional":false},"params":{"index":1,"kind":"parameter","displayName":"Params","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.CreateUserParams","deprecated":false,"autowired":false,"secret":false,"description":"Additional user information","optional":true}}},"createEnterpriseUser":{"properties":{"login":{"index":0,"kind":"parameter","displayName":"Login","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The email address the user will use to login","optional":false},"name":{"index":1,"kind":"parameter","displayName":"Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the user","optional":false},"params":{"index":2,"kind":"parameter","displayName":"Params","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.CreateUserParams","deprecated":false,"autowired":false,"secret":false,"description":"Additional user information","optional":true}}},"deleteUser":{"properties":{"force":{"index":0,"kind":"parameter","displayName":"Force","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Whether or not this user should be deleted even if they still own files","optional":false},"notifyUser":{"index":1,"kind":"parameter","displayName":"Notify User","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Whether or not to send an email notification to the user that their account has been deleted","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user to delete","optional":false}}},"deleteUserEmailAlias":{"properties":{"emailAliasId":{"index":0,"kind":"parameter","displayName":"Email Alias Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the email alias to delete","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user","optional":false}}},"getAllEnterpriseOrExternalUsers":{"properties":{"fields":{"index":0,"kind":"parameter","displayName":"Fields","group":"producer","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"The fields to retrieve. Leave this out for the standard fields.","optional":true},"filterTerm":{"index":1,"kind":"parameter","displayName":"Filter Term","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The filter term to lookup users by (login for external, login or name for managed); if null all managed users are returned.","optional":true}}},"getUserEmailAlias":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user","optional":false}}},"getUserInfo":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user","optional":false}}},"moveFolderToUser":{"properties":{"sourceUserId":{"index":0,"kind":"parameter","displayName":"Source User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user id of the user whose files will be the source for this operation","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user","optional":false}}},"updateUserInfo":{"properties":{"info":{"index":0,"kind":"parameter","displayName":"Info","group":"producer","label":"","required":false,"type":"object","javaType":"com.box.sdk.BoxUser.Info","deprecated":false,"autowired":false,"secret":false,"description":"The updated information","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of user to update","optional":false}}}}}}} , -{"component":{"kind":"component","name":"braintree","title":"Braintree","description":"Process payments using Braintree Payments.","deprecated":false,"firstVersion":"2.17.0","label":"saas","javaType":"org.apache.camel.component.braintree.BraintreeComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-braintree","version":"4.8.1","scheme":"braintree","extendsScheme":"","syntax":"braintree:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.braintree.internal.BraintreeApiName","enum":["ADD_ON","ADDRESS","CLIENT_TOKEN","CREDIT_CARD_VERIFICATION","CUSTOMER","DISCOUNT","DISPUTE","DOCUMENT_UPLOAD","MERCHANT_ACCOUNT","PAYMENT_METHOD","PAYMENT_METHOD_NONCE","OAUTH","PLAN","REPORT","SETTLEMENT_BATCH_SUMMARY","SUBSCRIPTION","TRANSACTION","US_BANK_ACCOUNT","WEBHOOK_NOTIFICATION"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["accept","addFileEvidence","addTextEvidence","cancel","cancelRelease","cloneTransaction","create","createForCurrency","credit","delete","fetchMerchantAccounts","finalize","find","generate","grant","holdInEscrow","parse","refund","releaseFromEscrow","removeEvidence","retryCharge","revoke","sale","search","submitForPartialSettlement","submitForSettlement","transactionLevelFees","update","updateDetails","verify","voidTransaction"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"environment":{"index":2,"kind":"parameter","displayName":"Environment","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"The environment Either SANDBOX or PRODUCTION"},"inBody":{"index":3,"kind":"parameter","displayName":"In Body","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"merchantId":{"index":4,"kind":"parameter","displayName":"Merchant Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"The merchant id provided by Braintree."},"lazyStartProducer":{"index":5,"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."},"httpReadTimeout":{"index":6,"kind":"parameter","displayName":"Http Read Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"Set read timeout for http calls."},"httpLogLevel":{"index":7,"kind":"parameter","displayName":"Http Log Level","group":"logging","label":"logging","required":false,"type":"string","javaType":"java.lang.String","enum":["OFF","SEVERE","WARNING","INFO","CONFIG","FINE","FINER","FINEST","ALL"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"Set logging level for http calls, see java.util.logging.Level"},"httpLogName":{"index":8,"kind":"parameter","displayName":"Http Log Name","group":"logging","label":"logging","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Braintree","configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"Set log category to use to log http calls."},"logHandlerEnabled":{"index":9,"kind":"parameter","displayName":"Log Handler Enabled","group":"logging","label":"logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"Sets whether to enable the BraintreeLogHandler. It may be desirable to set this to 'false' where an existing JUL - SLF4J logger bridge is on the classpath. This option can also be configured globally on the BraintreeComponent."},"proxyHost":{"index":10,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"The proxy host"},"proxyPort":{"index":11,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"The proxy port"},"accessToken":{"index":12,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"The access token granted by a merchant to another in order to process transactions on their behalf. Used in place of environment, merchant id, public key and private key fields."},"privateKey":{"index":13,"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"The private key provided by Braintree."},"publicKey":{"index":14,"kind":"parameter","displayName":"Public Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"The public key provided by Braintree."}},"apis":{"address":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to create, delete, find, and update Address objects","methods":{"create":{"description":"Creates an Address for a Customer","signatures":["com.braintreegateway.Result create(String customerId, com.braintreegateway.AddressRequest request)"]},"delete":{"description":"Deletes a Customer's Address","signatures":["com.braintreegateway.Result delete(String customerId, String id)"]},"find":{"description":"Finds a Customer's Address","signatures":["com.braintreegateway.Address find(String customerId, String id)"]},"update":{"description":"Updates a Customer's Address","signatures":["com.braintreegateway.Result update(String customerId, String id, com.braintreegateway.AddressRequest request)"]}}},"clientToken":{"consumerOnly":false,"producerOnly":true,"description":"Generates client tokens, which are used to authenticate requests made directly on behalf of merchants This class does not need to be instantiated directly","methods":{"generate":{"description":"","signatures":["String generate()","String generate(com.braintreegateway.ClientTokenRequest request)"]}}},"creditCardVerification":{"consumerOnly":false,"producerOnly":true,"description":"To verify credit card information","methods":{"create":{"description":"","signatures":["com.braintreegateway.Result create(com.braintreegateway.CreditCardVerificationRequest request)"]},"find":{"description":"","signatures":["com.braintreegateway.CreditCardVerification find(String id)"]},"search":{"description":"","signatures":["com.braintreegateway.ResourceCollection search(com.braintreegateway.CreditCardVerificationSearchRequest query)"]}}},"customer":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to create, delete, find, and update Customer objects","methods":{"create":{"description":"Creates a Customer","signatures":["com.braintreegateway.Result create(com.braintreegateway.CustomerRequest request)"]},"delete":{"description":"Deletes a Customer by id","signatures":["com.braintreegateway.Result delete(String id)"]},"find":{"description":"Finds a Customer by id","signatures":["com.braintreegateway.Customer find(String id)","com.braintreegateway.Customer find(String id, String associationFilterId)"]},"search":{"description":"Finds all Transactions that match the query and returns a ResourceCollection","signatures":["com.braintreegateway.ResourceCollection search(com.braintreegateway.CustomerSearchRequest query)"]},"update":{"description":"Updates a Customer","signatures":["com.braintreegateway.Result update(String id, com.braintreegateway.CustomerRequest request)"]}}},"dispute":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to interact with Dispute objects","methods":{"accept":{"description":"Accept a Dispute, given a dispute ID","signatures":["com.braintreegateway.Result accept(String id)"]},"addFileEvidence":{"description":"Add File Evidence to a Dispute, given an ID and a FileEvidenceRequest File evidence request","signatures":["com.braintreegateway.Result addFileEvidence(String disputeId, String documentId)","com.braintreegateway.Result addFileEvidence(String disputeId, com.braintreegateway.FileEvidenceRequest fileEvidenceRequest)"]},"addTextEvidence":{"description":"Add Text Evidence to a Dispute, given an ID and content","signatures":["com.braintreegateway.Result addTextEvidence(String id, String content)","com.braintreegateway.Result addTextEvidence(String id, com.braintreegateway.TextEvidenceRequest textEvidenceRequest)"]},"finalize":{"description":"Finalize a Dispute, given an ID","signatures":["com.braintreegateway.Result finalize(String id)"]},"find":{"description":"Returns a Dispute, given an ID","signatures":["com.braintreegateway.Dispute find(String id)"]},"removeEvidence":{"description":"Remove Evidence from a Dispute, given an ID and a DisputeEvidence ID","signatures":["com.braintreegateway.Result removeEvidence(String disputeId, String evidenceId)"]},"search":{"description":"Finds all Disputes that match the query","signatures":["com.braintreegateway.PaginatedCollection search(com.braintreegateway.DisputeSearchRequest query)"]}}},"documentUpload":{"consumerOnly":false,"producerOnly":true,"description":"API to upload evidence documents","methods":{"create":{"description":"","signatures":["com.braintreegateway.Result create(com.braintreegateway.DocumentUploadRequest request)"]}}},"merchantAccount":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to create, find, and update MerchantAccount objects","methods":{"create":{"description":"","signatures":["com.braintreegateway.Result create(com.braintreegateway.MerchantAccountRequest request)"]},"createForCurrency":{"description":"","signatures":["com.braintreegateway.Result createForCurrency(com.braintreegateway.MerchantAccountCreateForCurrencyRequest request)"]},"fetchMerchantAccounts":{"description":"","signatures":["com.braintreegateway.PaginatedResult fetchMerchantAccounts(int page)"]},"find":{"description":"","signatures":["com.braintreegateway.MerchantAccount find(String id)"]},"update":{"description":"","signatures":["com.braintreegateway.Result update(String id, com.braintreegateway.MerchantAccountRequest request)"]}}},"oauth":{"consumerOnly":false,"producerOnly":true,"description":"","methods":{"connectUrl":{"description":"","signatures":["String connectUrl(com.braintreegateway.OAuthConnectUrlRequest request)"]},"createTokenFromCode":{"description":"","signatures":["com.braintreegateway.Result createTokenFromCode(com.braintreegateway.OAuthCredentialsRequest request)"]},"createTokenFromRefreshToken":{"description":"","signatures":["com.braintreegateway.Result createTokenFromRefreshToken(com.braintreegateway.OAuthCredentialsRequest request)"]},"revokeAccessToken":{"description":"","signatures":["com.braintreegateway.Result revokeAccessToken(String accessToken)"]}}},"paymentMethod":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to interact with payments","methods":{"create":{"description":"","signatures":["com.braintreegateway.Result create(com.braintreegateway.PaymentMethodRequest request)"]},"delete":{"description":"","signatures":["com.braintreegateway.Result delete(String token)","com.braintreegateway.Result delete(String token, com.braintreegateway.PaymentMethodDeleteRequest request)"]},"find":{"description":"","signatures":["com.braintreegateway.PaymentMethod find(String token)"]},"grant":{"description":"","signatures":["com.braintreegateway.Result grant(String token)","com.braintreegateway.Result grant(String token, com.braintreegateway.PaymentMethodGrantRequest grantRequest)"]},"revoke":{"description":"","signatures":["com.braintreegateway.Result revoke(String token)"]},"update":{"description":"","signatures":["com.braintreegateway.Result update(String token, com.braintreegateway.PaymentMethodRequest request)"]}}},"paymentMethodNonce":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to interact with nonce payments","methods":{"create":{"description":"","signatures":["com.braintreegateway.Result create(String paymentMethodToken)","com.braintreegateway.Result create(com.braintreegateway.PaymentMethodNonceRequest request)"]},"find":{"description":"","signatures":["com.braintreegateway.PaymentMethodNonce find(String paymentMethodNonce)"]}}},"plan":{"consumerOnly":false,"producerOnly":true,"description":"","methods":{"create":{"description":"","signatures":["com.braintreegateway.Result create(com.braintreegateway.PlanRequest request)"]},"find":{"description":"","signatures":["com.braintreegateway.Plan find(String id)"]},"update":{"description":"","signatures":["com.braintreegateway.Result update(String id, com.braintreegateway.PlanRequest request)"]}}},"report":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to interact with reports","methods":{"transactionLevelFees":{"description":"Retrieves a Transaction-Level Fee Report","signatures":["com.braintreegateway.Result transactionLevelFees(com.braintreegateway.TransactionLevelFeeReportRequest request)"]}}},"settlementBatchSummary":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to interact wit settlement summaries","methods":{"generate":{"description":"","signatures":["com.braintreegateway.Result generate(java.util.Calendar settlementDate)","com.braintreegateway.Result generate(java.util.Calendar settlementDate, String groupByCustomField)"]}}},"subscription":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to interact with Subscriptions","methods":{"cancel":{"description":"Cancels the Subscription with the given id","signatures":["com.braintreegateway.Result cancel(String id)"]},"create":{"description":"Creates a Subscription","signatures":["com.braintreegateway.Result create(com.braintreegateway.SubscriptionRequest request)"]},"delete":{"description":"","signatures":["com.braintreegateway.Result delete(String customerId, String id)"]},"find":{"description":"Finds a Subscription by id","signatures":["com.braintreegateway.Subscription find(String id)"]},"retryCharge":{"description":"","signatures":["com.braintreegateway.Result retryCharge(String subscriptionId)","com.braintreegateway.Result retryCharge(String subscriptionId, Boolean submitForSettlement)","com.braintreegateway.Result retryCharge(String subscriptionId, java.math.BigDecimal amount)","com.braintreegateway.Result retryCharge(String subscriptionId, java.math.BigDecimal amount, Boolean submitForSettlement)"]},"search":{"description":"Search for a Subscription","signatures":["com.braintreegateway.ResourceCollection search(com.braintreegateway.SubscriptionSearchRequest searchRequest)"]},"update":{"description":"Updates a Subscription","signatures":["com.braintreegateway.Result update(String id, com.braintreegateway.SubscriptionRequest request)"]}}},"transaction":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to interact with Transactions","methods":{"adjustAuthorization":{"description":"Submits the transaction with the given id to be adjusted for the given amount which must be less than or equal to the authorization amount","signatures":["com.braintreegateway.Result adjustAuthorization(String id, com.braintreegateway.TransactionRequest request)","com.braintreegateway.Result adjustAuthorization(String id, java.math.BigDecimal amount)"]},"cancelRelease":{"description":"Cancels a pending release of a transaction with the given id from escrow","signatures":["com.braintreegateway.Result cancelRelease(String id)"]},"cloneTransaction":{"description":"","signatures":["com.braintreegateway.Result cloneTransaction(String id, com.braintreegateway.TransactionCloneRequest request)"]},"credit":{"description":"Creates a credit Transaction","signatures":["com.braintreegateway.Result credit(com.braintreegateway.TransactionRequest request)"]},"find":{"description":"Finds a Transaction by id","signatures":["com.braintreegateway.Transaction find(String id)"]},"holdInEscrow":{"description":"Holds the transaction with the given id for escrow","signatures":["com.braintreegateway.Result holdInEscrow(String id)"]},"packageTracking":{"description":"Supplement the transaction with package tracking details","signatures":["com.braintreegateway.Result packageTracking(String id, com.braintreegateway.PackageTrackingRequest packageTrackingRequest)"]},"refund":{"description":"Refunds all or part of a previous sale Transaction","signatures":["com.braintreegateway.Result refund(String id)","com.braintreegateway.Result refund(String id, com.braintreegateway.TransactionRefundRequest request)","com.braintreegateway.Result refund(String id, java.math.BigDecimal amount)"]},"releaseFromEscrow":{"description":"Submits the transaction with the given id for release","signatures":["com.braintreegateway.Result releaseFromEscrow(String id)"]},"sale":{"description":"Creates a sale Transaction","signatures":["com.braintreegateway.Result sale(com.braintreegateway.TransactionRequest request)"]},"search":{"description":"Finds all Transactions that match the query and returns a ResourceCollection","signatures":["com.braintreegateway.ResourceCollection search(com.braintreegateway.TransactionSearchRequest query)"]},"submitForPartialSettlement":{"description":"Submits a partial settlement transaction for the given id","signatures":["com.braintreegateway.Result submitForPartialSettlement(String id, com.braintreegateway.TransactionRequest request)","com.braintreegateway.Result submitForPartialSettlement(String id, java.math.BigDecimal amount)"]},"submitForSettlement":{"description":"Submits the transaction with the given id to be settled along with a TransactionRequest object","signatures":["com.braintreegateway.Result submitForSettlement(String id)","com.braintreegateway.Result submitForSettlement(String id, com.braintreegateway.TransactionRequest request)","com.braintreegateway.Result submitForSettlement(String id, java.math.BigDecimal amount)"]},"updateCustomFields":{"description":"Updates custom field values for a given transaction","signatures":["com.braintreegateway.Result updateCustomFields(String id, com.braintreegateway.TransactionRequest request)"]},"updateDetails":{"description":"Updates details for a transaction that has been submitted for settlement","signatures":["com.braintreegateway.Result updateDetails(String id, com.braintreegateway.TransactionRequest request)"]},"voidTransaction":{"description":"Voids the transaction with the given id","signatures":["com.braintreegateway.Result voidTransaction(String id)"]}}},"usBankAccount":{"consumerOnly":false,"producerOnly":true,"description":"","methods":{"find":{"description":"","signatures":["com.braintreegateway.UsBankAccount find(String token)"]},"sale":{"description":"","signatures":["com.braintreegateway.Result sale(String token, com.braintreegateway.TransactionRequest transactionRequest)"]}}},"webhookNotification":{"consumerOnly":false,"producerOnly":true,"description":"To retrieve notifications via webhooks","methods":{"parse":{"description":"","signatures":["com.braintreegateway.WebhookNotification parse(String signature, String payload)"]},"parseWithoutSignatureVerification":{"description":"","signatures":["com.braintreegateway.WebhookNotification parseWithoutSignatureVerification(String payload)"]},"verify":{"description":"","signatures":["String verify(String challenge)"]}}}},"apiProperties":{"address":{"methods":{"create":{"properties":{"customerId":{"index":0,"kind":"parameter","displayName":"Customer Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Customer","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.AddressRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request object","optional":false}}},"delete":{"properties":{"customerId":{"index":0,"kind":"parameter","displayName":"Customer Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Customer","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Address to delete","optional":false}}},"find":{"properties":{"customerId":{"index":0,"kind":"parameter","displayName":"Customer Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Customer","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Address","optional":false}}},"update":{"properties":{"customerId":{"index":0,"kind":"parameter","displayName":"Customer Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Customer","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Address","optional":false},"request":{"index":2,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.AddressRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request object containing the AddressRequest parameters","optional":false}}}}},"clientToken":{"methods":{"generate":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.ClientTokenRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"creditCardVerification":{"methods":{"create":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.CreditCardVerificationRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"find":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"search":{"properties":{"query":{"index":0,"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.CreditCardVerificationSearchRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"customer":{"methods":{"create":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.CustomerRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}},"delete":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Customer","optional":false}}},"find":{"properties":{"associationFilterId":{"index":0,"kind":"parameter","displayName":"Association Filter Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the association filter to use","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Customer","optional":false}}},"search":{"properties":{"query":{"index":0,"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.CustomerSearchRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request query to use for search","optional":false}}},"update":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Customer","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.CustomerRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}}}},"dispute":{"methods":{"accept":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The dispute id to accept","optional":false}}},"addFileEvidence":{"properties":{"disputeId":{"index":0,"kind":"parameter","displayName":"Dispute Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The dispute id to add text evidence to","optional":false},"documentId":{"index":1,"kind":"parameter","displayName":"Document Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The document id of a previously uploaded document","optional":false},"fileEvidenceRequest":{"index":2,"kind":"parameter","displayName":"File Evidence Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.FileEvidenceRequest","deprecated":false,"autowired":false,"secret":false,"description":"The file evidence request for the dispute","optional":false}}},"addTextEvidence":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The content of the text evidence for the dispute","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The dispute id to add text evidence to","optional":false},"textEvidenceRequest":{"index":2,"kind":"parameter","displayName":"Text Evidence Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TextEvidenceRequest","deprecated":false,"autowired":false,"secret":false,"description":"The text evidence request for the dispute","optional":false}}},"finalize":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The dispute id to finalize","optional":false}}},"find":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The dispute id to find","optional":false}}},"removeEvidence":{"properties":{"disputeId":{"index":0,"kind":"parameter","displayName":"Dispute Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The dispute id to remove evidence from","optional":false},"evidenceId":{"index":1,"kind":"parameter","displayName":"Evidence Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The evidence id to remove","optional":false}}},"search":{"properties":{"query":{"index":0,"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.DisputeSearchRequest","deprecated":false,"autowired":false,"secret":false,"description":"The query for what disputes to find","optional":false}}}}},"documentUpload":{"methods":{"create":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.DocumentUploadRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"merchantAccount":{"methods":{"create":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.MerchantAccountRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createForCurrency":{"properties":{"currencyRequest":{"index":0,"kind":"parameter","displayName":"Currency Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.MerchantAccountCreateForCurrencyRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetchMerchantAccounts":{"properties":{"page":{"index":0,"kind":"parameter","displayName":"Page","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"find":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"update":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.MerchantAccountRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"oauth":{"methods":{"connectUrl":{"properties":{"connectRequest":{"index":0,"kind":"parameter","displayName":"Connect Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.OAuthConnectUrlRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTokenFromCode":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.OAuthCredentialsRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTokenFromRefreshToken":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.OAuthCredentialsRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"revokeAccessToken":{"properties":{"accessToken":{"index":0,"kind":"parameter","displayName":"Access Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"paymentMethod":{"methods":{"create":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PaymentMethodRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"delete":{"properties":{"deleteRequest":{"index":0,"kind":"parameter","displayName":"Delete Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PaymentMethodDeleteRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"token":{"index":1,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"find":{"properties":{"token":{"index":0,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"grant":{"properties":{"grantRequest":{"index":0,"kind":"parameter","displayName":"Grant Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PaymentMethodGrantRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"token":{"index":1,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"revoke":{"properties":{"token":{"index":0,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"update":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PaymentMethodRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"token":{"index":1,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"paymentMethodNonce":{"methods":{"create":{"properties":{"paymentMethodToken":{"index":0,"kind":"parameter","displayName":"Payment Method Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PaymentMethodNonceRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"find":{"properties":{"paymentMethodNonce":{"index":0,"kind":"parameter","displayName":"Payment Method Nonce","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"plan":{"methods":{"create":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PlanRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"find":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"update":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PlanRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"report":{"methods":{"transactionLevelFees":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionLevelFeeReportRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}}}},"settlementBatchSummary":{"methods":{"generate":{"properties":{"groupByCustomField":{"index":0,"kind":"parameter","displayName":"Group By Custom Field","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"settlementDate":{"index":2,"kind":"parameter","displayName":"Settlement Date","group":"producer","label":"","required":false,"type":"object","javaType":"java.util.Calendar","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"subscription":{"methods":{"cancel":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the Subscription to cancel","optional":false}}},"create":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.SubscriptionRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}},"delete":{"properties":{"customerId":{"index":0,"kind":"parameter","displayName":"Customer Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"find":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Subscription","optional":false}}},"retryCharge":{"properties":{"amount":{"index":0,"kind":"parameter","displayName":"Amount","group":"producer","label":"","required":false,"type":"object","javaType":"java.math.BigDecimal","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"submitForSettlement":{"index":1,"kind":"parameter","displayName":"Submit For Settlement","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"subscriptionId":{"index":2,"kind":"parameter","displayName":"Subscription Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"search":{"properties":{"searchRequest":{"index":0,"kind":"parameter","displayName":"Search Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.SubscriptionSearchRequest","deprecated":false,"autowired":false,"secret":false,"description":"The SubscriptionSearchRequest","optional":false}}},"update":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Subscription","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.SubscriptionRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}}}},"transaction":{"methods":{"adjustAuthorization":{"properties":{"amount":{"index":0,"kind":"parameter","displayName":"Amount","group":"producer","label":"","required":false,"type":"object","javaType":"java.math.BigDecimal","deprecated":false,"autowired":false,"secret":false,"description":"To be adjusted","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to to be adjusted","optional":false},"request":{"index":2,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"Is the TransactionRequest object with amount details","optional":false}}},"cancelRelease":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to cancel release from escrow of","optional":false}}},"cloneTransaction":{"properties":{"cloneRequest":{"index":0,"kind":"parameter","displayName":"Clone Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionCloneRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"credit":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}},"find":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Transaction","optional":false}}},"holdInEscrow":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to hold for escrow","optional":false}}},"packageTracking":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to supplement the package details for","optional":false},"packageTrackingRequest":{"index":1,"kind":"parameter","displayName":"Package Tracking Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PackageTrackingRequest","deprecated":false,"autowired":false,"secret":false,"description":"The package tracking request related to the transaction","optional":false}}},"refund":{"properties":{"amount":{"index":0,"kind":"parameter","displayName":"Amount","group":"producer","label":"","required":false,"type":"object","javaType":"java.math.BigDecimal","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"refundRequest":{"index":2,"kind":"parameter","displayName":"Refund Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRefundRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"releaseFromEscrow":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to submit for release","optional":false}}},"sale":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}},"search":{"properties":{"query":{"index":0,"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionSearchRequest","deprecated":false,"autowired":false,"secret":false,"description":"The search query","optional":false}}},"submitForPartialSettlement":{"properties":{"amount":{"index":0,"kind":"parameter","displayName":"Amount","group":"producer","label":"","required":false,"type":"object","javaType":"java.math.BigDecimal","deprecated":false,"autowired":false,"secret":false,"description":"Of the partial settlement","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to add the partial settlement transaction for","optional":false},"request":{"index":2,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}},"submitForSettlement":{"properties":{"amount":{"index":0,"kind":"parameter","displayName":"Amount","group":"producer","label":"","required":false,"type":"object","javaType":"java.math.BigDecimal","deprecated":false,"autowired":false,"secret":false,"description":"To settle. must be less than or equal to the authorization amount.","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to submit for settlement","optional":false},"request":{"index":2,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}},"updateCustomFields":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction being updated","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"A TransactionRequest object containing custom field info..","optional":false}}},"updateDetails":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to update the details for","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}},"voidTransaction":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to void","optional":false}}}}},"usBankAccount":{"methods":{"find":{"properties":{"token":{"index":0,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"sale":{"properties":{"token":{"index":0,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"transactionRequest":{"index":1,"kind":"parameter","displayName":"Transaction Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"webhookNotification":{"methods":{"parse":{"properties":{"payload":{"index":0,"kind":"parameter","displayName":"Payload","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"signature":{"index":1,"kind":"parameter","displayName":"Signature","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"parseWithoutSignatureVerification":{"properties":{"payload":{"index":0,"kind":"parameter","displayName":"Payload","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"verify":{"properties":{"challenge":{"index":0,"kind":"parameter","displayName":"Challenge","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}}}} +{"component":{"kind":"component","name":"braintree","title":"Braintree","description":"Process payments using Braintree Payments.","deprecated":false,"firstVersion":"2.17.0","label":"saas","javaType":"org.apache.camel.component.braintree.BraintreeComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-braintree","version":"4.8.2","scheme":"braintree","extendsScheme":"","syntax":"braintree:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.braintree.internal.BraintreeApiName","enum":["ADD_ON","ADDRESS","CLIENT_TOKEN","CREDIT_CARD_VERIFICATION","CUSTOMER","DISCOUNT","DISPUTE","DOCUMENT_UPLOAD","MERCHANT_ACCOUNT","PAYMENT_METHOD","PAYMENT_METHOD_NONCE","OAUTH","PLAN","REPORT","SETTLEMENT_BATCH_SUMMARY","SUBSCRIPTION","TRANSACTION","US_BANK_ACCOUNT","WEBHOOK_NOTIFICATION"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["accept","addFileEvidence","addTextEvidence","cancel","cancelRelease","cloneTransaction","create","createForCurrency","credit","delete","fetchMerchantAccounts","finalize","find","generate","grant","holdInEscrow","parse","refund","releaseFromEscrow","removeEvidence","retryCharge","revoke","sale","search","submitForPartialSettlement","submitForSettlement","transactionLevelFees","update","updateDetails","verify","voidTransaction"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"environment":{"index":2,"kind":"parameter","displayName":"Environment","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"The environment Either SANDBOX or PRODUCTION"},"inBody":{"index":3,"kind":"parameter","displayName":"In Body","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"merchantId":{"index":4,"kind":"parameter","displayName":"Merchant Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"The merchant id provided by Braintree."},"lazyStartProducer":{"index":5,"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."},"httpReadTimeout":{"index":6,"kind":"parameter","displayName":"Http Read Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"Set read timeout for http calls."},"httpLogLevel":{"index":7,"kind":"parameter","displayName":"Http Log Level","group":"logging","label":"logging","required":false,"type":"string","javaType":"java.lang.String","enum":["OFF","SEVERE","WARNING","INFO","CONFIG","FINE","FINER","FINEST","ALL"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"Set logging level for http calls, see java.util.logging.Level"},"httpLogName":{"index":8,"kind":"parameter","displayName":"Http Log Name","group":"logging","label":"logging","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Braintree","configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"Set log category to use to log http calls."},"logHandlerEnabled":{"index":9,"kind":"parameter","displayName":"Log Handler Enabled","group":"logging","label":"logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"Sets whether to enable the BraintreeLogHandler. It may be desirable to set this to 'false' where an existing JUL - SLF4J logger bridge is on the classpath. This option can also be configured globally on the BraintreeComponent."},"proxyHost":{"index":10,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"The proxy host"},"proxyPort":{"index":11,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"The proxy port"},"accessToken":{"index":12,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"The access token granted by a merchant to another in order to process transactions on their behalf. Used in place of environment, merchant id, public key and private key fields."},"privateKey":{"index":13,"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"The private key provided by Braintree."},"publicKey":{"index":14,"kind":"parameter","displayName":"Public Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.braintree.BraintreeConfiguration","configurationField":"configuration","description":"The public key provided by Braintree."}},"apis":{"address":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to create, delete, find, and update Address objects","methods":{"create":{"description":"Creates an Address for a Customer","signatures":["com.braintreegateway.Result create(String customerId, com.braintreegateway.AddressRequest request)"]},"delete":{"description":"Deletes a Customer's Address","signatures":["com.braintreegateway.Result delete(String customerId, String id)"]},"find":{"description":"Finds a Customer's Address","signatures":["com.braintreegateway.Address find(String customerId, String id)"]},"update":{"description":"Updates a Customer's Address","signatures":["com.braintreegateway.Result update(String customerId, String id, com.braintreegateway.AddressRequest request)"]}}},"clientToken":{"consumerOnly":false,"producerOnly":true,"description":"Generates client tokens, which are used to authenticate requests made directly on behalf of merchants This class does not need to be instantiated directly","methods":{"generate":{"description":"","signatures":["String generate()","String generate(com.braintreegateway.ClientTokenRequest request)"]}}},"creditCardVerification":{"consumerOnly":false,"producerOnly":true,"description":"To verify credit card information","methods":{"create":{"description":"","signatures":["com.braintreegateway.Result create(com.braintreegateway.CreditCardVerificationRequest request)"]},"find":{"description":"","signatures":["com.braintreegateway.CreditCardVerification find(String id)"]},"search":{"description":"","signatures":["com.braintreegateway.ResourceCollection search(com.braintreegateway.CreditCardVerificationSearchRequest query)"]}}},"customer":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to create, delete, find, and update Customer objects","methods":{"create":{"description":"Creates a Customer","signatures":["com.braintreegateway.Result create(com.braintreegateway.CustomerRequest request)"]},"delete":{"description":"Deletes a Customer by id","signatures":["com.braintreegateway.Result delete(String id)"]},"find":{"description":"Finds a Customer by id","signatures":["com.braintreegateway.Customer find(String id)","com.braintreegateway.Customer find(String id, String associationFilterId)"]},"search":{"description":"Finds all Transactions that match the query and returns a ResourceCollection","signatures":["com.braintreegateway.ResourceCollection search(com.braintreegateway.CustomerSearchRequest query)"]},"update":{"description":"Updates a Customer","signatures":["com.braintreegateway.Result update(String id, com.braintreegateway.CustomerRequest request)"]}}},"dispute":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to interact with Dispute objects","methods":{"accept":{"description":"Accept a Dispute, given a dispute ID","signatures":["com.braintreegateway.Result accept(String id)"]},"addFileEvidence":{"description":"Add File Evidence to a Dispute, given an ID and a FileEvidenceRequest File evidence request","signatures":["com.braintreegateway.Result addFileEvidence(String disputeId, String documentId)","com.braintreegateway.Result addFileEvidence(String disputeId, com.braintreegateway.FileEvidenceRequest fileEvidenceRequest)"]},"addTextEvidence":{"description":"Add Text Evidence to a Dispute, given an ID and content","signatures":["com.braintreegateway.Result addTextEvidence(String id, String content)","com.braintreegateway.Result addTextEvidence(String id, com.braintreegateway.TextEvidenceRequest textEvidenceRequest)"]},"finalize":{"description":"Finalize a Dispute, given an ID","signatures":["com.braintreegateway.Result finalize(String id)"]},"find":{"description":"Returns a Dispute, given an ID","signatures":["com.braintreegateway.Dispute find(String id)"]},"removeEvidence":{"description":"Remove Evidence from a Dispute, given an ID and a DisputeEvidence ID","signatures":["com.braintreegateway.Result removeEvidence(String disputeId, String evidenceId)"]},"search":{"description":"Finds all Disputes that match the query","signatures":["com.braintreegateway.PaginatedCollection search(com.braintreegateway.DisputeSearchRequest query)"]}}},"documentUpload":{"consumerOnly":false,"producerOnly":true,"description":"API to upload evidence documents","methods":{"create":{"description":"","signatures":["com.braintreegateway.Result create(com.braintreegateway.DocumentUploadRequest request)"]}}},"merchantAccount":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to create, find, and update MerchantAccount objects","methods":{"create":{"description":"","signatures":["com.braintreegateway.Result create(com.braintreegateway.MerchantAccountRequest request)"]},"createForCurrency":{"description":"","signatures":["com.braintreegateway.Result createForCurrency(com.braintreegateway.MerchantAccountCreateForCurrencyRequest request)"]},"fetchMerchantAccounts":{"description":"","signatures":["com.braintreegateway.PaginatedResult fetchMerchantAccounts(int page)"]},"find":{"description":"","signatures":["com.braintreegateway.MerchantAccount find(String id)"]},"update":{"description":"","signatures":["com.braintreegateway.Result update(String id, com.braintreegateway.MerchantAccountRequest request)"]}}},"oauth":{"consumerOnly":false,"producerOnly":true,"description":"","methods":{"connectUrl":{"description":"","signatures":["String connectUrl(com.braintreegateway.OAuthConnectUrlRequest request)"]},"createTokenFromCode":{"description":"","signatures":["com.braintreegateway.Result createTokenFromCode(com.braintreegateway.OAuthCredentialsRequest request)"]},"createTokenFromRefreshToken":{"description":"","signatures":["com.braintreegateway.Result createTokenFromRefreshToken(com.braintreegateway.OAuthCredentialsRequest request)"]},"revokeAccessToken":{"description":"","signatures":["com.braintreegateway.Result revokeAccessToken(String accessToken)"]}}},"paymentMethod":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to interact with payments","methods":{"create":{"description":"","signatures":["com.braintreegateway.Result create(com.braintreegateway.PaymentMethodRequest request)"]},"delete":{"description":"","signatures":["com.braintreegateway.Result delete(String token)","com.braintreegateway.Result delete(String token, com.braintreegateway.PaymentMethodDeleteRequest request)"]},"find":{"description":"","signatures":["com.braintreegateway.PaymentMethod find(String token)"]},"grant":{"description":"","signatures":["com.braintreegateway.Result grant(String token)","com.braintreegateway.Result grant(String token, com.braintreegateway.PaymentMethodGrantRequest grantRequest)"]},"revoke":{"description":"","signatures":["com.braintreegateway.Result revoke(String token)"]},"update":{"description":"","signatures":["com.braintreegateway.Result update(String token, com.braintreegateway.PaymentMethodRequest request)"]}}},"paymentMethodNonce":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to interact with nonce payments","methods":{"create":{"description":"","signatures":["com.braintreegateway.Result create(String paymentMethodToken)","com.braintreegateway.Result create(com.braintreegateway.PaymentMethodNonceRequest request)"]},"find":{"description":"","signatures":["com.braintreegateway.PaymentMethodNonce find(String paymentMethodNonce)"]}}},"plan":{"consumerOnly":false,"producerOnly":true,"description":"","methods":{"create":{"description":"","signatures":["com.braintreegateway.Result create(com.braintreegateway.PlanRequest request)"]},"find":{"description":"","signatures":["com.braintreegateway.Plan find(String id)"]},"update":{"description":"","signatures":["com.braintreegateway.Result update(String id, com.braintreegateway.PlanRequest request)"]}}},"report":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to interact with reports","methods":{"transactionLevelFees":{"description":"Retrieves a Transaction-Level Fee Report","signatures":["com.braintreegateway.Result transactionLevelFees(com.braintreegateway.TransactionLevelFeeReportRequest request)"]}}},"settlementBatchSummary":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to interact wit settlement summaries","methods":{"generate":{"description":"","signatures":["com.braintreegateway.Result generate(java.util.Calendar settlementDate)","com.braintreegateway.Result generate(java.util.Calendar settlementDate, String groupByCustomField)"]}}},"subscription":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to interact with Subscriptions","methods":{"cancel":{"description":"Cancels the Subscription with the given id","signatures":["com.braintreegateway.Result cancel(String id)"]},"create":{"description":"Creates a Subscription","signatures":["com.braintreegateway.Result create(com.braintreegateway.SubscriptionRequest request)"]},"delete":{"description":"","signatures":["com.braintreegateway.Result delete(String customerId, String id)"]},"find":{"description":"Finds a Subscription by id","signatures":["com.braintreegateway.Subscription find(String id)"]},"retryCharge":{"description":"","signatures":["com.braintreegateway.Result retryCharge(String subscriptionId)","com.braintreegateway.Result retryCharge(String subscriptionId, Boolean submitForSettlement)","com.braintreegateway.Result retryCharge(String subscriptionId, java.math.BigDecimal amount)","com.braintreegateway.Result retryCharge(String subscriptionId, java.math.BigDecimal amount, Boolean submitForSettlement)"]},"search":{"description":"Search for a Subscription","signatures":["com.braintreegateway.ResourceCollection search(com.braintreegateway.SubscriptionSearchRequest searchRequest)"]},"update":{"description":"Updates a Subscription","signatures":["com.braintreegateway.Result update(String id, com.braintreegateway.SubscriptionRequest request)"]}}},"transaction":{"consumerOnly":false,"producerOnly":true,"description":"Provides methods to interact with Transactions","methods":{"adjustAuthorization":{"description":"Submits the transaction with the given id to be adjusted for the given amount which must be less than or equal to the authorization amount","signatures":["com.braintreegateway.Result adjustAuthorization(String id, com.braintreegateway.TransactionRequest request)","com.braintreegateway.Result adjustAuthorization(String id, java.math.BigDecimal amount)"]},"cancelRelease":{"description":"Cancels a pending release of a transaction with the given id from escrow","signatures":["com.braintreegateway.Result cancelRelease(String id)"]},"cloneTransaction":{"description":"","signatures":["com.braintreegateway.Result cloneTransaction(String id, com.braintreegateway.TransactionCloneRequest request)"]},"credit":{"description":"Creates a credit Transaction","signatures":["com.braintreegateway.Result credit(com.braintreegateway.TransactionRequest request)"]},"find":{"description":"Finds a Transaction by id","signatures":["com.braintreegateway.Transaction find(String id)"]},"holdInEscrow":{"description":"Holds the transaction with the given id for escrow","signatures":["com.braintreegateway.Result holdInEscrow(String id)"]},"packageTracking":{"description":"Supplement the transaction with package tracking details","signatures":["com.braintreegateway.Result packageTracking(String id, com.braintreegateway.PackageTrackingRequest packageTrackingRequest)"]},"refund":{"description":"Refunds all or part of a previous sale Transaction","signatures":["com.braintreegateway.Result refund(String id)","com.braintreegateway.Result refund(String id, com.braintreegateway.TransactionRefundRequest request)","com.braintreegateway.Result refund(String id, java.math.BigDecimal amount)"]},"releaseFromEscrow":{"description":"Submits the transaction with the given id for release","signatures":["com.braintreegateway.Result releaseFromEscrow(String id)"]},"sale":{"description":"Creates a sale Transaction","signatures":["com.braintreegateway.Result sale(com.braintreegateway.TransactionRequest request)"]},"search":{"description":"Finds all Transactions that match the query and returns a ResourceCollection","signatures":["com.braintreegateway.ResourceCollection search(com.braintreegateway.TransactionSearchRequest query)"]},"submitForPartialSettlement":{"description":"Submits a partial settlement transaction for the given id","signatures":["com.braintreegateway.Result submitForPartialSettlement(String id, com.braintreegateway.TransactionRequest request)","com.braintreegateway.Result submitForPartialSettlement(String id, java.math.BigDecimal amount)"]},"submitForSettlement":{"description":"Submits the transaction with the given id to be settled along with a TransactionRequest object","signatures":["com.braintreegateway.Result submitForSettlement(String id)","com.braintreegateway.Result submitForSettlement(String id, com.braintreegateway.TransactionRequest request)","com.braintreegateway.Result submitForSettlement(String id, java.math.BigDecimal amount)"]},"updateCustomFields":{"description":"Updates custom field values for a given transaction","signatures":["com.braintreegateway.Result updateCustomFields(String id, com.braintreegateway.TransactionRequest request)"]},"updateDetails":{"description":"Updates details for a transaction that has been submitted for settlement","signatures":["com.braintreegateway.Result updateDetails(String id, com.braintreegateway.TransactionRequest request)"]},"voidTransaction":{"description":"Voids the transaction with the given id","signatures":["com.braintreegateway.Result voidTransaction(String id)"]}}},"usBankAccount":{"consumerOnly":false,"producerOnly":true,"description":"","methods":{"find":{"description":"","signatures":["com.braintreegateway.UsBankAccount find(String token)"]},"sale":{"description":"","signatures":["com.braintreegateway.Result sale(String token, com.braintreegateway.TransactionRequest transactionRequest)"]}}},"webhookNotification":{"consumerOnly":false,"producerOnly":true,"description":"To retrieve notifications via webhooks","methods":{"parse":{"description":"","signatures":["com.braintreegateway.WebhookNotification parse(String signature, String payload)"]},"parseWithoutSignatureVerification":{"description":"","signatures":["com.braintreegateway.WebhookNotification parseWithoutSignatureVerification(String payload)"]},"verify":{"description":"","signatures":["String verify(String challenge)"]}}}},"apiProperties":{"address":{"methods":{"create":{"properties":{"customerId":{"index":0,"kind":"parameter","displayName":"Customer Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Customer","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.AddressRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request object","optional":false}}},"delete":{"properties":{"customerId":{"index":0,"kind":"parameter","displayName":"Customer Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Customer","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Address to delete","optional":false}}},"find":{"properties":{"customerId":{"index":0,"kind":"parameter","displayName":"Customer Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Customer","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Address","optional":false}}},"update":{"properties":{"customerId":{"index":0,"kind":"parameter","displayName":"Customer Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Customer","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Address","optional":false},"request":{"index":2,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.AddressRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request object containing the AddressRequest parameters","optional":false}}}}},"clientToken":{"methods":{"generate":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.ClientTokenRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"creditCardVerification":{"methods":{"create":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.CreditCardVerificationRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"find":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"search":{"properties":{"query":{"index":0,"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.CreditCardVerificationSearchRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"customer":{"methods":{"create":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.CustomerRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}},"delete":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Customer","optional":false}}},"find":{"properties":{"associationFilterId":{"index":0,"kind":"parameter","displayName":"Association Filter Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the association filter to use","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Customer","optional":false}}},"search":{"properties":{"query":{"index":0,"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.CustomerSearchRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request query to use for search","optional":false}}},"update":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Customer","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.CustomerRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}}}},"dispute":{"methods":{"accept":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The dispute id to accept","optional":false}}},"addFileEvidence":{"properties":{"disputeId":{"index":0,"kind":"parameter","displayName":"Dispute Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The dispute id to add text evidence to","optional":false},"documentId":{"index":1,"kind":"parameter","displayName":"Document Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The document id of a previously uploaded document","optional":false},"fileEvidenceRequest":{"index":2,"kind":"parameter","displayName":"File Evidence Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.FileEvidenceRequest","deprecated":false,"autowired":false,"secret":false,"description":"The file evidence request for the dispute","optional":false}}},"addTextEvidence":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The content of the text evidence for the dispute","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The dispute id to add text evidence to","optional":false},"textEvidenceRequest":{"index":2,"kind":"parameter","displayName":"Text Evidence Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TextEvidenceRequest","deprecated":false,"autowired":false,"secret":false,"description":"The text evidence request for the dispute","optional":false}}},"finalize":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The dispute id to finalize","optional":false}}},"find":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The dispute id to find","optional":false}}},"removeEvidence":{"properties":{"disputeId":{"index":0,"kind":"parameter","displayName":"Dispute Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The dispute id to remove evidence from","optional":false},"evidenceId":{"index":1,"kind":"parameter","displayName":"Evidence Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The evidence id to remove","optional":false}}},"search":{"properties":{"query":{"index":0,"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.DisputeSearchRequest","deprecated":false,"autowired":false,"secret":false,"description":"The query for what disputes to find","optional":false}}}}},"documentUpload":{"methods":{"create":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.DocumentUploadRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"merchantAccount":{"methods":{"create":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.MerchantAccountRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createForCurrency":{"properties":{"currencyRequest":{"index":0,"kind":"parameter","displayName":"Currency Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.MerchantAccountCreateForCurrencyRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetchMerchantAccounts":{"properties":{"page":{"index":0,"kind":"parameter","displayName":"Page","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"find":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"update":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.MerchantAccountRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"oauth":{"methods":{"connectUrl":{"properties":{"connectRequest":{"index":0,"kind":"parameter","displayName":"Connect Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.OAuthConnectUrlRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTokenFromCode":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.OAuthCredentialsRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTokenFromRefreshToken":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.OAuthCredentialsRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"revokeAccessToken":{"properties":{"accessToken":{"index":0,"kind":"parameter","displayName":"Access Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"paymentMethod":{"methods":{"create":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PaymentMethodRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"delete":{"properties":{"deleteRequest":{"index":0,"kind":"parameter","displayName":"Delete Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PaymentMethodDeleteRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"token":{"index":1,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"find":{"properties":{"token":{"index":0,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"grant":{"properties":{"grantRequest":{"index":0,"kind":"parameter","displayName":"Grant Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PaymentMethodGrantRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"token":{"index":1,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"revoke":{"properties":{"token":{"index":0,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"update":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PaymentMethodRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"token":{"index":1,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"paymentMethodNonce":{"methods":{"create":{"properties":{"paymentMethodToken":{"index":0,"kind":"parameter","displayName":"Payment Method Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PaymentMethodNonceRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"find":{"properties":{"paymentMethodNonce":{"index":0,"kind":"parameter","displayName":"Payment Method Nonce","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"plan":{"methods":{"create":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PlanRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"find":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"update":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PlanRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"report":{"methods":{"transactionLevelFees":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionLevelFeeReportRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}}}},"settlementBatchSummary":{"methods":{"generate":{"properties":{"groupByCustomField":{"index":0,"kind":"parameter","displayName":"Group By Custom Field","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"settlementDate":{"index":2,"kind":"parameter","displayName":"Settlement Date","group":"producer","label":"","required":false,"type":"object","javaType":"java.util.Calendar","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"subscription":{"methods":{"cancel":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the Subscription to cancel","optional":false}}},"create":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.SubscriptionRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}},"delete":{"properties":{"customerId":{"index":0,"kind":"parameter","displayName":"Customer Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"find":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Subscription","optional":false}}},"retryCharge":{"properties":{"amount":{"index":0,"kind":"parameter","displayName":"Amount","group":"producer","label":"","required":false,"type":"object","javaType":"java.math.BigDecimal","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"submitForSettlement":{"index":1,"kind":"parameter","displayName":"Submit For Settlement","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"subscriptionId":{"index":2,"kind":"parameter","displayName":"Subscription Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"search":{"properties":{"searchRequest":{"index":0,"kind":"parameter","displayName":"Search Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.SubscriptionSearchRequest","deprecated":false,"autowired":false,"secret":false,"description":"The SubscriptionSearchRequest","optional":false}}},"update":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Subscription","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.SubscriptionRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}}}},"transaction":{"methods":{"adjustAuthorization":{"properties":{"amount":{"index":0,"kind":"parameter","displayName":"Amount","group":"producer","label":"","required":false,"type":"object","javaType":"java.math.BigDecimal","deprecated":false,"autowired":false,"secret":false,"description":"To be adjusted","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to to be adjusted","optional":false},"request":{"index":2,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"Is the TransactionRequest object with amount details","optional":false}}},"cancelRelease":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to cancel release from escrow of","optional":false}}},"cloneTransaction":{"properties":{"cloneRequest":{"index":0,"kind":"parameter","displayName":"Clone Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionCloneRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"credit":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}},"find":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the Transaction","optional":false}}},"holdInEscrow":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to hold for escrow","optional":false}}},"packageTracking":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to supplement the package details for","optional":false},"packageTrackingRequest":{"index":1,"kind":"parameter","displayName":"Package Tracking Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.PackageTrackingRequest","deprecated":false,"autowired":false,"secret":false,"description":"The package tracking request related to the transaction","optional":false}}},"refund":{"properties":{"amount":{"index":0,"kind":"parameter","displayName":"Amount","group":"producer","label":"","required":false,"type":"object","javaType":"java.math.BigDecimal","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"refundRequest":{"index":2,"kind":"parameter","displayName":"Refund Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRefundRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"releaseFromEscrow":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to submit for release","optional":false}}},"sale":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}},"search":{"properties":{"query":{"index":0,"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionSearchRequest","deprecated":false,"autowired":false,"secret":false,"description":"The search query","optional":false}}},"submitForPartialSettlement":{"properties":{"amount":{"index":0,"kind":"parameter","displayName":"Amount","group":"producer","label":"","required":false,"type":"object","javaType":"java.math.BigDecimal","deprecated":false,"autowired":false,"secret":false,"description":"Of the partial settlement","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to add the partial settlement transaction for","optional":false},"request":{"index":2,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}},"submitForSettlement":{"properties":{"amount":{"index":0,"kind":"parameter","displayName":"Amount","group":"producer","label":"","required":false,"type":"object","javaType":"java.math.BigDecimal","deprecated":false,"autowired":false,"secret":false,"description":"To settle. must be less than or equal to the authorization amount.","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to submit for settlement","optional":false},"request":{"index":2,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}},"updateCustomFields":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction being updated","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"A TransactionRequest object containing custom field info..","optional":false}}},"updateDetails":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to update the details for","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"The request","optional":false}}},"voidTransaction":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Of the transaction to void","optional":false}}}}},"usBankAccount":{"methods":{"find":{"properties":{"token":{"index":0,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"sale":{"properties":{"token":{"index":0,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"transactionRequest":{"index":1,"kind":"parameter","displayName":"Transaction Request","group":"producer","label":"","required":false,"type":"object","javaType":"com.braintreegateway.TransactionRequest","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"webhookNotification":{"methods":{"parse":{"properties":{"payload":{"index":0,"kind":"parameter","displayName":"Payload","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"signature":{"index":1,"kind":"parameter","displayName":"Signature","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"parseWithoutSignatureVerification":{"properties":{"payload":{"index":0,"kind":"parameter","displayName":"Payload","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"verify":{"properties":{"challenge":{"index":0,"kind":"parameter","displayName":"Challenge","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}}}} , -{"component":{"kind":"component","name":"browse","title":"Browse","description":"Inspect the messages received on endpoints supporting BrowsableEndpoint.","deprecated":false,"firstVersion":"1.3.0","label":"core,monitoring","javaType":"org.apache.camel.component.browse.BrowseComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-browse","version":"4.8.1","scheme":"browse","extendsScheme":"","syntax":"browse:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A name which can be any string to uniquely identify the endpoint"},"bridgeErrorHandler":{"index":1,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":2,"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":{"index":3,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":4,"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."}}} +{"component":{"kind":"component","name":"browse","title":"Browse","description":"Inspect the messages received on endpoints supporting BrowsableEndpoint.","deprecated":false,"firstVersion":"1.3.0","label":"core,monitoring","javaType":"org.apache.camel.component.browse.BrowseComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-browse","version":"4.8.2","scheme":"browse","extendsScheme":"","syntax":"browse:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A name which can be any string to uniquely identify the endpoint"},"bridgeErrorHandler":{"index":1,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":2,"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":{"index":3,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":4,"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."}}} , -{"component":{"kind":"component","name":"caffeine-cache","title":"Caffeine Cache","description":"Perform caching operations using Caffeine Cache.","deprecated":false,"firstVersion":"2.20.0","label":"cache,clustering","javaType":"org.apache.camel.component.caffeine.cache.CaffeineCacheComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-caffeine","version":"4.8.1","scheme":"caffeine-cache","extendsScheme":"","syntax":"caffeine-cache:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelCaffeineAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to execute. Possible values: CLEANUP PUT PUT_ALL GET GET_ALL INVALIDATE INVALIDATE_ALL AS_MAP","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION"},"CamelCaffeineActionHasResult":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag indicating whether the action has a result or not.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION_HAS_RESULT"},"CamelCaffeineActionSucceeded":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag indicating whether the action was successful or not.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION_SUCCEEDED"},"CamelCaffeineKey":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key for all actions on a single entry.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#KEY"},"CamelCaffeineKeys":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The keys to get (GET_ALL), to invalidate (INVALIDATE_ALL) or existing (AS_MAP) according to the action.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#KEYS"},"CamelCaffeineValue":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of key for all put actions (PUT or PUT_ALL).","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#VALUE"},"CamelCaffeineOldValue":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value returned according to the action.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#OLD_VALUE"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cache name"},"action":{"index":1,"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["GET","GET_ALL","PUT","PUT_ALL","INVALIDATE","INVALIDATE_ALL","CLEANUP","AS_MAP"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence."},"createCacheIfNotExist":{"index":2,"kind":"parameter","displayName":"Create Cache If Not Exist","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Automatic create the Caffeine cache if none has been configured or exists in the registry."},"evictionType":{"index":3,"kind":"parameter","displayName":"Eviction Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.caffeine.EvictionType","enum":["size_based","time_based"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SIZE_BASED","configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set the eviction Type for this cache"},"expireAfterAccessTime":{"index":4,"kind":"parameter","displayName":"Expire After Access Time","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":300,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last read. Access time is reset by all cache read and write operations. The unit is in seconds."},"expireAfterWriteTime":{"index":5,"kind":"parameter","displayName":"Expire After Write Time","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":300,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value. The unit is in seconds."},"initialCapacity":{"index":6,"kind":"parameter","displayName":"Initial Capacity","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Sets the minimum total size for the internal data structures. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory."},"key":{"index":7,"kind":"parameter","displayName":"Key","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure the default action key. If a key is set in the message header, then the key from the header takes precedence."},"maximumSize":{"index":8,"kind":"parameter","displayName":"Maximum Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Specifies the maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn't been used recently or very often. When size is zero, elements will be evicted immediately after being loaded into the cache. This can be useful in testing or to disable caching temporarily without a code change. As eviction is scheduled on the configured executor, tests may instead prefer to configure the cache to execute tasks directly on the same thread."},"lazyStartProducer":{"index":9,"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."},"cacheLoader":{"index":10,"kind":"parameter","displayName":"Cache Loader","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.CacheLoader","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure a CacheLoader in case of a LoadCache use"},"removalListener":{"index":11,"kind":"parameter","displayName":"Removal Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.RemovalListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set a specific removal Listener for the cache"},"statsCounter":{"index":12,"kind":"parameter","displayName":"Stats Counter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.stats.StatsCounter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set a specific Stats Counter for the cache stats"},"statsEnabled":{"index":13,"kind":"parameter","displayName":"Stats Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To enable stats on the cache"},"valueType":{"index":14,"kind":"parameter","displayName":"Value Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"The cache value type, default java.lang.Object"}}} +{"component":{"kind":"component","name":"caffeine-cache","title":"Caffeine Cache","description":"Perform caching operations using Caffeine Cache.","deprecated":false,"firstVersion":"2.20.0","label":"cache,clustering","javaType":"org.apache.camel.component.caffeine.cache.CaffeineCacheComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-caffeine","version":"4.8.2","scheme":"caffeine-cache","extendsScheme":"","syntax":"caffeine-cache:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelCaffeineAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to execute. Possible values: CLEANUP PUT PUT_ALL GET GET_ALL INVALIDATE INVALIDATE_ALL AS_MAP","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION"},"CamelCaffeineActionHasResult":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag indicating whether the action has a result or not.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION_HAS_RESULT"},"CamelCaffeineActionSucceeded":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag indicating whether the action was successful or not.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION_SUCCEEDED"},"CamelCaffeineKey":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key for all actions on a single entry.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#KEY"},"CamelCaffeineKeys":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The keys to get (GET_ALL), to invalidate (INVALIDATE_ALL) or existing (AS_MAP) according to the action.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#KEYS"},"CamelCaffeineValue":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of key for all put actions (PUT or PUT_ALL).","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#VALUE"},"CamelCaffeineOldValue":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value returned according to the action.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#OLD_VALUE"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cache name"},"action":{"index":1,"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["GET","GET_ALL","PUT","PUT_ALL","INVALIDATE","INVALIDATE_ALL","CLEANUP","AS_MAP"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence."},"createCacheIfNotExist":{"index":2,"kind":"parameter","displayName":"Create Cache If Not Exist","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Automatic create the Caffeine cache if none has been configured or exists in the registry."},"evictionType":{"index":3,"kind":"parameter","displayName":"Eviction Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.caffeine.EvictionType","enum":["size_based","time_based"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SIZE_BASED","configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set the eviction Type for this cache"},"expireAfterAccessTime":{"index":4,"kind":"parameter","displayName":"Expire After Access Time","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":300,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last read. Access time is reset by all cache read and write operations. The unit is in seconds."},"expireAfterWriteTime":{"index":5,"kind":"parameter","displayName":"Expire After Write Time","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":300,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value. The unit is in seconds."},"initialCapacity":{"index":6,"kind":"parameter","displayName":"Initial Capacity","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Sets the minimum total size for the internal data structures. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory."},"key":{"index":7,"kind":"parameter","displayName":"Key","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure the default action key. If a key is set in the message header, then the key from the header takes precedence."},"maximumSize":{"index":8,"kind":"parameter","displayName":"Maximum Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Specifies the maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn't been used recently or very often. When size is zero, elements will be evicted immediately after being loaded into the cache. This can be useful in testing or to disable caching temporarily without a code change. As eviction is scheduled on the configured executor, tests may instead prefer to configure the cache to execute tasks directly on the same thread."},"lazyStartProducer":{"index":9,"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."},"cacheLoader":{"index":10,"kind":"parameter","displayName":"Cache Loader","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.CacheLoader","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure a CacheLoader in case of a LoadCache use"},"removalListener":{"index":11,"kind":"parameter","displayName":"Removal Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.RemovalListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set a specific removal Listener for the cache"},"statsCounter":{"index":12,"kind":"parameter","displayName":"Stats Counter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.stats.StatsCounter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set a specific Stats Counter for the cache stats"},"statsEnabled":{"index":13,"kind":"parameter","displayName":"Stats Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To enable stats on the cache"},"valueType":{"index":14,"kind":"parameter","displayName":"Value Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"The cache value type, default java.lang.Object"}}} , -{"component":{"kind":"component","name":"caffeine-loadcache","title":"Caffeine LoadCache","description":"Perform caching operations using Caffeine Cache with an attached CacheLoader.","deprecated":false,"firstVersion":"2.20.0","label":"cache,clustering","javaType":"org.apache.camel.component.caffeine.load.CaffeineLoadCacheComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-caffeine","version":"4.8.1","scheme":"caffeine-loadcache","extendsScheme":"","syntax":"caffeine-loadcache:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelCaffeineAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to execute. Possible values: CLEANUP PUT PUT_ALL GET GET_ALL INVALIDATE INVALIDATE_ALL AS_MAP","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION"},"CamelCaffeineActionHasResult":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag indicating whether the action has a result or not.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION_HAS_RESULT"},"CamelCaffeineActionSucceeded":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag indicating whether the action was successful or not.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION_SUCCEEDED"},"CamelCaffeineKey":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key for all actions on a single entry.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#KEY"},"CamelCaffeineKeys":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The keys to get (GET_ALL), to invalidate (INVALIDATE_ALL) or existing (AS_MAP) according to the action.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#KEYS"},"CamelCaffeineValue":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of key for all put actions (PUT or PUT_ALL).","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#VALUE"},"CamelCaffeineOldValue":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value returned according to the action.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#OLD_VALUE"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the cache name"},"action":{"index":1,"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["GET","GET_ALL","PUT","PUT_ALL","INVALIDATE","INVALIDATE_ALL","CLEANUP","AS_MAP"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence."},"createCacheIfNotExist":{"index":2,"kind":"parameter","displayName":"Create Cache If Not Exist","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Automatic create the Caffeine cache if none has been configured or exists in the registry."},"evictionType":{"index":3,"kind":"parameter","displayName":"Eviction Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.caffeine.EvictionType","enum":["size_based","time_based"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SIZE_BASED","configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set the eviction Type for this cache"},"expireAfterAccessTime":{"index":4,"kind":"parameter","displayName":"Expire After Access Time","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":300,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last read. Access time is reset by all cache read and write operations. The unit is in seconds."},"expireAfterWriteTime":{"index":5,"kind":"parameter","displayName":"Expire After Write Time","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":300,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value. The unit is in seconds."},"initialCapacity":{"index":6,"kind":"parameter","displayName":"Initial Capacity","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Sets the minimum total size for the internal data structures. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory."},"key":{"index":7,"kind":"parameter","displayName":"Key","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure the default action key. If a key is set in the message header, then the key from the header takes precedence."},"maximumSize":{"index":8,"kind":"parameter","displayName":"Maximum Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Specifies the maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn't been used recently or very often. When size is zero, elements will be evicted immediately after being loaded into the cache. This can be useful in testing or to disable caching temporarily without a code change. As eviction is scheduled on the configured executor, tests may instead prefer to configure the cache to execute tasks directly on the same thread."},"lazyStartProducer":{"index":9,"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."},"cacheLoader":{"index":10,"kind":"parameter","displayName":"Cache Loader","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.CacheLoader","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure a CacheLoader in case of a LoadCache use"},"removalListener":{"index":11,"kind":"parameter","displayName":"Removal Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.RemovalListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set a specific removal Listener for the cache"},"statsCounter":{"index":12,"kind":"parameter","displayName":"Stats Counter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.stats.StatsCounter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set a specific Stats Counter for the cache stats"},"statsEnabled":{"index":13,"kind":"parameter","displayName":"Stats Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To enable stats on the cache"},"valueType":{"index":14,"kind":"parameter","displayName":"Value Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"The cache value type, default java.lang.Object"}}} +{"component":{"kind":"component","name":"caffeine-loadcache","title":"Caffeine LoadCache","description":"Perform caching operations using Caffeine Cache with an attached CacheLoader.","deprecated":false,"firstVersion":"2.20.0","label":"cache,clustering","javaType":"org.apache.camel.component.caffeine.load.CaffeineLoadCacheComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-caffeine","version":"4.8.2","scheme":"caffeine-loadcache","extendsScheme":"","syntax":"caffeine-loadcache:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelCaffeineAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to execute. Possible values: CLEANUP PUT PUT_ALL GET GET_ALL INVALIDATE INVALIDATE_ALL AS_MAP","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION"},"CamelCaffeineActionHasResult":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag indicating whether the action has a result or not.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION_HAS_RESULT"},"CamelCaffeineActionSucceeded":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag indicating whether the action was successful or not.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION_SUCCEEDED"},"CamelCaffeineKey":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key for all actions on a single entry.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#KEY"},"CamelCaffeineKeys":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The keys to get (GET_ALL), to invalidate (INVALIDATE_ALL) or existing (AS_MAP) according to the action.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#KEYS"},"CamelCaffeineValue":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of key for all put actions (PUT or PUT_ALL).","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#VALUE"},"CamelCaffeineOldValue":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value returned according to the action.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#OLD_VALUE"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the cache name"},"action":{"index":1,"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["GET","GET_ALL","PUT","PUT_ALL","INVALIDATE","INVALIDATE_ALL","CLEANUP","AS_MAP"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence."},"createCacheIfNotExist":{"index":2,"kind":"parameter","displayName":"Create Cache If Not Exist","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Automatic create the Caffeine cache if none has been configured or exists in the registry."},"evictionType":{"index":3,"kind":"parameter","displayName":"Eviction Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.caffeine.EvictionType","enum":["size_based","time_based"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SIZE_BASED","configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set the eviction Type for this cache"},"expireAfterAccessTime":{"index":4,"kind":"parameter","displayName":"Expire After Access Time","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":300,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last read. Access time is reset by all cache read and write operations. The unit is in seconds."},"expireAfterWriteTime":{"index":5,"kind":"parameter","displayName":"Expire After Write Time","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":300,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value. The unit is in seconds."},"initialCapacity":{"index":6,"kind":"parameter","displayName":"Initial Capacity","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Sets the minimum total size for the internal data structures. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory."},"key":{"index":7,"kind":"parameter","displayName":"Key","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure the default action key. If a key is set in the message header, then the key from the header takes precedence."},"maximumSize":{"index":8,"kind":"parameter","displayName":"Maximum Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Specifies the maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn't been used recently or very often. When size is zero, elements will be evicted immediately after being loaded into the cache. This can be useful in testing or to disable caching temporarily without a code change. As eviction is scheduled on the configured executor, tests may instead prefer to configure the cache to execute tasks directly on the same thread."},"lazyStartProducer":{"index":9,"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."},"cacheLoader":{"index":10,"kind":"parameter","displayName":"Cache Loader","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.CacheLoader","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure a CacheLoader in case of a LoadCache use"},"removalListener":{"index":11,"kind":"parameter","displayName":"Removal Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.RemovalListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set a specific removal Listener for the cache"},"statsCounter":{"index":12,"kind":"parameter","displayName":"Stats Counter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.stats.StatsCounter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set a specific Stats Counter for the cache stats"},"statsEnabled":{"index":13,"kind":"parameter","displayName":"Stats Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To enable stats on the cache"},"valueType":{"index":14,"kind":"parameter","displayName":"Value Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"The cache value type, default java.lang.Object"}}} , -{"component":{"kind":"component","name":"chatscript","title":"ChatScript","description":"Chat with a ChatScript Server.","deprecated":false,"firstVersion":"3.0.0","label":"ai,chat","javaType":"org.apache.camel.component.chatscript.ChatScriptComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-chatscript","version":"4.8.1","scheme":"chatscript","extendsScheme":"","syntax":"chatscript:host:port/botName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname or IP of the server on which CS server is running"},"port":{"index":1,"kind":"path","displayName":"Port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"description":"Port on which ChatScript is listening to"},"botName":{"index":2,"kind":"path","displayName":"Bot Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the Bot in CS to converse with"},"chatUserName":{"index":3,"kind":"parameter","displayName":"Chat User Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Username who initializes the CS conversation. To be set when chat is initialized from camel route"},"resetChat":{"index":4,"kind":"parameter","displayName":"Reset Chat","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Issues :reset command to start a new conversation everytime"},"lazyStartProducer":{"index":5,"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."}}} +{"component":{"kind":"component","name":"chatscript","title":"ChatScript","description":"Chat with a ChatScript Server.","deprecated":false,"firstVersion":"3.0.0","label":"ai,chat","javaType":"org.apache.camel.component.chatscript.ChatScriptComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-chatscript","version":"4.8.2","scheme":"chatscript","extendsScheme":"","syntax":"chatscript:host:port/botName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname or IP of the server on which CS server is running"},"port":{"index":1,"kind":"path","displayName":"Port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"description":"Port on which ChatScript is listening to"},"botName":{"index":2,"kind":"path","displayName":"Bot Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the Bot in CS to converse with"},"chatUserName":{"index":3,"kind":"parameter","displayName":"Chat User Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Username who initializes the CS conversation. To be set when chat is initialized from camel route"},"resetChat":{"index":4,"kind":"parameter","displayName":"Reset Chat","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Issues :reset command to start a new conversation everytime"},"lazyStartProducer":{"index":5,"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."}}} , -{"component":{"kind":"component","name":"chunk","title":"Chunk","description":"Transform messages using Chunk templating engine.","deprecated":false,"firstVersion":"2.15.0","label":"transformation","javaType":"org.apache.camel.component.chunk.ChunkComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-chunk","version":"4.8.1","scheme":"chunk","extendsScheme":"","syntax":"chunk:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"ChunkResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to use instead of the endpoint configured.","constantName":"org.apache.camel.component.chunk.ChunkConstants#CHUNK_RESOURCE_URI"},"ChunkTemplate":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.chunk.ChunkConstants#CHUNK_TEMPLATE"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"encoding":{"index":4,"kind":"parameter","displayName":"Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define the encoding of the body"},"extension":{"index":5,"kind":"parameter","displayName":"Extension","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define the file extension of the template"},"themeFolder":{"index":6,"kind":"parameter","displayName":"Theme Folder","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define the themes folder to scan"},"themeLayer":{"index":7,"kind":"parameter","displayName":"Theme Layer","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define the theme layer to elaborate"},"themeSubfolder":{"index":8,"kind":"parameter","displayName":"Theme Subfolder","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define the themes subfolder to scan"},"lazyStartProducer":{"index":9,"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."}}} +{"component":{"kind":"component","name":"chunk","title":"Chunk","description":"Transform messages using Chunk templating engine.","deprecated":false,"firstVersion":"2.15.0","label":"transformation","javaType":"org.apache.camel.component.chunk.ChunkComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-chunk","version":"4.8.2","scheme":"chunk","extendsScheme":"","syntax":"chunk:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"ChunkResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to use instead of the endpoint configured.","constantName":"org.apache.camel.component.chunk.ChunkConstants#CHUNK_RESOURCE_URI"},"ChunkTemplate":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.chunk.ChunkConstants#CHUNK_TEMPLATE"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"encoding":{"index":4,"kind":"parameter","displayName":"Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define the encoding of the body"},"extension":{"index":5,"kind":"parameter","displayName":"Extension","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define the file extension of the template"},"themeFolder":{"index":6,"kind":"parameter","displayName":"Theme Folder","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define the themes folder to scan"},"themeLayer":{"index":7,"kind":"parameter","displayName":"Theme Layer","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define the theme layer to elaborate"},"themeSubfolder":{"index":8,"kind":"parameter","displayName":"Theme Subfolder","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define the themes subfolder to scan"},"lazyStartProducer":{"index":9,"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."}}} , -{"component":{"kind":"component","name":"class","title":"Class","description":"Invoke methods of Java beans specified by class name.","deprecated":false,"firstVersion":"2.4.0","label":"core,script","javaType":"org.apache.camel.component.beanclass.ClassComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-bean","version":"4.8.1","scheme":"class","extendsScheme":"","syntax":"class:beanName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelBeanMethodName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the method to invoke.","constantName":"org.apache.camel.component.bean.BeanConstants#BEAN_METHOD_NAME"}},"properties":{"beanName":{"index":0,"kind":"path","displayName":"Bean Name","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the name of the bean to invoke"},"method":{"index":1,"kind":"parameter","displayName":"Method","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of the method to invoke on the bean"},"scope":{"index":2,"kind":"parameter","displayName":"Scope","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.BeanScope","enum":["Singleton","Request","Prototype"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Singleton","description":"Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple times while processing the request. The bean does not have to be thread-safe as the instance is only called from the same request. When using prototype scope, then the bean will be looked up or created per call. However in case of lookup then this is delegated to the bean registry such as Spring or CDI (if in use), which depends on their configuration can act as either singleton or prototype scope. so when using prototype then this depends on the delegated registry."},"lazyStartProducer":{"index":3,"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."},"parameters":{"index":4,"kind":"parameter","displayName":"Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"bean.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Used for configuring additional properties on the bean"}}} +{"component":{"kind":"component","name":"class","title":"Class","description":"Invoke methods of Java beans specified by class name.","deprecated":false,"firstVersion":"2.4.0","label":"core,script","javaType":"org.apache.camel.component.beanclass.ClassComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-bean","version":"4.8.2","scheme":"class","extendsScheme":"","syntax":"class:beanName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelBeanMethodName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the method to invoke.","constantName":"org.apache.camel.component.bean.BeanConstants#BEAN_METHOD_NAME"}},"properties":{"beanName":{"index":0,"kind":"path","displayName":"Bean Name","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the name of the bean to invoke"},"method":{"index":1,"kind":"parameter","displayName":"Method","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of the method to invoke on the bean"},"scope":{"index":2,"kind":"parameter","displayName":"Scope","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.BeanScope","enum":["Singleton","Request","Prototype"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Singleton","description":"Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple times while processing the request. The bean does not have to be thread-safe as the instance is only called from the same request. When using prototype scope, then the bean will be looked up or created per call. However in case of lookup then this is delegated to the bean registry such as Spring or CDI (if in use), which depends on their configuration can act as either singleton or prototype scope. so when using prototype then this depends on the delegated registry."},"lazyStartProducer":{"index":3,"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."},"parameters":{"index":4,"kind":"parameter","displayName":"Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"bean.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Used for configuring additional properties on the bean"}}} , -{"component":{"kind":"component","name":"cm-sms","title":"CM SMS Gateway","description":"Send SMS messages via CM SMS Gateway.","deprecated":false,"firstVersion":"2.18.0","label":"mobile","javaType":"org.apache.camel.component.cm.CMComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-cm-sms","version":"4.8.1","scheme":"cm-sms","extendsScheme":"","syntax":"cm-sms:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"SMS Provider HOST with scheme"},"defaultFrom":{"index":1,"kind":"parameter","displayName":"Default From","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.cm.CMConfiguration","configurationField":"configuration","description":"This is the sender name. The maximum length is 11 characters."},"defaultMaxNumberOfParts":{"index":2,"kind":"parameter","displayName":"Default Max Number Of Parts","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8,"configurationClass":"org.apache.camel.component.cm.CMConfiguration","configurationField":"configuration","description":"If it is a multipart message forces the max number. Message can be truncated. Technically the gateway will first check if a message is larger than 160 characters, if so, the message will be cut into multiple 153 characters parts limited by these parameters."},"productToken":{"index":3,"kind":"parameter","displayName":"Product Token","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.cm.CMConfiguration","configurationField":"configuration","description":"The unique token to use"},"testConnectionOnStartup":{"index":4,"kind":"parameter","displayName":"Test Connection On Startup","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.cm.CMConfiguration","configurationField":"configuration","description":"Whether to test the connection to the SMS Gateway on startup"},"lazyStartProducer":{"index":5,"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."}}} +{"component":{"kind":"component","name":"cm-sms","title":"CM SMS Gateway","description":"Send SMS messages via CM SMS Gateway.","deprecated":false,"firstVersion":"2.18.0","label":"mobile","javaType":"org.apache.camel.component.cm.CMComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-cm-sms","version":"4.8.2","scheme":"cm-sms","extendsScheme":"","syntax":"cm-sms:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"SMS Provider HOST with scheme"},"defaultFrom":{"index":1,"kind":"parameter","displayName":"Default From","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.cm.CMConfiguration","configurationField":"configuration","description":"This is the sender name. The maximum length is 11 characters."},"defaultMaxNumberOfParts":{"index":2,"kind":"parameter","displayName":"Default Max Number Of Parts","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8,"configurationClass":"org.apache.camel.component.cm.CMConfiguration","configurationField":"configuration","description":"If it is a multipart message forces the max number. Message can be truncated. Technically the gateway will first check if a message is larger than 160 characters, if so, the message will be cut into multiple 153 characters parts limited by these parameters."},"productToken":{"index":3,"kind":"parameter","displayName":"Product Token","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.cm.CMConfiguration","configurationField":"configuration","description":"The unique token to use"},"testConnectionOnStartup":{"index":4,"kind":"parameter","displayName":"Test Connection On Startup","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.cm.CMConfiguration","configurationField":"configuration","description":"Whether to test the connection to the SMS Gateway on startup"},"lazyStartProducer":{"index":5,"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."}}} , -{"component":{"kind":"component","name":"coap","title":"CoAP","description":"Send and receive messages to/from CoAP (Constrained Application Protocol) capable devices.","deprecated":false,"firstVersion":"2.16.0","label":"iot","javaType":"org.apache.camel.coap.CoAPComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-coap","version":"4.8.1","scheme":"coap","extendsScheme":"","alternativeSchemes":"coap,coaps,coap+tcp,coaps+tcp","syntax":"coap:uri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelCoapETag":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP ETag for the response.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_ETAG"},"CamelCoapMaxAge":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.lang.Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP Max-Age for the response body.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_MAX_AGE"},"CamelCoapMethod":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request method that the CoAP producer should use when calling the target CoAP server URI. Valid options are DELETE, GET, PING, POST & PUT.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_METHOD"},"CamelCoapResponseCode":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP response code sent by the external server. See RFC 7252 for details of what each code means.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_RESPONSE_CODE"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.coap.CoAPConstants#CONTENT_TYPE"}},"properties":{"uri":{"index":0,"kind":"path","displayName":"Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"description":"The URI for the CoAP endpoint"},"coapMethodRestrict":{"index":1,"kind":"parameter","displayName":"Coap Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["DELETE","GET","POST","PUT"],"deprecated":false,"autowired":false,"secret":false,"description":"Comma separated list of methods that the CoAP consumer will bind to. The default is to bind to all methods (DELETE, GET, POST, PUT)."},"observable":{"index":2,"kind":"parameter","displayName":"Observable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Make CoAP resource observable for source endpoint, based on RFC 7641."},"observe":{"index":3,"kind":"parameter","displayName":"Observe","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Send an observe request from a source endpoint, based on RFC 7641."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"notify":{"index":7,"kind":"parameter","displayName":"Notify","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Notify observers that the resource of this URI has changed, based on RFC 7641. Use this flag on a destination endpoint, with a URI that matches an existing source endpoint URI."},"lazyStartProducer":{"index":8,"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."},"advancedCertificateVerifier":{"index":9,"kind":"parameter","displayName":"Advanced Certificate Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.x509.NewAdvancedCertificateVerifier","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedCertificateVerifier to use to determine trust in raw public keys."},"advancedPskStore":{"index":10,"kind":"parameter","displayName":"Advanced Psk Store","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.pskstore.AdvancedPskStore","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedPskStore to use for pre-shared key."},"alias":{"index":11,"kind":"parameter","displayName":"Alias","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","enum":["NONE","WANT","REQUIRE"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the alias used to query the KeyStore for the private key and certificate. This parameter is used when we are enabling TLS with certificates on the service side, and similarly on the client side when TLS is used with certificates and client authentication. If the parameter is not specified then the default behavior is to use the first alias in the keystore that contains a key entry. This configuration parameter does not apply to configuring TLS via a Raw Public Key or a Pre-Shared Key."},"cipherSuites":{"index":12,"kind":"parameter","displayName":"Cipher Suites","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the cipherSuites String. This is a comma separated String of ciphersuites to configure. If it is not specified, then it falls back to getting the ciphersuites from the sslContextParameters object."},"clientAuthentication":{"index":13,"kind":"parameter","displayName":"Client Authentication","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.elements.config.CertificateAuthenticationMode","enum":["NONE","WANTED","NEEDED"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the configuration options for server-side client-authentication requirements. The value must be one of NONE, WANT, REQUIRE. If this value is not specified, then it falls back to checking the sslContextParameters.getServerParameters().getClientAuthentication() value."},"privateKey":{"index":14,"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":true,"description":"Set the configured private key for use with Raw Public Key."},"publicKey":{"index":15,"kind":"parameter","displayName":"Public Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PublicKey","deprecated":false,"autowired":false,"secret":false,"description":"Set the configured public key for use with Raw Public Key."},"recommendedCipherSuitesOnly":{"index":16,"kind":"parameter","displayName":"Recommended Cipher Suites Only","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"The CBC cipher suites are not recommended. If you want to use them, you first need to set the recommendedCipherSuitesOnly option to false."},"sslContextParameters":{"index":17,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"Set the SSLContextParameters object for setting up TLS. This is required for coapstcp, and for coaps when we are using certificates for TLS (as opposed to RPK or PKS)."}}} +{"component":{"kind":"component","name":"coap","title":"CoAP","description":"Send and receive messages to/from CoAP (Constrained Application Protocol) capable devices.","deprecated":false,"firstVersion":"2.16.0","label":"iot","javaType":"org.apache.camel.coap.CoAPComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-coap","version":"4.8.2","scheme":"coap","extendsScheme":"","alternativeSchemes":"coap,coaps,coap+tcp,coaps+tcp","syntax":"coap:uri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelCoapETag":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP ETag for the response.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_ETAG"},"CamelCoapMaxAge":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.lang.Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP Max-Age for the response body.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_MAX_AGE"},"CamelCoapMethod":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request method that the CoAP producer should use when calling the target CoAP server URI. Valid options are DELETE, GET, PING, POST & PUT.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_METHOD"},"CamelCoapResponseCode":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP response code sent by the external server. See RFC 7252 for details of what each code means.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_RESPONSE_CODE"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.coap.CoAPConstants#CONTENT_TYPE"}},"properties":{"uri":{"index":0,"kind":"path","displayName":"Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"description":"The URI for the CoAP endpoint"},"coapMethodRestrict":{"index":1,"kind":"parameter","displayName":"Coap Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["DELETE","GET","POST","PUT"],"deprecated":false,"autowired":false,"secret":false,"description":"Comma separated list of methods that the CoAP consumer will bind to. The default is to bind to all methods (DELETE, GET, POST, PUT)."},"observable":{"index":2,"kind":"parameter","displayName":"Observable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Make CoAP resource observable for source endpoint, based on RFC 7641."},"observe":{"index":3,"kind":"parameter","displayName":"Observe","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Send an observe request from a source endpoint, based on RFC 7641."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"notify":{"index":7,"kind":"parameter","displayName":"Notify","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Notify observers that the resource of this URI has changed, based on RFC 7641. Use this flag on a destination endpoint, with a URI that matches an existing source endpoint URI."},"lazyStartProducer":{"index":8,"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."},"advancedCertificateVerifier":{"index":9,"kind":"parameter","displayName":"Advanced Certificate Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.x509.NewAdvancedCertificateVerifier","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedCertificateVerifier to use to determine trust in raw public keys."},"advancedPskStore":{"index":10,"kind":"parameter","displayName":"Advanced Psk Store","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.pskstore.AdvancedPskStore","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedPskStore to use for pre-shared key."},"alias":{"index":11,"kind":"parameter","displayName":"Alias","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","enum":["NONE","WANT","REQUIRE"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the alias used to query the KeyStore for the private key and certificate. This parameter is used when we are enabling TLS with certificates on the service side, and similarly on the client side when TLS is used with certificates and client authentication. If the parameter is not specified then the default behavior is to use the first alias in the keystore that contains a key entry. This configuration parameter does not apply to configuring TLS via a Raw Public Key or a Pre-Shared Key."},"cipherSuites":{"index":12,"kind":"parameter","displayName":"Cipher Suites","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the cipherSuites String. This is a comma separated String of ciphersuites to configure. If it is not specified, then it falls back to getting the ciphersuites from the sslContextParameters object."},"clientAuthentication":{"index":13,"kind":"parameter","displayName":"Client Authentication","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.elements.config.CertificateAuthenticationMode","enum":["NONE","WANTED","NEEDED"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the configuration options for server-side client-authentication requirements. The value must be one of NONE, WANT, REQUIRE. If this value is not specified, then it falls back to checking the sslContextParameters.getServerParameters().getClientAuthentication() value."},"privateKey":{"index":14,"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":true,"description":"Set the configured private key for use with Raw Public Key."},"publicKey":{"index":15,"kind":"parameter","displayName":"Public Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PublicKey","deprecated":false,"autowired":false,"secret":false,"description":"Set the configured public key for use with Raw Public Key."},"recommendedCipherSuitesOnly":{"index":16,"kind":"parameter","displayName":"Recommended Cipher Suites Only","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"The CBC cipher suites are not recommended. If you want to use them, you first need to set the recommendedCipherSuitesOnly option to false."},"sslContextParameters":{"index":17,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"Set the SSLContextParameters object for setting up TLS. This is required for coapstcp, and for coaps when we are using certificates for TLS (as opposed to RPK or PKS)."}}} , -{"component":{"kind":"component","name":"coap+tcp","title":"CoAP","description":"Send and receive messages to/from CoAP (Constrained Application Protocol) capable devices.","deprecated":false,"firstVersion":"2.16.0","label":"iot","javaType":"org.apache.camel.coap.CoAPComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-coap","version":"4.8.1","scheme":"coap+tcp","extendsScheme":"","alternativeSchemes":"coap,coaps,coap+tcp,coaps+tcp","syntax":"coap+tcp:uri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelCoapETag":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP ETag for the response.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_ETAG"},"CamelCoapMaxAge":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.lang.Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP Max-Age for the response body.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_MAX_AGE"},"CamelCoapMethod":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request method that the CoAP producer should use when calling the target CoAP server URI. Valid options are DELETE, GET, PING, POST & PUT.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_METHOD"},"CamelCoapResponseCode":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP response code sent by the external server. See RFC 7252 for details of what each code means.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_RESPONSE_CODE"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.coap.CoAPConstants#CONTENT_TYPE"}},"properties":{"uri":{"index":0,"kind":"path","displayName":"Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"description":"The URI for the CoAP endpoint"},"coapMethodRestrict":{"index":1,"kind":"parameter","displayName":"Coap Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["DELETE","GET","POST","PUT"],"deprecated":false,"autowired":false,"secret":false,"description":"Comma separated list of methods that the CoAP consumer will bind to. The default is to bind to all methods (DELETE, GET, POST, PUT)."},"observable":{"index":2,"kind":"parameter","displayName":"Observable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Make CoAP resource observable for source endpoint, based on RFC 7641."},"observe":{"index":3,"kind":"parameter","displayName":"Observe","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Send an observe request from a source endpoint, based on RFC 7641."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"notify":{"index":7,"kind":"parameter","displayName":"Notify","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Notify observers that the resource of this URI has changed, based on RFC 7641. Use this flag on a destination endpoint, with a URI that matches an existing source endpoint URI."},"lazyStartProducer":{"index":8,"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."},"advancedCertificateVerifier":{"index":9,"kind":"parameter","displayName":"Advanced Certificate Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.x509.NewAdvancedCertificateVerifier","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedCertificateVerifier to use to determine trust in raw public keys."},"advancedPskStore":{"index":10,"kind":"parameter","displayName":"Advanced Psk Store","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.pskstore.AdvancedPskStore","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedPskStore to use for pre-shared key."},"alias":{"index":11,"kind":"parameter","displayName":"Alias","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","enum":["NONE","WANT","REQUIRE"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the alias used to query the KeyStore for the private key and certificate. This parameter is used when we are enabling TLS with certificates on the service side, and similarly on the client side when TLS is used with certificates and client authentication. If the parameter is not specified then the default behavior is to use the first alias in the keystore that contains a key entry. This configuration parameter does not apply to configuring TLS via a Raw Public Key or a Pre-Shared Key."},"cipherSuites":{"index":12,"kind":"parameter","displayName":"Cipher Suites","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the cipherSuites String. This is a comma separated String of ciphersuites to configure. If it is not specified, then it falls back to getting the ciphersuites from the sslContextParameters object."},"clientAuthentication":{"index":13,"kind":"parameter","displayName":"Client Authentication","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.elements.config.CertificateAuthenticationMode","enum":["NONE","WANTED","NEEDED"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the configuration options for server-side client-authentication requirements. The value must be one of NONE, WANT, REQUIRE. If this value is not specified, then it falls back to checking the sslContextParameters.getServerParameters().getClientAuthentication() value."},"privateKey":{"index":14,"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":true,"description":"Set the configured private key for use with Raw Public Key."},"publicKey":{"index":15,"kind":"parameter","displayName":"Public Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PublicKey","deprecated":false,"autowired":false,"secret":false,"description":"Set the configured public key for use with Raw Public Key."},"recommendedCipherSuitesOnly":{"index":16,"kind":"parameter","displayName":"Recommended Cipher Suites Only","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"The CBC cipher suites are not recommended. If you want to use them, you first need to set the recommendedCipherSuitesOnly option to false."},"sslContextParameters":{"index":17,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"Set the SSLContextParameters object for setting up TLS. This is required for coapstcp, and for coaps when we are using certificates for TLS (as opposed to RPK or PKS)."}}} +{"component":{"kind":"component","name":"coap+tcp","title":"CoAP","description":"Send and receive messages to/from CoAP (Constrained Application Protocol) capable devices.","deprecated":false,"firstVersion":"2.16.0","label":"iot","javaType":"org.apache.camel.coap.CoAPComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-coap","version":"4.8.2","scheme":"coap+tcp","extendsScheme":"","alternativeSchemes":"coap,coaps,coap+tcp,coaps+tcp","syntax":"coap+tcp:uri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelCoapETag":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP ETag for the response.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_ETAG"},"CamelCoapMaxAge":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.lang.Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP Max-Age for the response body.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_MAX_AGE"},"CamelCoapMethod":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request method that the CoAP producer should use when calling the target CoAP server URI. Valid options are DELETE, GET, PING, POST & PUT.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_METHOD"},"CamelCoapResponseCode":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP response code sent by the external server. See RFC 7252 for details of what each code means.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_RESPONSE_CODE"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.coap.CoAPConstants#CONTENT_TYPE"}},"properties":{"uri":{"index":0,"kind":"path","displayName":"Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"description":"The URI for the CoAP endpoint"},"coapMethodRestrict":{"index":1,"kind":"parameter","displayName":"Coap Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["DELETE","GET","POST","PUT"],"deprecated":false,"autowired":false,"secret":false,"description":"Comma separated list of methods that the CoAP consumer will bind to. The default is to bind to all methods (DELETE, GET, POST, PUT)."},"observable":{"index":2,"kind":"parameter","displayName":"Observable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Make CoAP resource observable for source endpoint, based on RFC 7641."},"observe":{"index":3,"kind":"parameter","displayName":"Observe","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Send an observe request from a source endpoint, based on RFC 7641."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"notify":{"index":7,"kind":"parameter","displayName":"Notify","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Notify observers that the resource of this URI has changed, based on RFC 7641. Use this flag on a destination endpoint, with a URI that matches an existing source endpoint URI."},"lazyStartProducer":{"index":8,"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."},"advancedCertificateVerifier":{"index":9,"kind":"parameter","displayName":"Advanced Certificate Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.x509.NewAdvancedCertificateVerifier","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedCertificateVerifier to use to determine trust in raw public keys."},"advancedPskStore":{"index":10,"kind":"parameter","displayName":"Advanced Psk Store","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.pskstore.AdvancedPskStore","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedPskStore to use for pre-shared key."},"alias":{"index":11,"kind":"parameter","displayName":"Alias","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","enum":["NONE","WANT","REQUIRE"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the alias used to query the KeyStore for the private key and certificate. This parameter is used when we are enabling TLS with certificates on the service side, and similarly on the client side when TLS is used with certificates and client authentication. If the parameter is not specified then the default behavior is to use the first alias in the keystore that contains a key entry. This configuration parameter does not apply to configuring TLS via a Raw Public Key or a Pre-Shared Key."},"cipherSuites":{"index":12,"kind":"parameter","displayName":"Cipher Suites","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the cipherSuites String. This is a comma separated String of ciphersuites to configure. If it is not specified, then it falls back to getting the ciphersuites from the sslContextParameters object."},"clientAuthentication":{"index":13,"kind":"parameter","displayName":"Client Authentication","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.elements.config.CertificateAuthenticationMode","enum":["NONE","WANTED","NEEDED"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the configuration options for server-side client-authentication requirements. The value must be one of NONE, WANT, REQUIRE. If this value is not specified, then it falls back to checking the sslContextParameters.getServerParameters().getClientAuthentication() value."},"privateKey":{"index":14,"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":true,"description":"Set the configured private key for use with Raw Public Key."},"publicKey":{"index":15,"kind":"parameter","displayName":"Public Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PublicKey","deprecated":false,"autowired":false,"secret":false,"description":"Set the configured public key for use with Raw Public Key."},"recommendedCipherSuitesOnly":{"index":16,"kind":"parameter","displayName":"Recommended Cipher Suites Only","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"The CBC cipher suites are not recommended. If you want to use them, you first need to set the recommendedCipherSuitesOnly option to false."},"sslContextParameters":{"index":17,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"Set the SSLContextParameters object for setting up TLS. This is required for coapstcp, and for coaps when we are using certificates for TLS (as opposed to RPK or PKS)."}}} , -{"component":{"kind":"component","name":"coaps","title":"CoAP (Secure)","description":"Send and receive messages to/from CoAP (Constrained Application Protocol) capable devices.","deprecated":false,"firstVersion":"2.16.0","label":"iot","javaType":"org.apache.camel.coap.CoAPComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-coap","version":"4.8.1","scheme":"coaps","extendsScheme":"","alternativeSchemes":"coap,coaps,coap+tcp,coaps+tcp","syntax":"coaps:uri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelCoapETag":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP ETag for the response.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_ETAG"},"CamelCoapMaxAge":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.lang.Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP Max-Age for the response body.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_MAX_AGE"},"CamelCoapMethod":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request method that the CoAP producer should use when calling the target CoAP server URI. Valid options are DELETE, GET, PING, POST & PUT.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_METHOD"},"CamelCoapResponseCode":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP response code sent by the external server. See RFC 7252 for details of what each code means.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_RESPONSE_CODE"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.coap.CoAPConstants#CONTENT_TYPE"}},"properties":{"uri":{"index":0,"kind":"path","displayName":"Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"description":"The URI for the CoAP endpoint"},"coapMethodRestrict":{"index":1,"kind":"parameter","displayName":"Coap Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["DELETE","GET","POST","PUT"],"deprecated":false,"autowired":false,"secret":false,"description":"Comma separated list of methods that the CoAP consumer will bind to. The default is to bind to all methods (DELETE, GET, POST, PUT)."},"observable":{"index":2,"kind":"parameter","displayName":"Observable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Make CoAP resource observable for source endpoint, based on RFC 7641."},"observe":{"index":3,"kind":"parameter","displayName":"Observe","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Send an observe request from a source endpoint, based on RFC 7641."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"notify":{"index":7,"kind":"parameter","displayName":"Notify","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Notify observers that the resource of this URI has changed, based on RFC 7641. Use this flag on a destination endpoint, with a URI that matches an existing source endpoint URI."},"lazyStartProducer":{"index":8,"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."},"advancedCertificateVerifier":{"index":9,"kind":"parameter","displayName":"Advanced Certificate Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.x509.NewAdvancedCertificateVerifier","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedCertificateVerifier to use to determine trust in raw public keys."},"advancedPskStore":{"index":10,"kind":"parameter","displayName":"Advanced Psk Store","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.pskstore.AdvancedPskStore","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedPskStore to use for pre-shared key."},"alias":{"index":11,"kind":"parameter","displayName":"Alias","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","enum":["NONE","WANT","REQUIRE"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the alias used to query the KeyStore for the private key and certificate. This parameter is used when we are enabling TLS with certificates on the service side, and similarly on the client side when TLS is used with certificates and client authentication. If the parameter is not specified then the default behavior is to use the first alias in the keystore that contains a key entry. This configuration parameter does not apply to configuring TLS via a Raw Public Key or a Pre-Shared Key."},"cipherSuites":{"index":12,"kind":"parameter","displayName":"Cipher Suites","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the cipherSuites String. This is a comma separated String of ciphersuites to configure. If it is not specified, then it falls back to getting the ciphersuites from the sslContextParameters object."},"clientAuthentication":{"index":13,"kind":"parameter","displayName":"Client Authentication","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.elements.config.CertificateAuthenticationMode","enum":["NONE","WANTED","NEEDED"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the configuration options for server-side client-authentication requirements. The value must be one of NONE, WANT, REQUIRE. If this value is not specified, then it falls back to checking the sslContextParameters.getServerParameters().getClientAuthentication() value."},"privateKey":{"index":14,"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":true,"description":"Set the configured private key for use with Raw Public Key."},"publicKey":{"index":15,"kind":"parameter","displayName":"Public Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PublicKey","deprecated":false,"autowired":false,"secret":false,"description":"Set the configured public key for use with Raw Public Key."},"recommendedCipherSuitesOnly":{"index":16,"kind":"parameter","displayName":"Recommended Cipher Suites Only","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"The CBC cipher suites are not recommended. If you want to use them, you first need to set the recommendedCipherSuitesOnly option to false."},"sslContextParameters":{"index":17,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"Set the SSLContextParameters object for setting up TLS. This is required for coapstcp, and for coaps when we are using certificates for TLS (as opposed to RPK or PKS)."}}} +{"component":{"kind":"component","name":"coaps","title":"CoAP (Secure)","description":"Send and receive messages to/from CoAP (Constrained Application Protocol) capable devices.","deprecated":false,"firstVersion":"2.16.0","label":"iot","javaType":"org.apache.camel.coap.CoAPComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-coap","version":"4.8.2","scheme":"coaps","extendsScheme":"","alternativeSchemes":"coap,coaps,coap+tcp,coaps+tcp","syntax":"coaps:uri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelCoapETag":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP ETag for the response.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_ETAG"},"CamelCoapMaxAge":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.lang.Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP Max-Age for the response body.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_MAX_AGE"},"CamelCoapMethod":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request method that the CoAP producer should use when calling the target CoAP server URI. Valid options are DELETE, GET, PING, POST & PUT.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_METHOD"},"CamelCoapResponseCode":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP response code sent by the external server. See RFC 7252 for details of what each code means.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_RESPONSE_CODE"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.coap.CoAPConstants#CONTENT_TYPE"}},"properties":{"uri":{"index":0,"kind":"path","displayName":"Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"description":"The URI for the CoAP endpoint"},"coapMethodRestrict":{"index":1,"kind":"parameter","displayName":"Coap Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["DELETE","GET","POST","PUT"],"deprecated":false,"autowired":false,"secret":false,"description":"Comma separated list of methods that the CoAP consumer will bind to. The default is to bind to all methods (DELETE, GET, POST, PUT)."},"observable":{"index":2,"kind":"parameter","displayName":"Observable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Make CoAP resource observable for source endpoint, based on RFC 7641."},"observe":{"index":3,"kind":"parameter","displayName":"Observe","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Send an observe request from a source endpoint, based on RFC 7641."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"notify":{"index":7,"kind":"parameter","displayName":"Notify","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Notify observers that the resource of this URI has changed, based on RFC 7641. Use this flag on a destination endpoint, with a URI that matches an existing source endpoint URI."},"lazyStartProducer":{"index":8,"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."},"advancedCertificateVerifier":{"index":9,"kind":"parameter","displayName":"Advanced Certificate Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.x509.NewAdvancedCertificateVerifier","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedCertificateVerifier to use to determine trust in raw public keys."},"advancedPskStore":{"index":10,"kind":"parameter","displayName":"Advanced Psk Store","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.pskstore.AdvancedPskStore","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedPskStore to use for pre-shared key."},"alias":{"index":11,"kind":"parameter","displayName":"Alias","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","enum":["NONE","WANT","REQUIRE"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the alias used to query the KeyStore for the private key and certificate. This parameter is used when we are enabling TLS with certificates on the service side, and similarly on the client side when TLS is used with certificates and client authentication. If the parameter is not specified then the default behavior is to use the first alias in the keystore that contains a key entry. This configuration parameter does not apply to configuring TLS via a Raw Public Key or a Pre-Shared Key."},"cipherSuites":{"index":12,"kind":"parameter","displayName":"Cipher Suites","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the cipherSuites String. This is a comma separated String of ciphersuites to configure. If it is not specified, then it falls back to getting the ciphersuites from the sslContextParameters object."},"clientAuthentication":{"index":13,"kind":"parameter","displayName":"Client Authentication","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.elements.config.CertificateAuthenticationMode","enum":["NONE","WANTED","NEEDED"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the configuration options for server-side client-authentication requirements. The value must be one of NONE, WANT, REQUIRE. If this value is not specified, then it falls back to checking the sslContextParameters.getServerParameters().getClientAuthentication() value."},"privateKey":{"index":14,"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":true,"description":"Set the configured private key for use with Raw Public Key."},"publicKey":{"index":15,"kind":"parameter","displayName":"Public Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PublicKey","deprecated":false,"autowired":false,"secret":false,"description":"Set the configured public key for use with Raw Public Key."},"recommendedCipherSuitesOnly":{"index":16,"kind":"parameter","displayName":"Recommended Cipher Suites Only","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"The CBC cipher suites are not recommended. If you want to use them, you first need to set the recommendedCipherSuitesOnly option to false."},"sslContextParameters":{"index":17,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"Set the SSLContextParameters object for setting up TLS. This is required for coapstcp, and for coaps when we are using certificates for TLS (as opposed to RPK or PKS)."}}} , -{"component":{"kind":"component","name":"coaps+tcp","title":"CoAP","description":"Send and receive messages to/from CoAP (Constrained Application Protocol) capable devices.","deprecated":false,"firstVersion":"2.16.0","label":"iot","javaType":"org.apache.camel.coap.CoAPComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-coap","version":"4.8.1","scheme":"coaps+tcp","extendsScheme":"","alternativeSchemes":"coap,coaps,coap+tcp,coaps+tcp","syntax":"coaps+tcp:uri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelCoapETag":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP ETag for the response.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_ETAG"},"CamelCoapMaxAge":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.lang.Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP Max-Age for the response body.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_MAX_AGE"},"CamelCoapMethod":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request method that the CoAP producer should use when calling the target CoAP server URI. Valid options are DELETE, GET, PING, POST & PUT.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_METHOD"},"CamelCoapResponseCode":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP response code sent by the external server. See RFC 7252 for details of what each code means.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_RESPONSE_CODE"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.coap.CoAPConstants#CONTENT_TYPE"}},"properties":{"uri":{"index":0,"kind":"path","displayName":"Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"description":"The URI for the CoAP endpoint"},"coapMethodRestrict":{"index":1,"kind":"parameter","displayName":"Coap Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["DELETE","GET","POST","PUT"],"deprecated":false,"autowired":false,"secret":false,"description":"Comma separated list of methods that the CoAP consumer will bind to. The default is to bind to all methods (DELETE, GET, POST, PUT)."},"observable":{"index":2,"kind":"parameter","displayName":"Observable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Make CoAP resource observable for source endpoint, based on RFC 7641."},"observe":{"index":3,"kind":"parameter","displayName":"Observe","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Send an observe request from a source endpoint, based on RFC 7641."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"notify":{"index":7,"kind":"parameter","displayName":"Notify","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Notify observers that the resource of this URI has changed, based on RFC 7641. Use this flag on a destination endpoint, with a URI that matches an existing source endpoint URI."},"lazyStartProducer":{"index":8,"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."},"advancedCertificateVerifier":{"index":9,"kind":"parameter","displayName":"Advanced Certificate Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.x509.NewAdvancedCertificateVerifier","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedCertificateVerifier to use to determine trust in raw public keys."},"advancedPskStore":{"index":10,"kind":"parameter","displayName":"Advanced Psk Store","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.pskstore.AdvancedPskStore","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedPskStore to use for pre-shared key."},"alias":{"index":11,"kind":"parameter","displayName":"Alias","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","enum":["NONE","WANT","REQUIRE"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the alias used to query the KeyStore for the private key and certificate. This parameter is used when we are enabling TLS with certificates on the service side, and similarly on the client side when TLS is used with certificates and client authentication. If the parameter is not specified then the default behavior is to use the first alias in the keystore that contains a key entry. This configuration parameter does not apply to configuring TLS via a Raw Public Key or a Pre-Shared Key."},"cipherSuites":{"index":12,"kind":"parameter","displayName":"Cipher Suites","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the cipherSuites String. This is a comma separated String of ciphersuites to configure. If it is not specified, then it falls back to getting the ciphersuites from the sslContextParameters object."},"clientAuthentication":{"index":13,"kind":"parameter","displayName":"Client Authentication","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.elements.config.CertificateAuthenticationMode","enum":["NONE","WANTED","NEEDED"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the configuration options for server-side client-authentication requirements. The value must be one of NONE, WANT, REQUIRE. If this value is not specified, then it falls back to checking the sslContextParameters.getServerParameters().getClientAuthentication() value."},"privateKey":{"index":14,"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":true,"description":"Set the configured private key for use with Raw Public Key."},"publicKey":{"index":15,"kind":"parameter","displayName":"Public Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PublicKey","deprecated":false,"autowired":false,"secret":false,"description":"Set the configured public key for use with Raw Public Key."},"recommendedCipherSuitesOnly":{"index":16,"kind":"parameter","displayName":"Recommended Cipher Suites Only","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"The CBC cipher suites are not recommended. If you want to use them, you first need to set the recommendedCipherSuitesOnly option to false."},"sslContextParameters":{"index":17,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"Set the SSLContextParameters object for setting up TLS. This is required for coapstcp, and for coaps when we are using certificates for TLS (as opposed to RPK or PKS)."}}} +{"component":{"kind":"component","name":"coaps+tcp","title":"CoAP","description":"Send and receive messages to/from CoAP (Constrained Application Protocol) capable devices.","deprecated":false,"firstVersion":"2.16.0","label":"iot","javaType":"org.apache.camel.coap.CoAPComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-coap","version":"4.8.2","scheme":"coaps+tcp","extendsScheme":"","alternativeSchemes":"coap,coaps,coap+tcp,coaps+tcp","syntax":"coaps+tcp:uri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelCoapETag":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP ETag for the response.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_ETAG"},"CamelCoapMaxAge":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.lang.Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP Max-Age for the response body.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_MAX_AGE"},"CamelCoapMethod":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request method that the CoAP producer should use when calling the target CoAP server URI. Valid options are DELETE, GET, PING, POST & PUT.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_METHOD"},"CamelCoapResponseCode":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CoAP response code sent by the external server. See RFC 7252 for details of what each code means.","constantName":"org.apache.camel.coap.CoAPConstants#COAP_RESPONSE_CODE"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.coap.CoAPConstants#CONTENT_TYPE"}},"properties":{"uri":{"index":0,"kind":"path","displayName":"Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"description":"The URI for the CoAP endpoint"},"coapMethodRestrict":{"index":1,"kind":"parameter","displayName":"Coap Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["DELETE","GET","POST","PUT"],"deprecated":false,"autowired":false,"secret":false,"description":"Comma separated list of methods that the CoAP consumer will bind to. The default is to bind to all methods (DELETE, GET, POST, PUT)."},"observable":{"index":2,"kind":"parameter","displayName":"Observable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Make CoAP resource observable for source endpoint, based on RFC 7641."},"observe":{"index":3,"kind":"parameter","displayName":"Observe","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Send an observe request from a source endpoint, based on RFC 7641."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"notify":{"index":7,"kind":"parameter","displayName":"Notify","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Notify observers that the resource of this URI has changed, based on RFC 7641. Use this flag on a destination endpoint, with a URI that matches an existing source endpoint URI."},"lazyStartProducer":{"index":8,"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."},"advancedCertificateVerifier":{"index":9,"kind":"parameter","displayName":"Advanced Certificate Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.x509.NewAdvancedCertificateVerifier","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedCertificateVerifier to use to determine trust in raw public keys."},"advancedPskStore":{"index":10,"kind":"parameter","displayName":"Advanced Psk Store","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.scandium.dtls.pskstore.AdvancedPskStore","deprecated":false,"autowired":false,"secret":false,"description":"Set the AdvancedPskStore to use for pre-shared key."},"alias":{"index":11,"kind":"parameter","displayName":"Alias","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","enum":["NONE","WANT","REQUIRE"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the alias used to query the KeyStore for the private key and certificate. This parameter is used when we are enabling TLS with certificates on the service side, and similarly on the client side when TLS is used with certificates and client authentication. If the parameter is not specified then the default behavior is to use the first alias in the keystore that contains a key entry. This configuration parameter does not apply to configuring TLS via a Raw Public Key or a Pre-Shared Key."},"cipherSuites":{"index":12,"kind":"parameter","displayName":"Cipher Suites","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the cipherSuites String. This is a comma separated String of ciphersuites to configure. If it is not specified, then it falls back to getting the ciphersuites from the sslContextParameters object."},"clientAuthentication":{"index":13,"kind":"parameter","displayName":"Client Authentication","group":"security","label":"security","required":false,"type":"object","javaType":"org.eclipse.californium.elements.config.CertificateAuthenticationMode","enum":["NONE","WANTED","NEEDED"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the configuration options for server-side client-authentication requirements. The value must be one of NONE, WANT, REQUIRE. If this value is not specified, then it falls back to checking the sslContextParameters.getServerParameters().getClientAuthentication() value."},"privateKey":{"index":14,"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":true,"description":"Set the configured private key for use with Raw Public Key."},"publicKey":{"index":15,"kind":"parameter","displayName":"Public Key","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.PublicKey","deprecated":false,"autowired":false,"secret":false,"description":"Set the configured public key for use with Raw Public Key."},"recommendedCipherSuitesOnly":{"index":16,"kind":"parameter","displayName":"Recommended Cipher Suites Only","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"The CBC cipher suites are not recommended. If you want to use them, you first need to set the recommendedCipherSuitesOnly option to false."},"sslContextParameters":{"index":17,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"Set the SSLContextParameters object for setting up TLS. This is required for coapstcp, and for coaps when we are using certificates for TLS (as opposed to RPK or PKS)."}}} , -{"component":{"kind":"component","name":"cometd","title":"CometD","description":"Offers publish/subscribe, peer-to-peer (via a server), and RPC style messaging using the CometD/Bayeux protocol.","deprecated":false,"firstVersion":"2.0.0","label":"networking,messaging","javaType":"org.apache.camel.component.cometd.CometdComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-cometd","version":"4.8.1","scheme":"cometd","extendsScheme":"","alternativeSchemes":"cometd,cometds","syntax":"cometd:host:port/channelName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CometdClientId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The clientId of the session","constantName":"org.apache.camel.component.cometd.CometdBinding#COMETD_CLIENT_ID_HEADER_NAME"},"subscription":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The subscription","constantName":"org.apache.camel.component.cometd.CometdBinding#COMETD_SUBSCRIPTION_HEADER_NAME"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Host port number"},"channelName":{"index":2,"kind":"path","displayName":"Channel Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channelName represents a topic that can be subscribed to by the Camel endpoints."},"allowedOrigins":{"index":3,"kind":"parameter","displayName":"Allowed Origins","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"*","description":"The origins domain that support to cross, if the crosssOriginFilterOn is true"},"baseResource":{"index":4,"kind":"parameter","displayName":"Base Resource","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The root directory for the web resources or classpath. Use the protocol file: or classpath: depending if you want that the component loads the resource from file system or classpath. Classpath is required for OSGI deployment where the resources are packaged in the jar"},"crossOriginFilterOn":{"index":5,"kind":"parameter","displayName":"Cross Origin Filter On","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the server will support for cross-domain filtering"},"filterPath":{"index":6,"kind":"parameter","displayName":"Filter Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The filterPath will be used by the CrossOriginFilter, if the crosssOriginFilterOn is true"},"interval":{"index":7,"kind":"parameter","displayName":"Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The client side poll timeout in milliseconds. How long a client will wait between reconnects"},"jsonCommented":{"index":8,"kind":"parameter","displayName":"Json Commented","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment. This is a defence against Ajax Hijacking."},"logLevel":{"index":9,"kind":"parameter","displayName":"Log Level","group":"common","label":"","required":false,"type":"integer","javaType":"int","enum":["0","1","2"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Logging level. 0=none, 1=info, 2=debug."},"maxInterval":{"index":10,"kind":"parameter","displayName":"Max Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"description":"The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time."},"multiFrameInterval":{"index":11,"kind":"parameter","displayName":"Multi Frame Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1500,"description":"The client side poll timeout, if multiple connections are detected from the same browser."},"timeout":{"index":12,"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":240000,"description":"The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding."},"sessionHeadersEnabled":{"index":13,"kind":"parameter","displayName":"Session Headers Enabled","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"disconnectLocalSession":{"index":17,"kind":"parameter","displayName":"Disconnect Local Session","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to disconnect local sessions after publishing a message to its channel. Disconnecting local session is needed as they are not swept by default by CometD, and therefore you can run out of memory."},"lazyStartProducer":{"index":18,"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."}}} +{"component":{"kind":"component","name":"cometd","title":"CometD","description":"Offers publish/subscribe, peer-to-peer (via a server), and RPC style messaging using the CometD/Bayeux protocol.","deprecated":false,"firstVersion":"2.0.0","label":"networking,messaging","javaType":"org.apache.camel.component.cometd.CometdComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-cometd","version":"4.8.2","scheme":"cometd","extendsScheme":"","alternativeSchemes":"cometd,cometds","syntax":"cometd:host:port/channelName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CometdClientId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The clientId of the session","constantName":"org.apache.camel.component.cometd.CometdBinding#COMETD_CLIENT_ID_HEADER_NAME"},"subscription":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The subscription","constantName":"org.apache.camel.component.cometd.CometdBinding#COMETD_SUBSCRIPTION_HEADER_NAME"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Host port number"},"channelName":{"index":2,"kind":"path","displayName":"Channel Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channelName represents a topic that can be subscribed to by the Camel endpoints."},"allowedOrigins":{"index":3,"kind":"parameter","displayName":"Allowed Origins","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"*","description":"The origins domain that support to cross, if the crosssOriginFilterOn is true"},"baseResource":{"index":4,"kind":"parameter","displayName":"Base Resource","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The root directory for the web resources or classpath. Use the protocol file: or classpath: depending if you want that the component loads the resource from file system or classpath. Classpath is required for OSGI deployment where the resources are packaged in the jar"},"crossOriginFilterOn":{"index":5,"kind":"parameter","displayName":"Cross Origin Filter On","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the server will support for cross-domain filtering"},"filterPath":{"index":6,"kind":"parameter","displayName":"Filter Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The filterPath will be used by the CrossOriginFilter, if the crosssOriginFilterOn is true"},"interval":{"index":7,"kind":"parameter","displayName":"Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The client side poll timeout in milliseconds. How long a client will wait between reconnects"},"jsonCommented":{"index":8,"kind":"parameter","displayName":"Json Commented","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment. This is a defence against Ajax Hijacking."},"logLevel":{"index":9,"kind":"parameter","displayName":"Log Level","group":"common","label":"","required":false,"type":"integer","javaType":"int","enum":["0","1","2"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Logging level. 0=none, 1=info, 2=debug."},"maxInterval":{"index":10,"kind":"parameter","displayName":"Max Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"description":"The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time."},"multiFrameInterval":{"index":11,"kind":"parameter","displayName":"Multi Frame Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1500,"description":"The client side poll timeout, if multiple connections are detected from the same browser."},"timeout":{"index":12,"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":240000,"description":"The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding."},"sessionHeadersEnabled":{"index":13,"kind":"parameter","displayName":"Session Headers Enabled","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"disconnectLocalSession":{"index":17,"kind":"parameter","displayName":"Disconnect Local Session","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to disconnect local sessions after publishing a message to its channel. Disconnecting local session is needed as they are not swept by default by CometD, and therefore you can run out of memory."},"lazyStartProducer":{"index":18,"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."}}} , -{"component":{"kind":"component","name":"cometds","title":"CometD (Secure)","description":"Offers publish/subscribe, peer-to-peer (via a server), and RPC style messaging using the CometD/Bayeux protocol.","deprecated":false,"firstVersion":"2.0.0","label":"networking,messaging","javaType":"org.apache.camel.component.cometd.CometdComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-cometd","version":"4.8.1","scheme":"cometds","extendsScheme":"","alternativeSchemes":"cometd,cometds","syntax":"cometds:host:port/channelName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CometdClientId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The clientId of the session","constantName":"org.apache.camel.component.cometd.CometdBinding#COMETD_CLIENT_ID_HEADER_NAME"},"subscription":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The subscription","constantName":"org.apache.camel.component.cometd.CometdBinding#COMETD_SUBSCRIPTION_HEADER_NAME"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Host port number"},"channelName":{"index":2,"kind":"path","displayName":"Channel Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channelName represents a topic that can be subscribed to by the Camel endpoints."},"allowedOrigins":{"index":3,"kind":"parameter","displayName":"Allowed Origins","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"*","description":"The origins domain that support to cross, if the crosssOriginFilterOn is true"},"baseResource":{"index":4,"kind":"parameter","displayName":"Base Resource","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The root directory for the web resources or classpath. Use the protocol file: or classpath: depending if you want that the component loads the resource from file system or classpath. Classpath is required for OSGI deployment where the resources are packaged in the jar"},"crossOriginFilterOn":{"index":5,"kind":"parameter","displayName":"Cross Origin Filter On","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the server will support for cross-domain filtering"},"filterPath":{"index":6,"kind":"parameter","displayName":"Filter Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The filterPath will be used by the CrossOriginFilter, if the crosssOriginFilterOn is true"},"interval":{"index":7,"kind":"parameter","displayName":"Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The client side poll timeout in milliseconds. How long a client will wait between reconnects"},"jsonCommented":{"index":8,"kind":"parameter","displayName":"Json Commented","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment. This is a defence against Ajax Hijacking."},"logLevel":{"index":9,"kind":"parameter","displayName":"Log Level","group":"common","label":"","required":false,"type":"integer","javaType":"int","enum":["0","1","2"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Logging level. 0=none, 1=info, 2=debug."},"maxInterval":{"index":10,"kind":"parameter","displayName":"Max Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"description":"The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time."},"multiFrameInterval":{"index":11,"kind":"parameter","displayName":"Multi Frame Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1500,"description":"The client side poll timeout, if multiple connections are detected from the same browser."},"timeout":{"index":12,"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":240000,"description":"The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding."},"sessionHeadersEnabled":{"index":13,"kind":"parameter","displayName":"Session Headers Enabled","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"disconnectLocalSession":{"index":17,"kind":"parameter","displayName":"Disconnect Local Session","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to disconnect local sessions after publishing a message to its channel. Disconnecting local session is needed as they are not swept by default by CometD, and therefore you can run out of memory."},"lazyStartProducer":{"index":18,"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."}}} +{"component":{"kind":"component","name":"cometds","title":"CometD (Secure)","description":"Offers publish/subscribe, peer-to-peer (via a server), and RPC style messaging using the CometD/Bayeux protocol.","deprecated":false,"firstVersion":"2.0.0","label":"networking,messaging","javaType":"org.apache.camel.component.cometd.CometdComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-cometd","version":"4.8.2","scheme":"cometds","extendsScheme":"","alternativeSchemes":"cometd,cometds","syntax":"cometds:host:port/channelName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CometdClientId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The clientId of the session","constantName":"org.apache.camel.component.cometd.CometdBinding#COMETD_CLIENT_ID_HEADER_NAME"},"subscription":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The subscription","constantName":"org.apache.camel.component.cometd.CometdBinding#COMETD_SUBSCRIPTION_HEADER_NAME"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Host port number"},"channelName":{"index":2,"kind":"path","displayName":"Channel Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channelName represents a topic that can be subscribed to by the Camel endpoints."},"allowedOrigins":{"index":3,"kind":"parameter","displayName":"Allowed Origins","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"*","description":"The origins domain that support to cross, if the crosssOriginFilterOn is true"},"baseResource":{"index":4,"kind":"parameter","displayName":"Base Resource","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The root directory for the web resources or classpath. Use the protocol file: or classpath: depending if you want that the component loads the resource from file system or classpath. Classpath is required for OSGI deployment where the resources are packaged in the jar"},"crossOriginFilterOn":{"index":5,"kind":"parameter","displayName":"Cross Origin Filter On","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the server will support for cross-domain filtering"},"filterPath":{"index":6,"kind":"parameter","displayName":"Filter Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The filterPath will be used by the CrossOriginFilter, if the crosssOriginFilterOn is true"},"interval":{"index":7,"kind":"parameter","displayName":"Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The client side poll timeout in milliseconds. How long a client will wait between reconnects"},"jsonCommented":{"index":8,"kind":"parameter","displayName":"Json Commented","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment. This is a defence against Ajax Hijacking."},"logLevel":{"index":9,"kind":"parameter","displayName":"Log Level","group":"common","label":"","required":false,"type":"integer","javaType":"int","enum":["0","1","2"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Logging level. 0=none, 1=info, 2=debug."},"maxInterval":{"index":10,"kind":"parameter","displayName":"Max Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"description":"The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time."},"multiFrameInterval":{"index":11,"kind":"parameter","displayName":"Multi Frame Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1500,"description":"The client side poll timeout, if multiple connections are detected from the same browser."},"timeout":{"index":12,"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":240000,"description":"The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding."},"sessionHeadersEnabled":{"index":13,"kind":"parameter","displayName":"Session Headers Enabled","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"disconnectLocalSession":{"index":17,"kind":"parameter","displayName":"Disconnect Local Session","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to disconnect local sessions after publishing a message to its channel. Disconnecting local session is needed as they are not swept by default by CometD, and therefore you can run out of memory."},"lazyStartProducer":{"index":18,"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."}}} , -{"component":{"kind":"component","name":"consul","title":"Consul","description":"Integrate with Consul service discovery and configuration store.","deprecated":false,"firstVersion":"2.18.0","label":"cloud,api","javaType":"org.apache.camel.component.consul.ConsulComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-consul","version":"4.8.1","scheme":"consul","extendsScheme":"","syntax":"consul:apiEndpoint","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelConsulAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer action","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_ACTION"},"CamelConsulKey":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Key on which the action should applied","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_KEY"},"CamelConsulEventId":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event id","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_EVENT_ID"},"CamelConsulEventName":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event name","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_EVENT_NAME"},"CamelConsulEventLTime":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event LTime","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_EVENT_LTIME"},"CamelConsulNodeFilter":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Node filter","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_NODE_FILTER"},"CamelConsulTagFilter":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tag filter","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_TAG_FILTER"},"CamelConsulSessionFilter":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The session filter","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_SERVICE_FILTER"},"CamelConsulVersion":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data version","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_VERSION"},"CamelConsulFlags":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Flags associated with a value","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_FLAGS"},"CamelConsulIndex":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The optional value index","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_INDEX"},"CamelConsulWait":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The optional value wait","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_WAIT"},"CamelConsulCreateIndex":{"index":12,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The internal index value that represents when the entry was created","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_CREATE_INDEX"},"CamelConsulLockIndex":{"index":13,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of times this key has successfully been acquired in a lock","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_LOCK_INDEX"},"CamelConsulModifyIndex":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The last index that modified this key","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_MODIFY_INDEX"},"CamelConsulOptions":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Options associated to the request","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_OPTIONS"},"CamelConsulResult":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"true if the response has a result","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_RESULT"},"CamelConsulSession":{"index":17,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The session id","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_SESSION"},"CamelConsulValueAsString":{"index":18,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To transform values retrieved from Consul i.e. on KV endpoint to string.","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_VALUE_AS_STRING"},"CamelConsulNode":{"index":19,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The node","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_NODE"},"CamelConsulService":{"index":20,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The service","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_SERVICE"},"CamelConsulDatacenter":{"index":21,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data center","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_DATACENTER"},"CamelConsulNearNode":{"index":22,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The near node to use for queries.","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_NEAR_NODE"},"CamelConsulNodeMeta":{"index":23,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The note meta-data to use for queries.","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_NODE_META"},"CamelConsulLastContact":{"index":24,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The last contact","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_LAST_CONTACT"},"CamelConsulKnownLeader":{"index":25,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates whether it is the known leader","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_KNOWN_LEADER"},"CamelConsulConsistencyMode":{"index":26,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.kiwiproject.consul.option.ConsistencyMode","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"DEFAULT","description":"The consistencyMode used for queries","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_CONSISTENCY_MODE"},"CamelConsulHealthyOnly":{"index":27,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Only on healthy services","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_HEALTHY_ONLY"},"CamelConsulHealthyState":{"index":28,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.kiwiproject.consul.model.State","enum":["PASS","WARN","FAIL","ANY","UNKNOWN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The state to query.","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_HEALTHY_STATE"},"CamelConsulPreparedQueryID":{"index":29,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the prepared query","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_PREPARED_QUERY_ID"},"CamelConsulServiceId":{"index":30,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The service id for agent deregistration","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_SERVICE_ID"}},"properties":{"apiEndpoint":{"index":0,"kind":"path","displayName":"Api Endpoint","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The API endpoint"},"connectTimeout":{"index":1,"kind":"parameter","displayName":"Connect Timeout","group":"common","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Connect timeout for OkHttpClient"},"consulClient":{"index":2,"kind":"parameter","displayName":"Consul Client","group":"common","label":"common","required":false,"type":"object","javaType":"org.kiwiproject.consul.Consul","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Reference to a org.kiwiproject.consul.Consul in the registry."},"key":{"index":3,"kind":"parameter","displayName":"Key","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The default key. Can be overridden by CamelConsulKey"},"pingInstance":{"index":4,"kind":"parameter","displayName":"Ping Instance","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Configure if the AgentClient should attempt a ping before returning the Consul instance"},"readTimeout":{"index":5,"kind":"parameter","displayName":"Read Timeout","group":"common","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Read timeout for OkHttpClient"},"tags":{"index":6,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Set tags. You can separate multiple tags by comma."},"url":{"index":7,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The Consul agent URL"},"writeTimeout":{"index":8,"kind":"parameter","displayName":"Write Timeout","group":"common","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Write timeout for OkHttpClient"},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"action":{"index":12,"kind":"parameter","displayName":"Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The default action. Can be overridden by CamelConsulAction"},"valueAsString":{"index":13,"kind":"parameter","displayName":"Value As String","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Default to transform values retrieved from Consul i.e. on KV endpoint to string."},"lazyStartProducer":{"index":14,"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."},"consistencyMode":{"index":15,"kind":"parameter","displayName":"Consistency Mode","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.kiwiproject.consul.option.ConsistencyMode","enum":["DEFAULT","STALE","CONSISTENT"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEFAULT","configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The consistencyMode used for queries, default ConsistencyMode.DEFAULT"},"datacenter":{"index":16,"kind":"parameter","displayName":"Datacenter","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The data center"},"nearNode":{"index":17,"kind":"parameter","displayName":"Near Node","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The near node to use for queries."},"nodeMeta":{"index":18,"kind":"parameter","displayName":"Node Meta","group":"advanced","label":"advanced","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The note meta-data to use for queries."},"aclToken":{"index":19,"kind":"parameter","displayName":"Acl Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Sets the ACL token to be used with Consul"},"password":{"index":20,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Sets the password to be used for basic authentication"},"sslContextParameters":{"index":21,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance."},"userName":{"index":22,"kind":"parameter","displayName":"User Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Sets the username to be used for basic authentication"},"blockSeconds":{"index":23,"kind":"parameter","displayName":"Block Seconds","group":"watch","label":"consumer,watch","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10","configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The second to wait for a watch event, default 10 seconds"},"firstIndex":{"index":24,"kind":"parameter","displayName":"First Index","group":"watch","label":"consumer,watch","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The first index for watch for, default 0"},"recursive":{"index":25,"kind":"parameter","displayName":"Recursive","group":"watch","label":"consumer,watch","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Recursively watch, default false"}}} +{"component":{"kind":"component","name":"consul","title":"Consul","description":"Integrate with Consul service discovery and configuration store.","deprecated":false,"firstVersion":"2.18.0","label":"cloud,api","javaType":"org.apache.camel.component.consul.ConsulComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-consul","version":"4.8.2","scheme":"consul","extendsScheme":"","syntax":"consul:apiEndpoint","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelConsulAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer action","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_ACTION"},"CamelConsulKey":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Key on which the action should applied","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_KEY"},"CamelConsulEventId":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event id","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_EVENT_ID"},"CamelConsulEventName":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event name","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_EVENT_NAME"},"CamelConsulEventLTime":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event LTime","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_EVENT_LTIME"},"CamelConsulNodeFilter":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Node filter","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_NODE_FILTER"},"CamelConsulTagFilter":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tag filter","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_TAG_FILTER"},"CamelConsulSessionFilter":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The session filter","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_SERVICE_FILTER"},"CamelConsulVersion":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data version","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_VERSION"},"CamelConsulFlags":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Flags associated with a value","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_FLAGS"},"CamelConsulIndex":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The optional value index","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_INDEX"},"CamelConsulWait":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The optional value wait","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_WAIT"},"CamelConsulCreateIndex":{"index":12,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The internal index value that represents when the entry was created","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_CREATE_INDEX"},"CamelConsulLockIndex":{"index":13,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of times this key has successfully been acquired in a lock","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_LOCK_INDEX"},"CamelConsulModifyIndex":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The last index that modified this key","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_MODIFY_INDEX"},"CamelConsulOptions":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Options associated to the request","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_OPTIONS"},"CamelConsulResult":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"true if the response has a result","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_RESULT"},"CamelConsulSession":{"index":17,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The session id","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_SESSION"},"CamelConsulValueAsString":{"index":18,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To transform values retrieved from Consul i.e. on KV endpoint to string.","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_VALUE_AS_STRING"},"CamelConsulNode":{"index":19,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The node","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_NODE"},"CamelConsulService":{"index":20,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The service","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_SERVICE"},"CamelConsulDatacenter":{"index":21,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data center","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_DATACENTER"},"CamelConsulNearNode":{"index":22,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The near node to use for queries.","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_NEAR_NODE"},"CamelConsulNodeMeta":{"index":23,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The note meta-data to use for queries.","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_NODE_META"},"CamelConsulLastContact":{"index":24,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The last contact","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_LAST_CONTACT"},"CamelConsulKnownLeader":{"index":25,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates whether it is the known leader","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_KNOWN_LEADER"},"CamelConsulConsistencyMode":{"index":26,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.kiwiproject.consul.option.ConsistencyMode","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"DEFAULT","description":"The consistencyMode used for queries","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_CONSISTENCY_MODE"},"CamelConsulHealthyOnly":{"index":27,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Only on healthy services","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_HEALTHY_ONLY"},"CamelConsulHealthyState":{"index":28,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.kiwiproject.consul.model.State","enum":["PASS","WARN","FAIL","ANY","UNKNOWN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The state to query.","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_HEALTHY_STATE"},"CamelConsulPreparedQueryID":{"index":29,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the prepared query","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_PREPARED_QUERY_ID"},"CamelConsulServiceId":{"index":30,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The service id for agent deregistration","constantName":"org.apache.camel.component.consul.ConsulConstants#CONSUL_SERVICE_ID"}},"properties":{"apiEndpoint":{"index":0,"kind":"path","displayName":"Api Endpoint","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The API endpoint"},"connectTimeout":{"index":1,"kind":"parameter","displayName":"Connect Timeout","group":"common","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Connect timeout for OkHttpClient"},"consulClient":{"index":2,"kind":"parameter","displayName":"Consul Client","group":"common","label":"common","required":false,"type":"object","javaType":"org.kiwiproject.consul.Consul","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Reference to a org.kiwiproject.consul.Consul in the registry."},"key":{"index":3,"kind":"parameter","displayName":"Key","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The default key. Can be overridden by CamelConsulKey"},"pingInstance":{"index":4,"kind":"parameter","displayName":"Ping Instance","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Configure if the AgentClient should attempt a ping before returning the Consul instance"},"readTimeout":{"index":5,"kind":"parameter","displayName":"Read Timeout","group":"common","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Read timeout for OkHttpClient"},"tags":{"index":6,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Set tags. You can separate multiple tags by comma."},"url":{"index":7,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The Consul agent URL"},"writeTimeout":{"index":8,"kind":"parameter","displayName":"Write Timeout","group":"common","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Write timeout for OkHttpClient"},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"action":{"index":12,"kind":"parameter","displayName":"Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The default action. Can be overridden by CamelConsulAction"},"valueAsString":{"index":13,"kind":"parameter","displayName":"Value As String","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Default to transform values retrieved from Consul i.e. on KV endpoint to string."},"lazyStartProducer":{"index":14,"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."},"consistencyMode":{"index":15,"kind":"parameter","displayName":"Consistency Mode","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.kiwiproject.consul.option.ConsistencyMode","enum":["DEFAULT","STALE","CONSISTENT"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEFAULT","configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The consistencyMode used for queries, default ConsistencyMode.DEFAULT"},"datacenter":{"index":16,"kind":"parameter","displayName":"Datacenter","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The data center"},"nearNode":{"index":17,"kind":"parameter","displayName":"Near Node","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The near node to use for queries."},"nodeMeta":{"index":18,"kind":"parameter","displayName":"Node Meta","group":"advanced","label":"advanced","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The note meta-data to use for queries."},"aclToken":{"index":19,"kind":"parameter","displayName":"Acl Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Sets the ACL token to be used with Consul"},"password":{"index":20,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Sets the password to be used for basic authentication"},"sslContextParameters":{"index":21,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance."},"userName":{"index":22,"kind":"parameter","displayName":"User Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Sets the username to be used for basic authentication"},"blockSeconds":{"index":23,"kind":"parameter","displayName":"Block Seconds","group":"watch","label":"consumer,watch","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10","configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The second to wait for a watch event, default 10 seconds"},"firstIndex":{"index":24,"kind":"parameter","displayName":"First Index","group":"watch","label":"consumer,watch","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"The first index for watch for, default 0"},"recursive":{"index":25,"kind":"parameter","displayName":"Recursive","group":"watch","label":"consumer,watch","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Recursively watch, default false"}}} , -{"component":{"kind":"component","name":"controlbus","title":"Control Bus","description":"Manage and monitor Camel routes.","deprecated":false,"firstVersion":"2.11.0","label":"core,monitoring","javaType":"org.apache.camel.component.controlbus.ControlBusComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-controlbus","version":"4.8.1","scheme":"controlbus","extendsScheme":"","syntax":"controlbus:command:language","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"command":{"index":0,"kind":"path","displayName":"Command","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["route","language"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Command can be either route or language"},"language":{"index":1,"kind":"path","displayName":"Language","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.spi.Language","enum":["bean","constant","csimple","datasonnet","exchangeProperty","file","groovy","header","hl7terser","java","joor","jq","jsonpath","mvel","ognl","python","ref","simple","spel","tokenize","xpath","xquery","xtokenize"],"deprecated":false,"autowired":false,"secret":false,"description":"Allows you to specify the name of a Language to use for evaluating the message body. If there is any result from the evaluation, then the result is put in the message body."},"action":{"index":2,"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["start","stop","fail","suspend","resume","restart","status","stats"],"deprecated":false,"autowired":false,"secret":false,"description":"To denote an action that can be either: start, stop, or status. To either start or stop a route, or to get the status of the route as output in the message body. You can use suspend and resume to either suspend or resume a route. You can use stats to get performance statics returned in XML format; the routeId option can be used to define which route to get the performance stats for, if routeId is not defined, then you get statistics for the entire CamelContext. The restart action will restart the route. And the fail action will stop and mark the route as failed (stopped due to an exception)"},"async":{"index":3,"kind":"parameter","displayName":"Async","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to execute the control bus task asynchronously. Important: If this option is enabled, then any result from the task is not set on the Exchange. This is only possible if executing tasks synchronously."},"loggingLevel":{"index":4,"kind":"parameter","displayName":"Logging Level","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"INFO","description":"Logging level used for logging when task is done, or if any exceptions occurred during processing the task."},"restartDelay":{"index":5,"kind":"parameter","displayName":"Restart Delay","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"The delay in millis to use when restarting a route."},"routeId":{"index":6,"kind":"parameter","displayName":"Route Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To specify a route by its id. The special keyword current indicates the current route."},"lazyStartProducer":{"index":7,"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."}}} +{"component":{"kind":"component","name":"controlbus","title":"Control Bus","description":"Manage and monitor Camel routes.","deprecated":false,"firstVersion":"2.11.0","label":"core,monitoring","javaType":"org.apache.camel.component.controlbus.ControlBusComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-controlbus","version":"4.8.2","scheme":"controlbus","extendsScheme":"","syntax":"controlbus:command:language","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"command":{"index":0,"kind":"path","displayName":"Command","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["route","language"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Command can be either route or language"},"language":{"index":1,"kind":"path","displayName":"Language","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.spi.Language","enum":["bean","constant","csimple","datasonnet","exchangeProperty","file","groovy","header","hl7terser","java","joor","jq","jsonpath","mvel","ognl","python","ref","simple","spel","tokenize","xpath","xquery","xtokenize"],"deprecated":false,"autowired":false,"secret":false,"description":"Allows you to specify the name of a Language to use for evaluating the message body. If there is any result from the evaluation, then the result is put in the message body."},"action":{"index":2,"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["start","stop","fail","suspend","resume","restart","status","stats"],"deprecated":false,"autowired":false,"secret":false,"description":"To denote an action that can be either: start, stop, or status. To either start or stop a route, or to get the status of the route as output in the message body. You can use suspend and resume to either suspend or resume a route. You can use stats to get performance statics returned in XML format; the routeId option can be used to define which route to get the performance stats for, if routeId is not defined, then you get statistics for the entire CamelContext. The restart action will restart the route. And the fail action will stop and mark the route as failed (stopped due to an exception)"},"async":{"index":3,"kind":"parameter","displayName":"Async","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to execute the control bus task asynchronously. Important: If this option is enabled, then any result from the task is not set on the Exchange. This is only possible if executing tasks synchronously."},"loggingLevel":{"index":4,"kind":"parameter","displayName":"Logging Level","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"INFO","description":"Logging level used for logging when task is done, or if any exceptions occurred during processing the task."},"restartDelay":{"index":5,"kind":"parameter","displayName":"Restart Delay","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"The delay in millis to use when restarting a route."},"routeId":{"index":6,"kind":"parameter","displayName":"Route Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To specify a route by its id. The special keyword current indicates the current route."},"lazyStartProducer":{"index":7,"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."}}} , -{"component":{"kind":"component","name":"couchbase","title":"Couchbase","description":"Query Couchbase Views with a poll strategy and/or perform various operations against Couchbase databases.","deprecated":false,"firstVersion":"2.19.0","label":"database","javaType":"org.apache.camel.component.couchbase.CouchbaseComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-couchbase","version":"4.8.1","scheme":"couchbase","extendsScheme":"","syntax":"couchbase:protocol://hostname:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CCB_KEY":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key","constantName":"org.apache.camel.component.couchbase.CouchbaseConstants#HEADER_KEY"},"CCB_ID":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The document id","constantName":"org.apache.camel.component.couchbase.CouchbaseConstants#HEADER_ID"},"CCB_TTL":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The expiry for the document in seconds","constantName":"org.apache.camel.component.couchbase.CouchbaseConstants#HEADER_TTL"},"CCB_DDN":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The design document name","constantName":"org.apache.camel.component.couchbase.CouchbaseConstants#HEADER_DESIGN_DOCUMENT_NAME"},"CCB_VN":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The view name","constantName":"org.apache.camel.component.couchbase.CouchbaseConstants#HEADER_VIEWNAME"},"CamelCqlResumeQuery":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resume action to execute when resuming.","constantName":"org.apache.camel.component.couchbase.CouchbaseConstants#COUCHBASE_RESUME_ACTION"}},"properties":{"protocol":{"index":0,"kind":"path","displayName":"Protocol","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The protocol to use"},"hostname":{"index":1,"kind":"path","displayName":"Hostname","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The hostname to use"},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8091,"description":"The port number to use"},"bucket":{"index":3,"kind":"parameter","displayName":"Bucket","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bucket to use"},"collection":{"index":4,"kind":"parameter","displayName":"Collection","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The collection to use"},"key":{"index":5,"kind":"parameter","displayName":"Key","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The key to use"},"scope":{"index":6,"kind":"parameter","displayName":"Scope","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The scope to use"},"consumerProcessedStrategy":{"index":7,"kind":"parameter","displayName":"Consumer Processed Strategy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"Define the consumer Processed strategy to use"},"descending":{"index":8,"kind":"parameter","displayName":"Descending","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Define if this operation is descending or not"},"designDocumentName":{"index":9,"kind":"parameter","displayName":"Design Document Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"beer","description":"The design document name to use"},"fullDocument":{"index":10,"kind":"parameter","displayName":"Full Document","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true consumer will return complete document instead data defined in view"},"limit":{"index":11,"kind":"parameter","displayName":"Limit","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"The output limit to use"},"rangeEndKey":{"index":12,"kind":"parameter","displayName":"Range End Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define a range for the end key"},"rangeStartKey":{"index":13,"kind":"parameter","displayName":"Range Start Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define a range for the start key"},"sendEmptyMessageWhenIdle":{"index":14,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skip":{"index":15,"kind":"parameter","displayName":"Skip","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Define the skip to use"},"viewName":{"index":16,"kind":"parameter","displayName":"View Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"brewery_beers","description":"The view name to use"},"bridgeErrorHandler":{"index":17,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":18,"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":{"index":19,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":20,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"autoStartIdForInserts":{"index":21,"kind":"parameter","displayName":"Auto Start Id For Inserts","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Define if we want an autostart Id when we are doing an insert operation"},"operation":{"index":22,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CCB_PUT","description":"The operation to do"},"persistTo":{"index":23,"kind":"parameter","displayName":"Persist To","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Where to persist the data"},"producerRetryAttempts":{"index":24,"kind":"parameter","displayName":"Producer Retry Attempts","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"description":"Define the number of retry attempts"},"producerRetryPause":{"index":25,"kind":"parameter","displayName":"Producer Retry Pause","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"description":"Define the retry pause between different attempts"},"replicateTo":{"index":26,"kind":"parameter","displayName":"Replicate To","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Where to replicate the data"},"startingIdForInsertsFrom":{"index":27,"kind":"parameter","displayName":"Starting Id For Inserts From","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Define the starting Id where we are doing an insert operation"},"lazyStartProducer":{"index":28,"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."},"additionalHosts":{"index":29,"kind":"parameter","displayName":"Additional Hosts","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The additional hosts"},"connectTimeout":{"index":30,"kind":"parameter","displayName":"Connect Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Define the timeoutconnect in milliseconds"},"queryTimeout":{"index":31,"kind":"parameter","displayName":"Query Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2500","description":"Define the operation timeout in milliseconds"},"backoffErrorThreshold":{"index":32,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":33,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":34,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":35,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":36,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":37,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":38,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":39,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":40,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":41,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":42,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":43,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":44,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":45,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":46,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The password to use"},"username":{"index":47,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The username to use"}}} +{"component":{"kind":"component","name":"couchbase","title":"Couchbase","description":"Query Couchbase Views with a poll strategy and/or perform various operations against Couchbase databases.","deprecated":false,"firstVersion":"2.19.0","label":"database","javaType":"org.apache.camel.component.couchbase.CouchbaseComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-couchbase","version":"4.8.2","scheme":"couchbase","extendsScheme":"","syntax":"couchbase:protocol://hostname:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CCB_KEY":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key","constantName":"org.apache.camel.component.couchbase.CouchbaseConstants#HEADER_KEY"},"CCB_ID":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The document id","constantName":"org.apache.camel.component.couchbase.CouchbaseConstants#HEADER_ID"},"CCB_TTL":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The expiry for the document in seconds","constantName":"org.apache.camel.component.couchbase.CouchbaseConstants#HEADER_TTL"},"CCB_DDN":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The design document name","constantName":"org.apache.camel.component.couchbase.CouchbaseConstants#HEADER_DESIGN_DOCUMENT_NAME"},"CCB_VN":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The view name","constantName":"org.apache.camel.component.couchbase.CouchbaseConstants#HEADER_VIEWNAME"},"CamelCqlResumeQuery":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resume action to execute when resuming.","constantName":"org.apache.camel.component.couchbase.CouchbaseConstants#COUCHBASE_RESUME_ACTION"}},"properties":{"protocol":{"index":0,"kind":"path","displayName":"Protocol","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The protocol to use"},"hostname":{"index":1,"kind":"path","displayName":"Hostname","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The hostname to use"},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8091,"description":"The port number to use"},"bucket":{"index":3,"kind":"parameter","displayName":"Bucket","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bucket to use"},"collection":{"index":4,"kind":"parameter","displayName":"Collection","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The collection to use"},"key":{"index":5,"kind":"parameter","displayName":"Key","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The key to use"},"scope":{"index":6,"kind":"parameter","displayName":"Scope","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The scope to use"},"consumerProcessedStrategy":{"index":7,"kind":"parameter","displayName":"Consumer Processed Strategy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"Define the consumer Processed strategy to use"},"descending":{"index":8,"kind":"parameter","displayName":"Descending","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Define if this operation is descending or not"},"designDocumentName":{"index":9,"kind":"parameter","displayName":"Design Document Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"beer","description":"The design document name to use"},"fullDocument":{"index":10,"kind":"parameter","displayName":"Full Document","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true consumer will return complete document instead data defined in view"},"limit":{"index":11,"kind":"parameter","displayName":"Limit","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"The output limit to use"},"rangeEndKey":{"index":12,"kind":"parameter","displayName":"Range End Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define a range for the end key"},"rangeStartKey":{"index":13,"kind":"parameter","displayName":"Range Start Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define a range for the start key"},"sendEmptyMessageWhenIdle":{"index":14,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skip":{"index":15,"kind":"parameter","displayName":"Skip","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Define the skip to use"},"viewName":{"index":16,"kind":"parameter","displayName":"View Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"brewery_beers","description":"The view name to use"},"bridgeErrorHandler":{"index":17,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":18,"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":{"index":19,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":20,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"autoStartIdForInserts":{"index":21,"kind":"parameter","displayName":"Auto Start Id For Inserts","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Define if we want an autostart Id when we are doing an insert operation"},"operation":{"index":22,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CCB_PUT","description":"The operation to do"},"persistTo":{"index":23,"kind":"parameter","displayName":"Persist To","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Where to persist the data"},"producerRetryAttempts":{"index":24,"kind":"parameter","displayName":"Producer Retry Attempts","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"description":"Define the number of retry attempts"},"producerRetryPause":{"index":25,"kind":"parameter","displayName":"Producer Retry Pause","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"description":"Define the retry pause between different attempts"},"replicateTo":{"index":26,"kind":"parameter","displayName":"Replicate To","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Where to replicate the data"},"startingIdForInsertsFrom":{"index":27,"kind":"parameter","displayName":"Starting Id For Inserts From","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Define the starting Id where we are doing an insert operation"},"lazyStartProducer":{"index":28,"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."},"additionalHosts":{"index":29,"kind":"parameter","displayName":"Additional Hosts","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The additional hosts"},"connectTimeout":{"index":30,"kind":"parameter","displayName":"Connect Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Define the timeoutconnect in milliseconds"},"queryTimeout":{"index":31,"kind":"parameter","displayName":"Query Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2500","description":"Define the operation timeout in milliseconds"},"backoffErrorThreshold":{"index":32,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":33,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":34,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":35,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":36,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":37,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":38,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":39,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":40,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":41,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":42,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":43,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":44,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":45,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":46,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The password to use"},"username":{"index":47,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The username to use"}}} , -{"component":{"kind":"component","name":"couchdb","title":"CouchDB","description":"Consume changesets for inserts, updates and deletes in a CouchDB database, as well as get, save, update and delete documents from a CouchDB database.","deprecated":false,"firstVersion":"2.11.0","label":"database","javaType":"org.apache.camel.component.couchdb.CouchDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-couchdb","version":"4.8.1","scheme":"couchdb","extendsScheme":"","syntax":"couchdb:protocol:hostname:port/database","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CouchDbDatabase":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The database the message came from","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_DATABASE"},"CouchDbSeq":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The couchdb changeset sequence number of the update / delete message","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_SEQ"},"CouchDbId":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The couchdb document id","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_DOC_ID"},"CouchDbRev":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The couchdb document revision","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_DOC_REV"},"CouchDbMethod":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The method (delete / update)","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_METHOD"},"CamelCouchDbResumeAction":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resume action to execute when resuming.","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#COUCHDB_RESUME_ACTION"}},"properties":{"protocol":{"index":0,"kind":"path","displayName":"Protocol","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["http","https"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The protocol to use for communicating with the database."},"hostname":{"index":1,"kind":"path","displayName":"Hostname","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname of the running couchdb instance"},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5984,"description":"Port number for the running couchdb instance"},"database":{"index":3,"kind":"path","displayName":"Database","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the database to use"},"createDatabase":{"index":4,"kind":"parameter","displayName":"Create Database","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Creates the database if it does not already exist"},"deletes":{"index":5,"kind":"parameter","displayName":"Deletes","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Document deletes are published as events"},"heartbeat":{"index":6,"kind":"parameter","displayName":"Heartbeat","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"How often to send an empty message to keep socket alive in millis"},"maxMessagesPerPoll":{"index":7,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"description":"Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited."},"style":{"index":8,"kind":"parameter","displayName":"Style","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["all_docs","main_only"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"main_only","description":"Specifies how many revisions are returned in the changes array. The default, main_only, will only return the current winning revision; all_docs will return all leaf revisions (including conflicts and deleted former conflicts.)"},"updates":{"index":9,"kind":"parameter","displayName":"Updates","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Document inserts/updates are published as events"},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":13,"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."},"password":{"index":14,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Password for authenticated databases"},"username":{"index":15,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Username in case of authenticated databases"}}} +{"component":{"kind":"component","name":"couchdb","title":"CouchDB","description":"Consume changesets for inserts, updates and deletes in a CouchDB database, as well as get, save, update and delete documents from a CouchDB database.","deprecated":false,"firstVersion":"2.11.0","label":"database","javaType":"org.apache.camel.component.couchdb.CouchDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-couchdb","version":"4.8.2","scheme":"couchdb","extendsScheme":"","syntax":"couchdb:protocol:hostname:port/database","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CouchDbDatabase":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The database the message came from","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_DATABASE"},"CouchDbSeq":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The couchdb changeset sequence number of the update / delete message","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_SEQ"},"CouchDbId":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The couchdb document id","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_DOC_ID"},"CouchDbRev":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The couchdb document revision","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_DOC_REV"},"CouchDbMethod":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The method (delete / update)","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_METHOD"},"CamelCouchDbResumeAction":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resume action to execute when resuming.","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#COUCHDB_RESUME_ACTION"}},"properties":{"protocol":{"index":0,"kind":"path","displayName":"Protocol","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["http","https"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The protocol to use for communicating with the database."},"hostname":{"index":1,"kind":"path","displayName":"Hostname","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname of the running couchdb instance"},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5984,"description":"Port number for the running couchdb instance"},"database":{"index":3,"kind":"path","displayName":"Database","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the database to use"},"createDatabase":{"index":4,"kind":"parameter","displayName":"Create Database","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Creates the database if it does not already exist"},"deletes":{"index":5,"kind":"parameter","displayName":"Deletes","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Document deletes are published as events"},"heartbeat":{"index":6,"kind":"parameter","displayName":"Heartbeat","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"How often to send an empty message to keep socket alive in millis"},"maxMessagesPerPoll":{"index":7,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"description":"Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited."},"style":{"index":8,"kind":"parameter","displayName":"Style","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["all_docs","main_only"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"main_only","description":"Specifies how many revisions are returned in the changes array. The default, main_only, will only return the current winning revision; all_docs will return all leaf revisions (including conflicts and deleted former conflicts.)"},"updates":{"index":9,"kind":"parameter","displayName":"Updates","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Document inserts/updates are published as events"},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":13,"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."},"password":{"index":14,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Password for authenticated databases"},"username":{"index":15,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Username in case of authenticated databases"}}} , -{"component":{"kind":"component","name":"cql","title":"Cassandra CQL","description":"Integrate with Cassandra 2.0 using the CQL3 API (not the Thrift API). Based on Cassandra Java Driver provided by DataStax.","deprecated":false,"firstVersion":"2.15.0","label":"database,bigdata","javaType":"org.apache.camel.component.cassandra.CassandraComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-cassandraql","version":"4.8.1","scheme":"cql","extendsScheme":"","syntax":"cql:beanRef:hosts:port/keyspace","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelCqlQuery":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CQL query to execute.","constantName":"org.apache.camel.component.cassandra.CassandraConstants#CQL_QUERY"},"CamelCqlResumeAction":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resume action to execute when resuming.","constantName":"org.apache.camel.component.cassandra.CassandraConstants#CASSANDRA_RESUME_ACTION"}},"properties":{"beanRef":{"index":0,"kind":"path","displayName":"Bean Ref","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"beanRef is defined using bean:id"},"hosts":{"index":1,"kind":"path","displayName":"Hosts","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Hostname(s) Cassandra server(s). Multiple hosts can be separated by comma."},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"Port number of Cassandra server(s)"},"keyspace":{"index":3,"kind":"path","displayName":"Keyspace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Keyspace to use"},"clusterName":{"index":4,"kind":"parameter","displayName":"Cluster Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Cluster name"},"cql":{"index":5,"kind":"parameter","displayName":"Cql","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"CQL query to perform. Can be overridden with the message header with key CamelCqlQuery."},"datacenter":{"index":6,"kind":"parameter","displayName":"Datacenter","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"datacenter1","description":"Datacenter to use"},"prepareStatements":{"index":7,"kind":"parameter","displayName":"Prepare Statements","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to use PreparedStatements or regular Statements"},"sendEmptyMessageWhenIdle":{"index":8,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":12,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":13,"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."},"extraTypeCodecs":{"index":14,"kind":"parameter","displayName":"Extra Type Codecs","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a specific comma separated list of Extra Type codecs. Possible values are: BLOB_TO_ARRAY, BOOLEAN_LIST_TO_ARRAY, BYTE_LIST_TO_ARRAY, SHORT_LIST_TO_ARRAY, INT_LIST_TO_ARRAY, LONG_LIST_TO_ARRAY, FLOAT_LIST_TO_ARRAY, DOUBLE_LIST_TO_ARRAY, TIMESTAMP_UTC, TIMESTAMP_MILLIS_SYSTEM, TIMESTAMP_MILLIS_UTC, ZONED_TIMESTAMP_SYSTEM, ZONED_TIMESTAMP_UTC, ZONED_TIMESTAMP_PERSISTED, LOCAL_TIMESTAMP_SYSTEM and LOCAL_TIMESTAMP_UTC"},"loadBalancingPolicyClass":{"index":15,"kind":"parameter","displayName":"Load Balancing Policy Class","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a specific LoadBalancingPolicyClass"},"resultSetConversionStrategy":{"index":16,"kind":"parameter","displayName":"Result Set Conversion Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.cassandra.ResultSetConversionStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom class that implements logic for converting ResultSet into message body ALL, ONE, LIMIT_10, LIMIT_100..."},"session":{"index":17,"kind":"parameter","displayName":"Session","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.datastax.oss.driver.api.core.CqlSession","deprecated":false,"autowired":false,"secret":false,"description":"To use the Session instance (you would normally not use this option)"},"backoffErrorThreshold":{"index":18,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":19,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":20,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":21,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":22,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":23,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":24,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":25,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":26,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":27,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":28,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":29,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":30,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":31,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":32,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Password for session authentication"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Username for session authentication"}}} +{"component":{"kind":"component","name":"cql","title":"Cassandra CQL","description":"Integrate with Cassandra 2.0 using the CQL3 API (not the Thrift API). Based on Cassandra Java Driver provided by DataStax.","deprecated":false,"firstVersion":"2.15.0","label":"database,bigdata","javaType":"org.apache.camel.component.cassandra.CassandraComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-cassandraql","version":"4.8.2","scheme":"cql","extendsScheme":"","syntax":"cql:beanRef:hosts:port/keyspace","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelCqlQuery":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CQL query to execute.","constantName":"org.apache.camel.component.cassandra.CassandraConstants#CQL_QUERY"},"CamelCqlResumeAction":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resume action to execute when resuming.","constantName":"org.apache.camel.component.cassandra.CassandraConstants#CASSANDRA_RESUME_ACTION"}},"properties":{"beanRef":{"index":0,"kind":"path","displayName":"Bean Ref","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"beanRef is defined using bean:id"},"hosts":{"index":1,"kind":"path","displayName":"Hosts","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Hostname(s) Cassandra server(s). Multiple hosts can be separated by comma."},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"Port number of Cassandra server(s)"},"keyspace":{"index":3,"kind":"path","displayName":"Keyspace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Keyspace to use"},"clusterName":{"index":4,"kind":"parameter","displayName":"Cluster Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Cluster name"},"cql":{"index":5,"kind":"parameter","displayName":"Cql","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"CQL query to perform. Can be overridden with the message header with key CamelCqlQuery."},"datacenter":{"index":6,"kind":"parameter","displayName":"Datacenter","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"datacenter1","description":"Datacenter to use"},"prepareStatements":{"index":7,"kind":"parameter","displayName":"Prepare Statements","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to use PreparedStatements or regular Statements"},"sendEmptyMessageWhenIdle":{"index":8,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":12,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":13,"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."},"extraTypeCodecs":{"index":14,"kind":"parameter","displayName":"Extra Type Codecs","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a specific comma separated list of Extra Type codecs. Possible values are: BLOB_TO_ARRAY, BOOLEAN_LIST_TO_ARRAY, BYTE_LIST_TO_ARRAY, SHORT_LIST_TO_ARRAY, INT_LIST_TO_ARRAY, LONG_LIST_TO_ARRAY, FLOAT_LIST_TO_ARRAY, DOUBLE_LIST_TO_ARRAY, TIMESTAMP_UTC, TIMESTAMP_MILLIS_SYSTEM, TIMESTAMP_MILLIS_UTC, ZONED_TIMESTAMP_SYSTEM, ZONED_TIMESTAMP_UTC, ZONED_TIMESTAMP_PERSISTED, LOCAL_TIMESTAMP_SYSTEM and LOCAL_TIMESTAMP_UTC"},"loadBalancingPolicyClass":{"index":15,"kind":"parameter","displayName":"Load Balancing Policy Class","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a specific LoadBalancingPolicyClass"},"resultSetConversionStrategy":{"index":16,"kind":"parameter","displayName":"Result Set Conversion Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.cassandra.ResultSetConversionStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom class that implements logic for converting ResultSet into message body ALL, ONE, LIMIT_10, LIMIT_100..."},"session":{"index":17,"kind":"parameter","displayName":"Session","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.datastax.oss.driver.api.core.CqlSession","deprecated":false,"autowired":false,"secret":false,"description":"To use the Session instance (you would normally not use this option)"},"backoffErrorThreshold":{"index":18,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":19,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":20,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":21,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":22,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":23,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":24,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":25,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":26,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":27,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":28,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":29,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":30,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":31,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":32,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Password for session authentication"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Username for session authentication"}}} , -{"component":{"kind":"component","name":"cron","title":"Cron","description":"A generic interface for triggering events at times specified through the Unix cron syntax.","deprecated":false,"firstVersion":"3.1.0","label":"scheduling","javaType":"org.apache.camel.component.cron.CronComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-cron","version":"4.8.1","scheme":"cron","extendsScheme":"","syntax":"cron:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.cron.api.CamelCronConfiguration","configurationField":"configuration","description":"The name of the cron trigger"},"schedule":{"index":1,"kind":"parameter","displayName":"Schedule","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.cron.api.CamelCronConfiguration","configurationField":"configuration","description":"A cron expression that will be used to generate events"},"bridgeErrorHandler":{"index":2,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":3,"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":{"index":4,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} +{"component":{"kind":"component","name":"cron","title":"Cron","description":"A generic interface for triggering events at times specified through the Unix cron syntax.","deprecated":false,"firstVersion":"3.1.0","label":"scheduling","javaType":"org.apache.camel.component.cron.CronComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-cron","version":"4.8.2","scheme":"cron","extendsScheme":"","syntax":"cron:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.cron.api.CamelCronConfiguration","configurationField":"configuration","description":"The name of the cron trigger"},"schedule":{"index":1,"kind":"parameter","displayName":"Schedule","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.cron.api.CamelCronConfiguration","configurationField":"configuration","description":"A cron expression that will be used to generate events"},"bridgeErrorHandler":{"index":2,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":3,"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":{"index":4,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} , -{"component":{"kind":"component","name":"crypto","title":"Crypto (JCE)","description":"Sign and verify exchanges using the Signature Service of the Java Cryptographic Extension (JCE).","deprecated":false,"firstVersion":"2.3.0","label":"security,transformation","javaType":"org.apache.camel.component.crypto.DigitalSignatureComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-crypto","version":"4.8.1","scheme":"crypto","extendsScheme":"","syntax":"crypto:cryptoOperation:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelSignaturePrivateKey":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.security.PrivateKey","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The PrivateKey that should be used to sign the message","constantName":"org.apache.camel.component.crypto.DigitalSignatureConstants#SIGNATURE_PRIVATE_KEY"},"CamelSignaturePublicKeyOrCert":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Certificate or PublicKey","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Certificate or PublicKey that should be used to verify the signature","constantName":"org.apache.camel.component.crypto.DigitalSignatureConstants#SIGNATURE_PUBLIC_KEY_OR_CERT"},"CamelSignatureKeyStoreAlias":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The alias used to query the KeyStore for keys and Certificates to be used in signing and verifying exchanges","constantName":"org.apache.camel.component.crypto.DigitalSignatureConstants#KEYSTORE_ALIAS"},"CamelSignatureKeyStorePassword":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"char[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password used to access an aliased PrivateKey in the KeyStore.","constantName":"org.apache.camel.component.crypto.DigitalSignatureConstants#KEYSTORE_PASSWORD"}},"properties":{"cryptoOperation":{"index":0,"kind":"path","displayName":"Crypto Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.crypto.CryptoOperation","enum":["sign","verify"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto:sign sets sign as the operation."},"name":{"index":1,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"The logical name of this operation."},"algorithm":{"index":2,"kind":"parameter","displayName":"Algorithm","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"SHA256withRSA","configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the JCE name of the Algorithm that should be used for the signer."},"alias":{"index":3,"kind":"parameter","displayName":"Alias","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the alias used to query the KeyStore for keys and {link java.security.cert.Certificate Certificates} to be used in signing and verifying exchanges. This value can be provided at runtime via the message header org.apache.camel.component.crypto.DigitalSignatureConstants#KEYSTORE_ALIAS"},"certificateName":{"index":4,"kind":"parameter","displayName":"Certificate Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the reference name for a PrivateKey that can be found in the registry."},"keystore":{"index":5,"kind":"parameter","displayName":"Keystore","group":"producer","label":"","required":false,"type":"object","javaType":"java.security.KeyStore","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges. A KeyStore is typically used with an alias, either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore, then this single entry will be used."},"keystoreName":{"index":6,"kind":"parameter","displayName":"Keystore Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the reference name for a Keystore that can be found in the registry."},"privateKey":{"index":7,"kind":"parameter","displayName":"Private Key","group":"producer","label":"","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the PrivateKey that should be used to sign the exchange"},"privateKeyName":{"index":8,"kind":"parameter","displayName":"Private Key Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the reference name for a PrivateKey that can be found in the registry."},"provider":{"index":9,"kind":"parameter","displayName":"Provider","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the id of the security provider that provides the configured Signature algorithm."},"publicKeyName":{"index":10,"kind":"parameter","displayName":"Public Key Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"references that should be resolved when the context changes"},"secureRandomName":{"index":11,"kind":"parameter","displayName":"Secure Random Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the reference name for a SecureRandom that can be found in the registry."},"signatureHeaderName":{"index":12,"kind":"parameter","displayName":"Signature Header Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the name of the message header that should be used to store the base64 encoded signature. This defaults to 'CamelDigitalSignature'"},"lazyStartProducer":{"index":13,"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."},"bufferSize":{"index":14,"kind":"parameter","displayName":"Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2048","configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the size of the buffer used to read in the Exchange payload data."},"certificate":{"index":15,"kind":"parameter","displayName":"Certificate","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.security.cert.Certificate","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the Certificate that should be used to verify the signature in the exchange based on its payload."},"clearHeaders":{"index":16,"kind":"parameter","displayName":"Clear Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Determines if the Signature specific headers be cleared after signing and verification. Defaults to true, and should only be made otherwise at your extreme peril as vital private information such as Keys and passwords may escape if unset."},"keyStoreParameters":{"index":17,"kind":"parameter","displayName":"Key Store Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.KeyStoreParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges based on the given KeyStoreParameters. A KeyStore is typically used with an alias, either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore, then this single entry will be used."},"publicKey":{"index":18,"kind":"parameter","displayName":"Public Key","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.security.PublicKey","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the PublicKey that should be used to verify the signature in the exchange."},"secureRandom":{"index":19,"kind":"parameter","displayName":"Secure Random","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.security.SecureRandom","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the SecureRandom used to initialize the Signature service"},"password":{"index":20,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the password used to access an aliased PrivateKey in the KeyStore."}}} +{"component":{"kind":"component","name":"crypto","title":"Crypto (JCE)","description":"Sign and verify exchanges using the Signature Service of the Java Cryptographic Extension (JCE).","deprecated":false,"firstVersion":"2.3.0","label":"security,transformation","javaType":"org.apache.camel.component.crypto.DigitalSignatureComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-crypto","version":"4.8.2","scheme":"crypto","extendsScheme":"","syntax":"crypto:cryptoOperation:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelSignaturePrivateKey":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.security.PrivateKey","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The PrivateKey that should be used to sign the message","constantName":"org.apache.camel.component.crypto.DigitalSignatureConstants#SIGNATURE_PRIVATE_KEY"},"CamelSignaturePublicKeyOrCert":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Certificate or PublicKey","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Certificate or PublicKey that should be used to verify the signature","constantName":"org.apache.camel.component.crypto.DigitalSignatureConstants#SIGNATURE_PUBLIC_KEY_OR_CERT"},"CamelSignatureKeyStoreAlias":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The alias used to query the KeyStore for keys and Certificates to be used in signing and verifying exchanges","constantName":"org.apache.camel.component.crypto.DigitalSignatureConstants#KEYSTORE_ALIAS"},"CamelSignatureKeyStorePassword":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"char[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password used to access an aliased PrivateKey in the KeyStore.","constantName":"org.apache.camel.component.crypto.DigitalSignatureConstants#KEYSTORE_PASSWORD"}},"properties":{"cryptoOperation":{"index":0,"kind":"path","displayName":"Crypto Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.crypto.CryptoOperation","enum":["sign","verify"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto:sign sets sign as the operation."},"name":{"index":1,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"The logical name of this operation."},"algorithm":{"index":2,"kind":"parameter","displayName":"Algorithm","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"SHA256withRSA","configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the JCE name of the Algorithm that should be used for the signer."},"alias":{"index":3,"kind":"parameter","displayName":"Alias","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the alias used to query the KeyStore for keys and {link java.security.cert.Certificate Certificates} to be used in signing and verifying exchanges. This value can be provided at runtime via the message header org.apache.camel.component.crypto.DigitalSignatureConstants#KEYSTORE_ALIAS"},"certificateName":{"index":4,"kind":"parameter","displayName":"Certificate Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the reference name for a PrivateKey that can be found in the registry."},"keystore":{"index":5,"kind":"parameter","displayName":"Keystore","group":"producer","label":"","required":false,"type":"object","javaType":"java.security.KeyStore","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges. A KeyStore is typically used with an alias, either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore, then this single entry will be used."},"keystoreName":{"index":6,"kind":"parameter","displayName":"Keystore Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the reference name for a Keystore that can be found in the registry."},"privateKey":{"index":7,"kind":"parameter","displayName":"Private Key","group":"producer","label":"","required":false,"type":"object","javaType":"java.security.PrivateKey","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the PrivateKey that should be used to sign the exchange"},"privateKeyName":{"index":8,"kind":"parameter","displayName":"Private Key Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the reference name for a PrivateKey that can be found in the registry."},"provider":{"index":9,"kind":"parameter","displayName":"Provider","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the id of the security provider that provides the configured Signature algorithm."},"publicKeyName":{"index":10,"kind":"parameter","displayName":"Public Key Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"references that should be resolved when the context changes"},"secureRandomName":{"index":11,"kind":"parameter","displayName":"Secure Random Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the reference name for a SecureRandom that can be found in the registry."},"signatureHeaderName":{"index":12,"kind":"parameter","displayName":"Signature Header Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the name of the message header that should be used to store the base64 encoded signature. This defaults to 'CamelDigitalSignature'"},"lazyStartProducer":{"index":13,"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."},"bufferSize":{"index":14,"kind":"parameter","displayName":"Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2048","configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the size of the buffer used to read in the Exchange payload data."},"certificate":{"index":15,"kind":"parameter","displayName":"Certificate","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.security.cert.Certificate","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the Certificate that should be used to verify the signature in the exchange based on its payload."},"clearHeaders":{"index":16,"kind":"parameter","displayName":"Clear Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Determines if the Signature specific headers be cleared after signing and verification. Defaults to true, and should only be made otherwise at your extreme peril as vital private information such as Keys and passwords may escape if unset."},"keyStoreParameters":{"index":17,"kind":"parameter","displayName":"Key Store Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.KeyStoreParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges based on the given KeyStoreParameters. A KeyStore is typically used with an alias, either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore, then this single entry will be used."},"publicKey":{"index":18,"kind":"parameter","displayName":"Public Key","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.security.PublicKey","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the PublicKey that should be used to verify the signature in the exchange."},"secureRandom":{"index":19,"kind":"parameter","displayName":"Secure Random","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.security.SecureRandom","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Set the SecureRandom used to initialize the Signature service"},"password":{"index":20,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.crypto.DigitalSignatureConfiguration","configurationField":"configuration","description":"Sets the password used to access an aliased PrivateKey in the KeyStore."}}} , -{"component":{"kind":"component","name":"cxf","title":"CXF","description":"Expose SOAP WebServices using Apache CXF or connect to external WebServices using CXF WS client.","deprecated":false,"firstVersion":"1.0.0","label":"http,webservice","javaType":"org.apache.camel.component.cxf.jaxws.CxfComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-cxf-soap","version":"4.8.1","scheme":"cxf","extendsScheme":"","syntax":"cxf:beanId:address","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"operationName":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the operation.","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#OPERATION_NAME"},"operationNamespace":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation namespace.","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#OPERATION_NAMESPACE"},"CamelDestinationOverrideUrl":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The destination override url","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#DESTINATION_OVERRIDE_URL"},"ResponseContext":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response context","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#RESPONSE_CONTEXT"},"CamelAuthentication":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"javax.security.auth.Subject","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The authentication","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#AUTHENTICATION"},"RequestContext":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request context","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#REQUEST_CONTEXT"}},"properties":{"beanId":{"index":0,"kind":"path","displayName":"Bean Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To lookup an existing configured CxfEndpoint. Must used bean: as prefix."},"address":{"index":1,"kind":"path","displayName":"Address","group":"service","label":"service","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The service publish address."},"dataFormat":{"index":2,"kind":"parameter","displayName":"Data Format","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.cxf.common.DataFormat","enum":["PAYLOAD","RAW","MESSAGE","CXF_MESSAGE","POJO"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"POJO","description":"The data type messages supported by the CXF endpoint."},"wrappedStyle":{"index":3,"kind":"parameter","displayName":"Wrapped Style","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"The WSDL style that describes how parameters are represented in the SOAP body. If the value is false, CXF will chose the document-literal unwrapped style, If the value is true, CXF will chose the document-literal wrapped style"},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"cookieHandler":{"index":7,"kind":"parameter","displayName":"Cookie Handler","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.http.base.cookie.CookieHandler","deprecated":false,"autowired":false,"secret":false,"description":"Configure a cookie handler to maintain a HTTP session"},"defaultOperationName":{"index":8,"kind":"parameter","displayName":"Default Operation Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option will set the default operationName that will be used by the CxfProducer which invokes the remote service."},"defaultOperationNamespace":{"index":9,"kind":"parameter","displayName":"Default Operation Namespace","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service."},"hostnameVerifier":{"index":10,"kind":"parameter","displayName":"Hostname Verifier","group":"producer","label":"producer","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"description":"The hostname verifier to be used. Use the # notation to reference a HostnameVerifier from the registry."},"sslContextParameters":{"index":11,"kind":"parameter","displayName":"Ssl Context Parameters","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"The Camel SSL setting reference. Use the # notation to reference the SSL Context."},"wrapped":{"index":12,"kind":"parameter","displayName":"Wrapped","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Which kind of operation that CXF endpoint producer will invoke"},"lazyStartProducer":{"index":13,"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."},"synchronous":{"index":14,"kind":"parameter","displayName":"Synchronous","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"allowStreaming":{"index":15,"kind":"parameter","displayName":"Allow Streaming","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"This option controls whether the CXF component, when running in PAYLOAD mode, will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases."},"bus":{"index":16,"kind":"parameter","displayName":"Bus","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.cxf.Bus","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom configured CXF Bus."},"continuationTimeout":{"index":17,"kind":"parameter","displayName":"Continuation Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport."},"cxfBinding":{"index":18,"kind":"parameter","displayName":"Cxf Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.cxf.common.CxfBinding","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom CxfBinding to control the binding between Camel Message and CXF Message."},"cxfConfigurer":{"index":19,"kind":"parameter","displayName":"Cxf Configurer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.cxf.jaxws.CxfConfigurer","deprecated":false,"autowired":false,"secret":false,"description":"This option could apply the implementation of org.apache.camel.component.cxf.CxfEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configure{ServerClient} method of CxfEndpointConfigurer."},"defaultBus":{"index":20,"kind":"parameter","displayName":"Default Bus","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will set the default bus when CXF endpoint create a bus by itself"},"headerFilterStrategy":{"index":21,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"mergeProtocolHeaders":{"index":22,"kind":"parameter","displayName":"Merge Protocol Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to merge protocol headers. If enabled then propagating headers between Camel and CXF becomes more consistent and similar. For more details see CAMEL-6393."},"mtomEnabled":{"index":23,"kind":"parameter","displayName":"Mtom Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode."},"properties":{"index":24,"kind":"parameter","displayName":"Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"properties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To set additional CXF options using the key/value pairs from the Map. For example to turn on stacktraces in SOAP faults, properties.faultStackTraceEnabled=true"},"schemaValidationEnabled":{"index":25,"kind":"parameter","displayName":"Schema Validation Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Enable schema validation for request and response. Disabled by default for performance reason"},"skipPayloadMessagePartCheck":{"index":26,"kind":"parameter","displayName":"Skip Payload Message Part Check","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether SOAP message validation should be disabled."},"loggingFeatureEnabled":{"index":27,"kind":"parameter","displayName":"Logging Feature Enabled","group":"logging","label":"logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log."},"loggingSizeLimit":{"index":28,"kind":"parameter","displayName":"Logging Size Limit","group":"logging","label":"logging","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":49152,"description":"To limit the total size of number of bytes the logger will output when logging feature has been enabled and -1 for no limit."},"skipFaultLogging":{"index":29,"kind":"parameter","displayName":"Skip Fault Logging","group":"logging","label":"logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches."},"password":{"index":30,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"This option is used to set the basic authentication information of password for the CXF client."},"username":{"index":31,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"This option is used to set the basic authentication information of username for the CXF client."},"bindingId":{"index":32,"kind":"parameter","displayName":"Binding Id","group":"service","label":"service","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The bindingId for the service model to use."},"portName":{"index":33,"kind":"parameter","displayName":"Port Name","group":"service","label":"service","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The endpoint name this service is implementing, it maps to the wsdl:portname. In the format of ns:PORT_NAME where ns is a namespace prefix valid at this scope."},"publishedEndpointUrl":{"index":34,"kind":"parameter","displayName":"Published Endpoint Url","group":"service","label":"service","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus wsd"},"serviceClass":{"index":35,"kind":"parameter","displayName":"Service Class","group":"service","label":"service","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not."},"serviceName":{"index":36,"kind":"parameter","displayName":"Service Name","group":"service","label":"service","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The service name this service is implementing, it maps to the wsdl:servicename."},"wsdlURL":{"index":37,"kind":"parameter","displayName":"Wsdl URL","group":"service","label":"service","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The location of the WSDL. Can be on the classpath, file system, or be hosted remotely."}}} +{"component":{"kind":"component","name":"cxf","title":"CXF","description":"Expose SOAP WebServices using Apache CXF or connect to external WebServices using CXF WS client.","deprecated":false,"firstVersion":"1.0.0","label":"http,webservice","javaType":"org.apache.camel.component.cxf.jaxws.CxfComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-cxf-soap","version":"4.8.2","scheme":"cxf","extendsScheme":"","syntax":"cxf:beanId:address","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"operationName":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the operation.","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#OPERATION_NAME"},"operationNamespace":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation namespace.","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#OPERATION_NAMESPACE"},"CamelDestinationOverrideUrl":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The destination override url","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#DESTINATION_OVERRIDE_URL"},"ResponseContext":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response context","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#RESPONSE_CONTEXT"},"CamelAuthentication":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"javax.security.auth.Subject","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The authentication","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#AUTHENTICATION"},"RequestContext":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request context","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#REQUEST_CONTEXT"}},"properties":{"beanId":{"index":0,"kind":"path","displayName":"Bean Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To lookup an existing configured CxfEndpoint. Must used bean: as prefix."},"address":{"index":1,"kind":"path","displayName":"Address","group":"service","label":"service","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The service publish address."},"dataFormat":{"index":2,"kind":"parameter","displayName":"Data Format","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.cxf.common.DataFormat","enum":["PAYLOAD","RAW","MESSAGE","CXF_MESSAGE","POJO"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"POJO","description":"The data type messages supported by the CXF endpoint."},"wrappedStyle":{"index":3,"kind":"parameter","displayName":"Wrapped Style","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"The WSDL style that describes how parameters are represented in the SOAP body. If the value is false, CXF will chose the document-literal unwrapped style, If the value is true, CXF will chose the document-literal wrapped style"},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"cookieHandler":{"index":7,"kind":"parameter","displayName":"Cookie Handler","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.http.base.cookie.CookieHandler","deprecated":false,"autowired":false,"secret":false,"description":"Configure a cookie handler to maintain a HTTP session"},"defaultOperationName":{"index":8,"kind":"parameter","displayName":"Default Operation Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option will set the default operationName that will be used by the CxfProducer which invokes the remote service."},"defaultOperationNamespace":{"index":9,"kind":"parameter","displayName":"Default Operation Namespace","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service."},"hostnameVerifier":{"index":10,"kind":"parameter","displayName":"Hostname Verifier","group":"producer","label":"producer","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"description":"The hostname verifier to be used. Use the # notation to reference a HostnameVerifier from the registry."},"sslContextParameters":{"index":11,"kind":"parameter","displayName":"Ssl Context Parameters","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"The Camel SSL setting reference. Use the # notation to reference the SSL Context."},"wrapped":{"index":12,"kind":"parameter","displayName":"Wrapped","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Which kind of operation that CXF endpoint producer will invoke"},"lazyStartProducer":{"index":13,"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."},"synchronous":{"index":14,"kind":"parameter","displayName":"Synchronous","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"allowStreaming":{"index":15,"kind":"parameter","displayName":"Allow Streaming","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"This option controls whether the CXF component, when running in PAYLOAD mode, will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases."},"bus":{"index":16,"kind":"parameter","displayName":"Bus","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.cxf.Bus","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom configured CXF Bus."},"continuationTimeout":{"index":17,"kind":"parameter","displayName":"Continuation Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport."},"cxfBinding":{"index":18,"kind":"parameter","displayName":"Cxf Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.cxf.common.CxfBinding","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom CxfBinding to control the binding between Camel Message and CXF Message."},"cxfConfigurer":{"index":19,"kind":"parameter","displayName":"Cxf Configurer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.cxf.jaxws.CxfConfigurer","deprecated":false,"autowired":false,"secret":false,"description":"This option could apply the implementation of org.apache.camel.component.cxf.CxfEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configure{ServerClient} method of CxfEndpointConfigurer."},"defaultBus":{"index":20,"kind":"parameter","displayName":"Default Bus","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will set the default bus when CXF endpoint create a bus by itself"},"headerFilterStrategy":{"index":21,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"mergeProtocolHeaders":{"index":22,"kind":"parameter","displayName":"Merge Protocol Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to merge protocol headers. If enabled then propagating headers between Camel and CXF becomes more consistent and similar. For more details see CAMEL-6393."},"mtomEnabled":{"index":23,"kind":"parameter","displayName":"Mtom Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode."},"properties":{"index":24,"kind":"parameter","displayName":"Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"properties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To set additional CXF options using the key/value pairs from the Map. For example to turn on stacktraces in SOAP faults, properties.faultStackTraceEnabled=true"},"schemaValidationEnabled":{"index":25,"kind":"parameter","displayName":"Schema Validation Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Enable schema validation for request and response. Disabled by default for performance reason"},"skipPayloadMessagePartCheck":{"index":26,"kind":"parameter","displayName":"Skip Payload Message Part Check","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether SOAP message validation should be disabled."},"loggingFeatureEnabled":{"index":27,"kind":"parameter","displayName":"Logging Feature Enabled","group":"logging","label":"logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log."},"loggingSizeLimit":{"index":28,"kind":"parameter","displayName":"Logging Size Limit","group":"logging","label":"logging","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":49152,"description":"To limit the total size of number of bytes the logger will output when logging feature has been enabled and -1 for no limit."},"skipFaultLogging":{"index":29,"kind":"parameter","displayName":"Skip Fault Logging","group":"logging","label":"logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches."},"password":{"index":30,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"This option is used to set the basic authentication information of password for the CXF client."},"username":{"index":31,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"This option is used to set the basic authentication information of username for the CXF client."},"bindingId":{"index":32,"kind":"parameter","displayName":"Binding Id","group":"service","label":"service","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The bindingId for the service model to use."},"portName":{"index":33,"kind":"parameter","displayName":"Port Name","group":"service","label":"service","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The endpoint name this service is implementing, it maps to the wsdl:portname. In the format of ns:PORT_NAME where ns is a namespace prefix valid at this scope."},"publishedEndpointUrl":{"index":34,"kind":"parameter","displayName":"Published Endpoint Url","group":"service","label":"service","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus wsd"},"serviceClass":{"index":35,"kind":"parameter","displayName":"Service Class","group":"service","label":"service","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not."},"serviceName":{"index":36,"kind":"parameter","displayName":"Service Name","group":"service","label":"service","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The service name this service is implementing, it maps to the wsdl:servicename."},"wsdlURL":{"index":37,"kind":"parameter","displayName":"Wsdl URL","group":"service","label":"service","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The location of the WSDL. Can be on the classpath, file system, or be hosted remotely."}}} , -{"component":{"kind":"component","name":"cxfrs","title":"CXF-RS","description":"Expose JAX-RS REST services using Apache CXF or connect to external REST services using CXF REST client.","deprecated":false,"firstVersion":"2.0.0","label":"rest","javaType":"org.apache.camel.component.cxf.jaxrs.CxfRsComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-cxf-rest","version":"4.8.1","scheme":"cxfrs","extendsScheme":"","syntax":"cxfrs:beanId:address","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"operationName":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the operation.","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#OPERATION_NAME"},"CamelAuthentication":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"javax.security.auth.Subject","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The authentication","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#AUTHENTICATION"},"CamelHttpMethod":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http method to use","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#HTTP_METHOD"},"CamelHttpPath":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http path","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#HTTP_PATH"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CONTENT_TYPE"},"CamelHttpQuery":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http query","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#HTTP_QUERY"},"CamelHttpResponseCode":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http response code","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#HTTP_RESPONSE_CODE"},"Content-Encoding":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content encoding","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CONTENT_ENCODING"},"org.apache.cxf.message.Message.PROTOCOL_HEADERS":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The protocol headers","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#PROTOCOL_HEADERS"},"CamelCxfMessage":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.cxf.message.Message","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CXF message","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_MESSAGE"},"CamelCxfRsUsingHttpAPI":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If it is true, the CxfRsProducer will use the HttpClientAPI to invoke the service. If it is false, the CxfRsProducer will use the ProxyClientAPI to invoke the service","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_RS_USING_HTTP_API"},"CamelCxfRsVarValues":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The path values","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_RS_VAR_VALUES"},"CamelCxfRsResponseClass":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response class","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_RS_RESPONSE_CLASS"},"CamelCxfRsResponseGenericType":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Type","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response generic type","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_RS_RESPONSE_GENERIC_TYPE"},"CamelCxfRsQueryMap":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query map","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_RS_QUERY_MAP"},"CamelCxfRsOperationResourceInfoStack":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.cxf.jaxrs.model.OperationResourceInfoStack","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The stack of MethodInvocationInfo representing resources path when JAX-RS invocation looks for target.","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_RS_OPERATION_RESOURCE_INFO_STACK"}},"properties":{"beanId":{"index":0,"kind":"path","displayName":"Bean Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To lookup an existing configured CxfRsEndpoint. Must used bean: as prefix."},"address":{"index":1,"kind":"path","displayName":"Address","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The service publish address."},"features":{"index":2,"kind":"parameter","displayName":"Features","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"Set the feature list to the CxfRs endpoint."},"modelRef":{"index":3,"kind":"parameter","displayName":"Model Ref","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to specify the model file which is useful for the resource class without annotation. When using this option, then the service class can be omitted, to emulate document-only endpoints"},"providers":{"index":4,"kind":"parameter","displayName":"Providers","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Set custom JAX-RS provider(s) list to the CxfRs endpoint. You can specify a string with a list of providers to lookup in the registy separated by comma."},"resourceClasses":{"index":5,"kind":"parameter","displayName":"Resource Classes","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List>","deprecated":false,"autowired":false,"secret":false,"description":"The resource classes which you want to export as REST service. Multiple classes can be separated by comma."},"schemaLocations":{"index":6,"kind":"parameter","displayName":"Schema Locations","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"Sets the locations of the schema(s) which can be used to validate the incoming XML or JAXB-driven JSON."},"skipFaultLogging":{"index":7,"kind":"parameter","displayName":"Skip Fault Logging","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches."},"bindingStyle":{"index":8,"kind":"parameter","displayName":"Binding Style","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.cxf.jaxrs.BindingStyle","enum":["SimpleConsumer","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","description":"Sets how requests and responses will be mapped to/from Camel. Two values are possible: SimpleConsumer: This binding style processes request parameters, multiparts, etc. and maps them to IN headers, IN attachments and to the message body. It aims to eliminate low-level processing of org.apache.cxf.message.MessageContentsList. It also also adds more flexibility and simplicity to the response mapping. Only available for consumers. Default: The default style. For consumers this passes on a MessageContentsList to the route, requiring low-level processing in the route. This is the traditional binding style, which simply dumps the org.apache.cxf.message.MessageContentsList coming in from the CXF stack onto the IN message body. The user is then responsible for processing it according to the contract defined by the JAX-RS method signature. Custom: allows you to specify a custom binding through the binding option."},"publishedEndpointUrl":{"index":9,"kind":"parameter","displayName":"Published Endpoint Url","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option can override the endpointUrl that published from the WADL which can be accessed with resource address url plus _wadl"},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"serviceBeans":{"index":13,"kind":"parameter","displayName":"Service Beans","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The service beans (the bean ids to lookup in the registry) which you want to export as REST service. Multiple beans can be separated by comma"},"cookieHandler":{"index":14,"kind":"parameter","displayName":"Cookie Handler","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.http.base.cookie.CookieHandler","deprecated":false,"autowired":false,"secret":false,"description":"Configure a cookie handler to maintain a HTTP session"},"hostnameVerifier":{"index":15,"kind":"parameter","displayName":"Hostname Verifier","group":"producer","label":"producer","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"description":"The hostname verifier to be used. Use the # notation to reference a HostnameVerifier from the registry."},"sslContextParameters":{"index":16,"kind":"parameter","displayName":"Ssl Context Parameters","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"The Camel SSL setting reference. Use the # notation to reference the SSL Context."},"throwExceptionOnFailure":{"index":17,"kind":"parameter","displayName":"Throw Exception On Failure","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"This option tells the CxfRsProducer to inspect return codes and will generate an Exception if the return code is larger than 207."},"httpClientAPI":{"index":18,"kind":"parameter","displayName":"Http Client API","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If it is true, the CxfRsProducer will use the HttpClientAPI to invoke the service. If it is false, the CxfRsProducer will use the ProxyClientAPI to invoke the service"},"ignoreDeleteMethodMessageBody":{"index":19,"kind":"parameter","displayName":"Ignore Delete Method Message Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option is used to tell CxfRsProducer to ignore the message body of the DELETE method when using HTTP API."},"lazyStartProducer":{"index":20,"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."},"maxClientCacheSize":{"index":21,"kind":"parameter","displayName":"Max Client Cache Size","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"description":"This option allows you to configure the maximum size of the cache. The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider."},"synchronous":{"index":22,"kind":"parameter","displayName":"Synchronous","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"binding":{"index":23,"kind":"parameter","displayName":"Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.cxf.jaxrs.CxfRsBinding","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom CxfBinding to control the binding between Camel Message and CXF Message."},"bus":{"index":24,"kind":"parameter","displayName":"Bus","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.cxf.Bus","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom configured CXF Bus."},"continuationTimeout":{"index":25,"kind":"parameter","displayName":"Continuation Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport."},"cxfRsConfigurer":{"index":26,"kind":"parameter","displayName":"Cxf Rs Configurer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.cxf.jaxrs.CxfRsConfigurer","deprecated":false,"autowired":false,"secret":false,"description":"This option could apply the implementation of org.apache.camel.component.cxf.jaxrs.CxfRsEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configure{Server/Client} method of CxfEndpointConfigurer."},"defaultBus":{"index":27,"kind":"parameter","displayName":"Default Bus","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will set the default bus when CXF endpoint create a bus by itself"},"headerFilterStrategy":{"index":28,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"performInvocation":{"index":29,"kind":"parameter","displayName":"Perform Invocation","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When the option is true, Camel will perform the invocation of the resource class instance and put the response object into the exchange for further processing."},"propagateContexts":{"index":30,"kind":"parameter","displayName":"Propagate Contexts","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When the option is true, JAXRS UriInfo, HttpHeaders, Request and SecurityContext contexts will be available to custom CXFRS processors as typed Camel exchange properties. These contexts can be used to analyze the current requests using JAX-RS API."},"loggingFeatureEnabled":{"index":31,"kind":"parameter","displayName":"Logging Feature Enabled","group":"logging","label":"logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option enables CXF Logging Feature which writes inbound and outbound REST messages to log."},"loggingSizeLimit":{"index":32,"kind":"parameter","displayName":"Logging Size Limit","group":"logging","label":"logging","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":49152,"description":"To limit the total size of number of bytes the logger will output when logging feature has been enabled and -1 for no limit."}}} +{"component":{"kind":"component","name":"cxfrs","title":"CXF-RS","description":"Expose JAX-RS REST services using Apache CXF or connect to external REST services using CXF REST client.","deprecated":false,"firstVersion":"2.0.0","label":"rest","javaType":"org.apache.camel.component.cxf.jaxrs.CxfRsComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-cxf-rest","version":"4.8.2","scheme":"cxfrs","extendsScheme":"","syntax":"cxfrs:beanId:address","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"operationName":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the operation.","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#OPERATION_NAME"},"CamelAuthentication":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"javax.security.auth.Subject","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The authentication","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#AUTHENTICATION"},"CamelHttpMethod":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http method to use","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#HTTP_METHOD"},"CamelHttpPath":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http path","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#HTTP_PATH"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CONTENT_TYPE"},"CamelHttpQuery":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http query","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#HTTP_QUERY"},"CamelHttpResponseCode":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http response code","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#HTTP_RESPONSE_CODE"},"Content-Encoding":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content encoding","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CONTENT_ENCODING"},"org.apache.cxf.message.Message.PROTOCOL_HEADERS":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The protocol headers","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#PROTOCOL_HEADERS"},"CamelCxfMessage":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.cxf.message.Message","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CXF message","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_MESSAGE"},"CamelCxfRsUsingHttpAPI":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If it is true, the CxfRsProducer will use the HttpClientAPI to invoke the service. If it is false, the CxfRsProducer will use the ProxyClientAPI to invoke the service","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_RS_USING_HTTP_API"},"CamelCxfRsVarValues":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The path values","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_RS_VAR_VALUES"},"CamelCxfRsResponseClass":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response class","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_RS_RESPONSE_CLASS"},"CamelCxfRsResponseGenericType":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Type","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response generic type","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_RS_RESPONSE_GENERIC_TYPE"},"CamelCxfRsQueryMap":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query map","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_RS_QUERY_MAP"},"CamelCxfRsOperationResourceInfoStack":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.cxf.jaxrs.model.OperationResourceInfoStack","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The stack of MethodInvocationInfo representing resources path when JAX-RS invocation looks for target.","constantName":"org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_RS_OPERATION_RESOURCE_INFO_STACK"}},"properties":{"beanId":{"index":0,"kind":"path","displayName":"Bean Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To lookup an existing configured CxfRsEndpoint. Must used bean: as prefix."},"address":{"index":1,"kind":"path","displayName":"Address","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The service publish address."},"features":{"index":2,"kind":"parameter","displayName":"Features","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"Set the feature list to the CxfRs endpoint."},"modelRef":{"index":3,"kind":"parameter","displayName":"Model Ref","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to specify the model file which is useful for the resource class without annotation. When using this option, then the service class can be omitted, to emulate document-only endpoints"},"providers":{"index":4,"kind":"parameter","displayName":"Providers","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Set custom JAX-RS provider(s) list to the CxfRs endpoint. You can specify a string with a list of providers to lookup in the registy separated by comma."},"resourceClasses":{"index":5,"kind":"parameter","displayName":"Resource Classes","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List>","deprecated":false,"autowired":false,"secret":false,"description":"The resource classes which you want to export as REST service. Multiple classes can be separated by comma."},"schemaLocations":{"index":6,"kind":"parameter","displayName":"Schema Locations","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"Sets the locations of the schema(s) which can be used to validate the incoming XML or JAXB-driven JSON."},"skipFaultLogging":{"index":7,"kind":"parameter","displayName":"Skip Fault Logging","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches."},"bindingStyle":{"index":8,"kind":"parameter","displayName":"Binding Style","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.cxf.jaxrs.BindingStyle","enum":["SimpleConsumer","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","description":"Sets how requests and responses will be mapped to/from Camel. Two values are possible: SimpleConsumer: This binding style processes request parameters, multiparts, etc. and maps them to IN headers, IN attachments and to the message body. It aims to eliminate low-level processing of org.apache.cxf.message.MessageContentsList. It also also adds more flexibility and simplicity to the response mapping. Only available for consumers. Default: The default style. For consumers this passes on a MessageContentsList to the route, requiring low-level processing in the route. This is the traditional binding style, which simply dumps the org.apache.cxf.message.MessageContentsList coming in from the CXF stack onto the IN message body. The user is then responsible for processing it according to the contract defined by the JAX-RS method signature. Custom: allows you to specify a custom binding through the binding option."},"publishedEndpointUrl":{"index":9,"kind":"parameter","displayName":"Published Endpoint Url","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option can override the endpointUrl that published from the WADL which can be accessed with resource address url plus _wadl"},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"serviceBeans":{"index":13,"kind":"parameter","displayName":"Service Beans","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The service beans (the bean ids to lookup in the registry) which you want to export as REST service. Multiple beans can be separated by comma"},"cookieHandler":{"index":14,"kind":"parameter","displayName":"Cookie Handler","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.http.base.cookie.CookieHandler","deprecated":false,"autowired":false,"secret":false,"description":"Configure a cookie handler to maintain a HTTP session"},"hostnameVerifier":{"index":15,"kind":"parameter","displayName":"Hostname Verifier","group":"producer","label":"producer","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"description":"The hostname verifier to be used. Use the # notation to reference a HostnameVerifier from the registry."},"sslContextParameters":{"index":16,"kind":"parameter","displayName":"Ssl Context Parameters","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"The Camel SSL setting reference. Use the # notation to reference the SSL Context."},"throwExceptionOnFailure":{"index":17,"kind":"parameter","displayName":"Throw Exception On Failure","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"This option tells the CxfRsProducer to inspect return codes and will generate an Exception if the return code is larger than 207."},"httpClientAPI":{"index":18,"kind":"parameter","displayName":"Http Client API","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If it is true, the CxfRsProducer will use the HttpClientAPI to invoke the service. If it is false, the CxfRsProducer will use the ProxyClientAPI to invoke the service"},"ignoreDeleteMethodMessageBody":{"index":19,"kind":"parameter","displayName":"Ignore Delete Method Message Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option is used to tell CxfRsProducer to ignore the message body of the DELETE method when using HTTP API."},"lazyStartProducer":{"index":20,"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."},"maxClientCacheSize":{"index":21,"kind":"parameter","displayName":"Max Client Cache Size","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"description":"This option allows you to configure the maximum size of the cache. The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider."},"synchronous":{"index":22,"kind":"parameter","displayName":"Synchronous","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"binding":{"index":23,"kind":"parameter","displayName":"Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.cxf.jaxrs.CxfRsBinding","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom CxfBinding to control the binding between Camel Message and CXF Message."},"bus":{"index":24,"kind":"parameter","displayName":"Bus","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.cxf.Bus","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom configured CXF Bus."},"continuationTimeout":{"index":25,"kind":"parameter","displayName":"Continuation Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport."},"cxfRsConfigurer":{"index":26,"kind":"parameter","displayName":"Cxf Rs Configurer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.cxf.jaxrs.CxfRsConfigurer","deprecated":false,"autowired":false,"secret":false,"description":"This option could apply the implementation of org.apache.camel.component.cxf.jaxrs.CxfRsEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configure{Server/Client} method of CxfEndpointConfigurer."},"defaultBus":{"index":27,"kind":"parameter","displayName":"Default Bus","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will set the default bus when CXF endpoint create a bus by itself"},"headerFilterStrategy":{"index":28,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"performInvocation":{"index":29,"kind":"parameter","displayName":"Perform Invocation","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When the option is true, Camel will perform the invocation of the resource class instance and put the response object into the exchange for further processing."},"propagateContexts":{"index":30,"kind":"parameter","displayName":"Propagate Contexts","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When the option is true, JAXRS UriInfo, HttpHeaders, Request and SecurityContext contexts will be available to custom CXFRS processors as typed Camel exchange properties. These contexts can be used to analyze the current requests using JAX-RS API."},"loggingFeatureEnabled":{"index":31,"kind":"parameter","displayName":"Logging Feature Enabled","group":"logging","label":"logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option enables CXF Logging Feature which writes inbound and outbound REST messages to log."},"loggingSizeLimit":{"index":32,"kind":"parameter","displayName":"Logging Size Limit","group":"logging","label":"logging","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":49152,"description":"To limit the total size of number of bytes the logger will output when logging feature has been enabled and -1 for no limit."}}} , -{"component":{"kind":"component","name":"dataformat","title":"Data Format","description":"Use a Camel Data Format as a regular Camel Component.","deprecated":false,"firstVersion":"2.12.0","label":"core,transformation","javaType":"org.apache.camel.component.dataformat.DataFormatComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dataformat","version":"4.8.1","scheme":"dataformat","extendsScheme":"","syntax":"dataformat:name:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of data format"},"operation":{"index":1,"kind":"path","displayName":"Operation","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["marshal","unmarshal"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation to use either marshal or unmarshal"},"lazyStartProducer":{"index":2,"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."}}} +{"component":{"kind":"component","name":"dataformat","title":"Data Format","description":"Use a Camel Data Format as a regular Camel Component.","deprecated":false,"firstVersion":"2.12.0","label":"core,transformation","javaType":"org.apache.camel.component.dataformat.DataFormatComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dataformat","version":"4.8.2","scheme":"dataformat","extendsScheme":"","syntax":"dataformat:name:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of data format"},"operation":{"index":1,"kind":"path","displayName":"Operation","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["marshal","unmarshal"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation to use either marshal or unmarshal"},"lazyStartProducer":{"index":2,"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."}}} , -{"component":{"kind":"component","name":"dataset","title":"Dataset","description":"Provide data for load and soak testing of your Camel application.","deprecated":false,"firstVersion":"1.3.0","label":"core,testing","javaType":"org.apache.camel.component.dataset.DataSetComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dataset","version":"4.8.1","scheme":"dataset","extendsScheme":"","syntax":"dataset:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":false},"headers":{"CamelDataSetIndex":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The dataset index","constantName":"org.apache.camel.component.dataset.DataSetConstants#DATASET_INDEX"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.dataset.DataSet","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of DataSet to lookup in the registry"},"dataSetIndex":{"index":1,"kind":"parameter","displayName":"Data Set Index","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["strict","lenient","off"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"lenient","description":"Controls the behaviour of the CamelDataSetIndex header. off (consumer) the header will not be set. strict (consumer) the header will be set. lenient (consumer) the header will be set. off (producer) the header value will not be verified, and will not be set if it is not present. strict (producer) the header value must be present and will be verified. lenient (producer) the header value will be verified if it is present, and will be set if it is not present."},"initialDelay":{"index":2,"kind":"parameter","displayName":"Initial Delay","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Time period in millis to wait before starting sending messages."},"minRate":{"index":3,"kind":"parameter","displayName":"Min Rate","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Wait until the DataSet contains at least this number of messages"},"preloadSize":{"index":4,"kind":"parameter","displayName":"Preload Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Sets how many messages should be preloaded (sent) before the route completes its initialization"},"produceDelay":{"index":5,"kind":"parameter","displayName":"Produce Delay","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3","description":"Allows a delay to be specified which causes a delay when a message is sent by the consumer (to simulate slow processing)"},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"assertPeriod":{"index":9,"kind":"parameter","displayName":"Assert Period","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets a grace period after which the mock endpoint will re-assert to ensure the preliminary assertion is still valid. This is used, for example, to assert that exactly a number of messages arrive. For example, if the expected count was set to 5, then the assertion is satisfied when five or more messages arrive. To ensure that exactly 5 messages arrive, then you would need to wait a little period to ensure no further message arrives. This is what you can use this method for. By default, this period is disabled."},"consumeDelay":{"index":10,"kind":"parameter","displayName":"Consume Delay","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","description":"Allows a delay to be specified which causes a delay when a message is consumed by the producer (to simulate slow processing)"},"expectedCount":{"index":11,"kind":"parameter","displayName":"Expected Count","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies the expected number of message exchanges that should be received by this endpoint. Beware: If you want to expect that 0 messages, then take extra care, as 0 matches when the tests starts, so you need to set a assert period time to let the test run for a while to make sure there are still no messages arrived; for that use setAssertPeriod(long). An alternative is to use NotifyBuilder, and use the notifier to know when Camel is done routing some messages, before you call the assertIsSatisfied() method on the mocks. This allows you to not use a fixed assert period, to speedup testing times. If you want to assert that exactly nth message arrives to this mock endpoint, then see also the setAssertPeriod(long) method for further details."},"failFast":{"index":12,"kind":"parameter","displayName":"Fail Fast","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether assertIsSatisfied() should fail fast at the first detected failed expectation while it may otherwise wait for all expected messages to arrive before performing expectations verifications. Is by default true. Set to false to use behavior as in Camel 2.x."},"log":{"index":13,"kind":"parameter","displayName":"Log","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To turn on logging when the mock receives an incoming message. This will log only one time at INFO level for the incoming message. For more detailed logging then set the logger to DEBUG level for the org.apache.camel.component.mock.MockEndpoint class."},"reportGroup":{"index":14,"kind":"parameter","displayName":"Report Group","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"A number that is used to turn on throughput logging based on groups of the size."},"resultMinimumWaitTime":{"index":15,"kind":"parameter","displayName":"Result Minimum Wait Time","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets the minimum expected amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"},"resultWaitTime":{"index":16,"kind":"parameter","displayName":"Result Wait Time","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets the maximum amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"},"retainFirst":{"index":17,"kind":"parameter","displayName":"Retain First","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies to only retain the first nth number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the first 10 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."},"retainLast":{"index":18,"kind":"parameter","displayName":"Retain Last","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies to only retain the last nth number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the last 20 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."},"sleepForEmptyTest":{"index":19,"kind":"parameter","displayName":"Sleep For Empty Test","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Allows a sleep to be specified to wait to check that this endpoint really is empty when expectedMessageCount(int) is called with zero"},"copyOnExchange":{"index":20,"kind":"parameter","displayName":"Copy On Exchange","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true."},"lazyStartProducer":{"index":21,"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."}}} +{"component":{"kind":"component","name":"dataset","title":"Dataset","description":"Provide data for load and soak testing of your Camel application.","deprecated":false,"firstVersion":"1.3.0","label":"core,testing","javaType":"org.apache.camel.component.dataset.DataSetComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dataset","version":"4.8.2","scheme":"dataset","extendsScheme":"","syntax":"dataset:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":false},"headers":{"CamelDataSetIndex":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The dataset index","constantName":"org.apache.camel.component.dataset.DataSetConstants#DATASET_INDEX"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.dataset.DataSet","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of DataSet to lookup in the registry"},"dataSetIndex":{"index":1,"kind":"parameter","displayName":"Data Set Index","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["strict","lenient","off"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"lenient","description":"Controls the behaviour of the CamelDataSetIndex header. off (consumer) the header will not be set. strict (consumer) the header will be set. lenient (consumer) the header will be set. off (producer) the header value will not be verified, and will not be set if it is not present. strict (producer) the header value must be present and will be verified. lenient (producer) the header value will be verified if it is present, and will be set if it is not present."},"initialDelay":{"index":2,"kind":"parameter","displayName":"Initial Delay","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Time period in millis to wait before starting sending messages."},"minRate":{"index":3,"kind":"parameter","displayName":"Min Rate","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Wait until the DataSet contains at least this number of messages"},"preloadSize":{"index":4,"kind":"parameter","displayName":"Preload Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Sets how many messages should be preloaded (sent) before the route completes its initialization"},"produceDelay":{"index":5,"kind":"parameter","displayName":"Produce Delay","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3","description":"Allows a delay to be specified which causes a delay when a message is sent by the consumer (to simulate slow processing)"},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"assertPeriod":{"index":9,"kind":"parameter","displayName":"Assert Period","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets a grace period after which the mock endpoint will re-assert to ensure the preliminary assertion is still valid. This is used, for example, to assert that exactly a number of messages arrive. For example, if the expected count was set to 5, then the assertion is satisfied when five or more messages arrive. To ensure that exactly 5 messages arrive, then you would need to wait a little period to ensure no further message arrives. This is what you can use this method for. By default, this period is disabled."},"consumeDelay":{"index":10,"kind":"parameter","displayName":"Consume Delay","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","description":"Allows a delay to be specified which causes a delay when a message is consumed by the producer (to simulate slow processing)"},"expectedCount":{"index":11,"kind":"parameter","displayName":"Expected Count","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies the expected number of message exchanges that should be received by this endpoint. Beware: If you want to expect that 0 messages, then take extra care, as 0 matches when the tests starts, so you need to set a assert period time to let the test run for a while to make sure there are still no messages arrived; for that use setAssertPeriod(long). An alternative is to use NotifyBuilder, and use the notifier to know when Camel is done routing some messages, before you call the assertIsSatisfied() method on the mocks. This allows you to not use a fixed assert period, to speedup testing times. If you want to assert that exactly nth message arrives to this mock endpoint, then see also the setAssertPeriod(long) method for further details."},"failFast":{"index":12,"kind":"parameter","displayName":"Fail Fast","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether assertIsSatisfied() should fail fast at the first detected failed expectation while it may otherwise wait for all expected messages to arrive before performing expectations verifications. Is by default true. Set to false to use behavior as in Camel 2.x."},"log":{"index":13,"kind":"parameter","displayName":"Log","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To turn on logging when the mock receives an incoming message. This will log only one time at INFO level for the incoming message. For more detailed logging then set the logger to DEBUG level for the org.apache.camel.component.mock.MockEndpoint class."},"reportGroup":{"index":14,"kind":"parameter","displayName":"Report Group","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"A number that is used to turn on throughput logging based on groups of the size."},"resultMinimumWaitTime":{"index":15,"kind":"parameter","displayName":"Result Minimum Wait Time","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets the minimum expected amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"},"resultWaitTime":{"index":16,"kind":"parameter","displayName":"Result Wait Time","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets the maximum amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"},"retainFirst":{"index":17,"kind":"parameter","displayName":"Retain First","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies to only retain the first nth number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the first 10 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."},"retainLast":{"index":18,"kind":"parameter","displayName":"Retain Last","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies to only retain the last nth number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the last 20 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."},"sleepForEmptyTest":{"index":19,"kind":"parameter","displayName":"Sleep For Empty Test","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Allows a sleep to be specified to wait to check that this endpoint really is empty when expectedMessageCount(int) is called with zero"},"copyOnExchange":{"index":20,"kind":"parameter","displayName":"Copy On Exchange","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true."},"lazyStartProducer":{"index":21,"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."}}} , -{"component":{"kind":"component","name":"dataset-test","title":"DataSet Test","description":"Extends the mock component by pulling messages from another endpoint on startup to set the expected message bodies.","deprecated":false,"firstVersion":"1.3.0","label":"core,testing","javaType":"org.apache.camel.component.dataset.DataSetTestComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dataset","version":"4.8.1","scheme":"dataset-test","extendsScheme":"","syntax":"dataset-test:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of endpoint to lookup in the registry to use for polling messages used for testing"},"anyOrder":{"index":1,"kind":"parameter","displayName":"Any Order","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the expected messages should arrive in the same order or can be in any order."},"assertPeriod":{"index":2,"kind":"parameter","displayName":"Assert Period","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets a grace period after which the mock endpoint will re-assert to ensure the preliminary assertion is still valid. This is used, for example, to assert that exactly a number of messages arrive. For example, if the expected count was set to 5, then the assertion is satisfied when five or more messages arrive. To ensure that exactly 5 messages arrive, then you would need to wait a little period to ensure no further message arrives. This is what you can use this method for. By default, this period is disabled."},"delimiter":{"index":3,"kind":"parameter","displayName":"Delimiter","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The split delimiter to use when split is enabled. By default the delimiter is new line based. The delimiter can be a regular expression."},"expectedCount":{"index":4,"kind":"parameter","displayName":"Expected Count","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies the expected number of message exchanges that should be received by this endpoint. Beware: If you want to expect that 0 messages, then take extra care, as 0 matches when the tests starts, so you need to set a assert period time to let the test run for a while to make sure there are still no messages arrived; for that use setAssertPeriod(long). An alternative is to use NotifyBuilder, and use the notifier to know when Camel is done routing some messages, before you call the assertIsSatisfied() method on the mocks. This allows you to not use a fixed assert period, to speedup testing times. If you want to assert that exactly nth message arrives to this mock endpoint, then see also the setAssertPeriod(long) method for further details."},"failFast":{"index":5,"kind":"parameter","displayName":"Fail Fast","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether assertIsSatisfied() should fail fast at the first detected failed expectation while it may otherwise wait for all expected messages to arrive before performing expectations verifications. Is by default true. Set to false to use behavior as in Camel 2.x."},"log":{"index":6,"kind":"parameter","displayName":"Log","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To turn on logging when the mock receives an incoming message. This will log only one time at INFO level for the incoming message. For more detailed logging then set the logger to DEBUG level for the org.apache.camel.component.mock.MockEndpoint class."},"reportGroup":{"index":7,"kind":"parameter","displayName":"Report Group","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"A number that is used to turn on throughput logging based on groups of the size."},"resultMinimumWaitTime":{"index":8,"kind":"parameter","displayName":"Result Minimum Wait Time","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets the minimum expected amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"},"resultWaitTime":{"index":9,"kind":"parameter","displayName":"Result Wait Time","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets the maximum amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"},"retainFirst":{"index":10,"kind":"parameter","displayName":"Retain First","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies to only retain the first nth number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the first 10 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."},"retainLast":{"index":11,"kind":"parameter","displayName":"Retain Last","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies to only retain the last nth number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the last 20 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."},"sleepForEmptyTest":{"index":12,"kind":"parameter","displayName":"Sleep For Empty Test","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Allows a sleep to be specified to wait to check that this endpoint really is empty when expectedMessageCount(int) is called with zero"},"split":{"index":13,"kind":"parameter","displayName":"Split","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled the messages loaded from the test endpoint will be split using new line delimiters so each line is an expected message. For example to use a file endpoint to load a file where each line is an expected message."},"timeout":{"index":14,"kind":"parameter","displayName":"Timeout","group":"producer","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2000","description":"The timeout to use when polling for message bodies from the URI"},"copyOnExchange":{"index":15,"kind":"parameter","displayName":"Copy On Exchange","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true."},"lazyStartProducer":{"index":16,"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."}}} +{"component":{"kind":"component","name":"dataset-test","title":"DataSet Test","description":"Extends the mock component by pulling messages from another endpoint on startup to set the expected message bodies.","deprecated":false,"firstVersion":"1.3.0","label":"core,testing","javaType":"org.apache.camel.component.dataset.DataSetTestComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dataset","version":"4.8.2","scheme":"dataset-test","extendsScheme":"","syntax":"dataset-test:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of endpoint to lookup in the registry to use for polling messages used for testing"},"anyOrder":{"index":1,"kind":"parameter","displayName":"Any Order","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the expected messages should arrive in the same order or can be in any order."},"assertPeriod":{"index":2,"kind":"parameter","displayName":"Assert Period","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets a grace period after which the mock endpoint will re-assert to ensure the preliminary assertion is still valid. This is used, for example, to assert that exactly a number of messages arrive. For example, if the expected count was set to 5, then the assertion is satisfied when five or more messages arrive. To ensure that exactly 5 messages arrive, then you would need to wait a little period to ensure no further message arrives. This is what you can use this method for. By default, this period is disabled."},"delimiter":{"index":3,"kind":"parameter","displayName":"Delimiter","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The split delimiter to use when split is enabled. By default the delimiter is new line based. The delimiter can be a regular expression."},"expectedCount":{"index":4,"kind":"parameter","displayName":"Expected Count","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies the expected number of message exchanges that should be received by this endpoint. Beware: If you want to expect that 0 messages, then take extra care, as 0 matches when the tests starts, so you need to set a assert period time to let the test run for a while to make sure there are still no messages arrived; for that use setAssertPeriod(long). An alternative is to use NotifyBuilder, and use the notifier to know when Camel is done routing some messages, before you call the assertIsSatisfied() method on the mocks. This allows you to not use a fixed assert period, to speedup testing times. If you want to assert that exactly nth message arrives to this mock endpoint, then see also the setAssertPeriod(long) method for further details."},"failFast":{"index":5,"kind":"parameter","displayName":"Fail Fast","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether assertIsSatisfied() should fail fast at the first detected failed expectation while it may otherwise wait for all expected messages to arrive before performing expectations verifications. Is by default true. Set to false to use behavior as in Camel 2.x."},"log":{"index":6,"kind":"parameter","displayName":"Log","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To turn on logging when the mock receives an incoming message. This will log only one time at INFO level for the incoming message. For more detailed logging then set the logger to DEBUG level for the org.apache.camel.component.mock.MockEndpoint class."},"reportGroup":{"index":7,"kind":"parameter","displayName":"Report Group","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"A number that is used to turn on throughput logging based on groups of the size."},"resultMinimumWaitTime":{"index":8,"kind":"parameter","displayName":"Result Minimum Wait Time","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets the minimum expected amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"},"resultWaitTime":{"index":9,"kind":"parameter","displayName":"Result Wait Time","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets the maximum amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"},"retainFirst":{"index":10,"kind":"parameter","displayName":"Retain First","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies to only retain the first nth number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the first 10 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."},"retainLast":{"index":11,"kind":"parameter","displayName":"Retain Last","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies to only retain the last nth number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the last 20 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."},"sleepForEmptyTest":{"index":12,"kind":"parameter","displayName":"Sleep For Empty Test","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Allows a sleep to be specified to wait to check that this endpoint really is empty when expectedMessageCount(int) is called with zero"},"split":{"index":13,"kind":"parameter","displayName":"Split","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled the messages loaded from the test endpoint will be split using new line delimiters so each line is an expected message. For example to use a file endpoint to load a file where each line is an expected message."},"timeout":{"index":14,"kind":"parameter","displayName":"Timeout","group":"producer","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2000","description":"The timeout to use when polling for message bodies from the URI"},"copyOnExchange":{"index":15,"kind":"parameter","displayName":"Copy On Exchange","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true."},"lazyStartProducer":{"index":16,"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."}}} , -{"component":{"kind":"component","name":"debezium-db2","title":"Debezium DB2 Connector","description":"Capture changes from a DB2 database.","deprecated":false,"firstVersion":"3.17.0","label":"database","javaType":"org.apache.camel.component.debezium.DebeziumDb2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-debezium-db2","version":"4.8.1","scheme":"debezium-db2","extendsScheme":"","syntax":"debezium-db2:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelDebeziumSourceMetadata":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_SOURCE_METADATA"},"CamelDebeziumIdentifier":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The identifier of the connector, normally is this format {server-name}.{database-name}.{table-name}.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_IDENTIFIER"},"CamelDebeziumKey":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the event, normally is the table Primary Key.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_KEY"},"CamelDebeziumOperation":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r for read (in the case of a initial sync) or in case of a snapshot event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_OPERATION"},"CamelDebeziumTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the time (using the system clock in the JVM) at which the connector processed the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_TIMESTAMP"},"CamelDebeziumBefore":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, contains the state of the row before the event occurred.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_BEFORE"},"CamelDebeziumDdlSQL":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the ddl sql text of the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_DDL_SQL"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Unique name for the connector. Attempting to register again with the same name will fail."},"additionalProperties":{"index":1,"kind":"parameter","displayName":"Additional Properties","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.Map","prefix":"additionalProperties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro"},"internalKeyConverter":{"index":2,"kind":"parameter","displayName":"Internal Key Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter."},"internalValueConverter":{"index":3,"kind":"parameter","displayName":"Internal Value Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter."},"offsetCommitPolicy":{"index":4,"kind":"parameter","displayName":"Offset Commit Policy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals."},"offsetCommitTimeoutMs":{"index":5,"kind":"parameter","displayName":"Offset Commit Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds."},"offsetFlushIntervalMs":{"index":6,"kind":"parameter","displayName":"Offset Flush Interval Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval at which to try committing offsets. The default is 1 minute."},"offsetStorage":{"index":7,"kind":"parameter","displayName":"Offset Storage","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.storage.FileOffsetBackingStore","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class that is responsible for persistence of connector offsets."},"offsetStorageFileName":{"index":8,"kind":"parameter","displayName":"Offset Storage File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore."},"offsetStoragePartitions":{"index":9,"kind":"parameter","displayName":"Offset Storage Partitions","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'."},"offsetStorageReplicationFactor":{"index":10,"kind":"parameter","displayName":"Offset Storage Replication Factor","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore"},"offsetStorageTopic":{"index":11,"kind":"parameter","displayName":"Offset Storage Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"cdcChangeTablesSchema":{"index":15,"kind":"parameter","displayName":"Cdc Change Tables Schema","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ASNCDC","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the schema where CDC change tables are located; defaults to 'ASNCDC'"},"cdcControlSchema":{"index":16,"kind":"parameter","displayName":"Cdc Control Schema","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ASNCDC","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the schema where CDC control structures are located; defaults to 'ASNCDC'"},"columnExcludeList":{"index":17,"kind":"parameter","displayName":"Column Exclude List","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to exclude from change events"},"columnIncludeList":{"index":18,"kind":"parameter","displayName":"Column Include List","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to include in change events"},"columnPropagateSourceType":{"index":19,"kind":"parameter","displayName":"Column Propagate Source Type","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records."},"converters":{"index":20,"kind":"parameter","displayName":"Converters","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'"},"customMetricTags":{"index":21,"kind":"parameter","displayName":"Custom Metric Tags","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2"},"databaseDbname":{"index":22,"kind":"parameter","displayName":"Database Dbname","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the database from which the connector should capture changes"},"databaseHostname":{"index":23,"kind":"parameter","displayName":"Database Hostname","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Resolvable hostname or IP address of the database server."},"databasePassword":{"index":24,"kind":"parameter","displayName":"Database Password","group":"db2","label":"consumer,db2","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Password of the database user to be used when connecting to the database."},"databasePort":{"index":25,"kind":"parameter","displayName":"Database Port","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":50000,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Port of the database server."},"databaseUser":{"index":26,"kind":"parameter","displayName":"Database User","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Name of the database user to be used when connecting to the database."},"datatypePropagateSourceType":{"index":27,"kind":"parameter","displayName":"Datatype Propagate Source Type","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching the database-specific data type names that adds the data type's original type and original length as parameters to the corresponding field schemas in the emitted change records."},"db2Platform":{"index":28,"kind":"parameter","displayName":"Db2 Platform","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"LUW","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Informs connector which Db2 implementation platform it is connected to. The default is 'LUW', which means Windows, UNIX, Linux. Using a value of 'Z' ensures that the Db2 for z/OS specific SQL statements are used."},"decimalHandlingMode":{"index":29,"kind":"parameter","displayName":"Decimal Handling Mode","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"precise","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how DECIMAL and NUMERIC columns should be represented in change events, including: 'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers."},"errorsMaxRetries":{"index":30,"kind":"parameter","displayName":"Errors Max Retries","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries)."},"eventProcessingFailureHandlingMode":{"index":31,"kind":"parameter","displayName":"Event Processing Failure Handling Mode","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped."},"heartbeatIntervalMs":{"index":32,"kind":"parameter","displayName":"Heartbeat Interval Ms","group":"db2","label":"consumer,db2","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default."},"heartbeatTopicsPrefix":{"index":33,"kind":"parameter","displayName":"Heartbeat Topics Prefix","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium-heartbeat","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat."},"includeSchemaChanges":{"index":34,"kind":"parameter","displayName":"Include Schema Changes","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s). The default is 'true'. This is independent of how the connector internally records database schema history."},"incrementalSnapshotChunkSize":{"index":35,"kind":"parameter","displayName":"Incremental Snapshot Chunk Size","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum size of chunk (number of documents/rows) for incremental snapshotting"},"incrementalSnapshotWatermarkingStrategy":{"index":36,"kind":"parameter","displayName":"Incremental Snapshot Watermarking Strategy","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INSERT_INSERT","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;"},"maxBatchSize":{"index":37,"kind":"parameter","displayName":"Max Batch Size","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of each batch of source records. Defaults to 2048."},"maxQueueSize":{"index":38,"kind":"parameter","displayName":"Max Queue Size","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size."},"maxQueueSizeInBytes":{"index":39,"kind":"parameter","displayName":"Max Queue Size In Bytes","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled"},"messageKeyColumns":{"index":40,"kind":"parameter","displayName":"Message Key Columns","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':', where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector, and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key. Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id"},"notificationEnabledChannels":{"index":41,"kind":"parameter","displayName":"Notification Enabled Channels","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of notification channels names that are enabled."},"notificationSinkTopicName":{"index":42,"kind":"parameter","displayName":"Notification Sink Topic Name","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels"},"pollIntervalMs":{"index":43,"kind":"parameter","displayName":"Poll Interval Ms","group":"db2","label":"consumer,db2","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500ms","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms."},"postProcessors":{"index":44,"kind":"parameter","displayName":"Post Processors","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of post processors. The processors are defined using '.type' config option and configured using options ''"},"provideTransactionMetadata":{"index":45,"kind":"parameter","displayName":"Provide Transaction Metadata","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Enables transaction metadata extraction together with event counting"},"queryFetchSize":{"index":46,"kind":"parameter","displayName":"Query Fetch Size","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size. The default value is '10000'."},"retriableRestartConnectorWaitMs":{"index":47,"kind":"parameter","displayName":"Retriable Restart Connector Wait Ms","group":"db2","label":"consumer,db2","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms."},"schemaHistoryInternal":{"index":48,"kind":"parameter","displayName":"Schema History Internal","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.storage.kafka.history.KafkaSchemaHistory","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SchemaHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'schema.history.internal.' string."},"schemaHistoryInternalFileFilename":{"index":49,"kind":"parameter","displayName":"Schema History Internal File Filename","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The path to the file that will be used to record the database schema history"},"schemaHistoryInternalSkipUnparseableDdl":{"index":50,"kind":"parameter","displayName":"Schema History Internal Skip Unparseable Ddl","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes."},"schemaHistoryInternalStoreOnlyCapturedDatabasesDdl":{"index":51,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Databases Ddl","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (true) only DDL that manipulates a table from captured schema/database will be stored. If set to false, then Debezium will store all incoming DDL statements."},"schemaHistoryInternalStoreOnlyCapturedTablesDdl":{"index":52,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Tables Ddl","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a captured table will be stored."},"schemaNameAdjustmentMode":{"index":53,"kind":"parameter","displayName":"Schema Name Adjustment Mode","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)"},"signalDataCollection":{"index":54,"kind":"parameter","displayName":"Signal Data Collection","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set."},"signalEnabledChannels":{"index":55,"kind":"parameter","displayName":"Signal Enabled Channels","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"source","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of channels names that are enabled. Source channel is enabled by default"},"signalPollIntervalMs":{"index":56,"kind":"parameter","displayName":"Signal Poll Interval Ms","group":"db2","label":"consumer,db2","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds."},"skippedOperations":{"index":57,"kind":"parameter","displayName":"Skipped Operations","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"t","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped."},"snapshotDelayMs":{"index":58,"kind":"parameter","displayName":"Snapshot Delay Ms","group":"db2","label":"consumer,db2","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms."},"snapshotFetchSize":{"index":59,"kind":"parameter","displayName":"Snapshot Fetch Size","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while performing a snapshot."},"snapshotIncludeCollectionList":{"index":60,"kind":"parameter","displayName":"Snapshot Include Collection List","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector."},"snapshotLockTimeoutMs":{"index":61,"kind":"parameter","displayName":"Snapshot Lock Timeout Ms","group":"db2","label":"consumer,db2","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds"},"snapshotMode":{"index":62,"kind":"parameter","displayName":"Snapshot Mode","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"initial","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The criteria for running a snapshot upon startup of the connector. Options include: 'initial' (the default) to specify the connector should run a snapshot only when no offsets are available for the logical server name; 'schema_only' to specify the connector should run a snapshot of the schema when no offsets are available for the logical server name."},"snapshotModeConfigurationBasedSnapshotData":{"index":63,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Data","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not."},"snapshotModeConfigurationBasedSnapshotOnDataError":{"index":64,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Data Error","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotOnSchemaError":{"index":65,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Schema Error","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotSchema":{"index":66,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Schema","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not."},"snapshotModeConfigurationBasedStartStream":{"index":67,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Start Stream","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot."},"snapshotModeCustomName":{"index":68,"kind":"parameter","displayName":"Snapshot Mode Custom Name","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot."},"snapshotSelectStatementOverrides":{"index":69,"kind":"parameter","displayName":"Snapshot Select Statement Overrides","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connectors. Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted."},"snapshotTablesOrderByRowCount":{"index":70,"kind":"parameter","displayName":"Snapshot Tables Order By Row Count","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"disabled","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the order in which tables are processed in the initial snapshot. A descending value will order the tables by row count descending. A ascending value will order the tables by row count ascending. A value of disabled (the default) will disable ordering by row count."},"sourceinfoStructMaker":{"index":71,"kind":"parameter","displayName":"Sourceinfo Struct Maker","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.connector.db2.Db2SourceInfoStructMaker","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct."},"streamingDelayMs":{"index":72,"kind":"parameter","displayName":"Streaming Delay Ms","group":"db2","label":"consumer,db2","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms."},"tableExcludeList":{"index":73,"kind":"parameter","displayName":"Table Exclude List","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring"},"tableIgnoreBuiltin":{"index":74,"kind":"parameter","displayName":"Table Ignore Builtin","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Flag specifying whether built-in tables should be ignored."},"tableIncludeList":{"index":75,"kind":"parameter","displayName":"Table Include List","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The tables for which changes are to be captured"},"timePrecisionMode":{"index":76,"kind":"parameter","displayName":"Time Precision Mode","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"adaptive","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time, date, and timestamps can be represented with different kinds of precisions, including: 'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column's precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision; 'connect' always represents time, date, and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision."},"tombstonesOnDelete":{"index":77,"kind":"parameter","displayName":"Tombstones On Delete","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted."},"topicNamingStrategy":{"index":78,"kind":"parameter","displayName":"Topic Naming Strategy","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.schema.SchemaTopicNamingStrategy","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc."},"topicPrefix":{"index":79,"kind":"parameter","displayName":"Topic Prefix","group":"db2","label":"consumer,db2","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted."},"transactionMetadataFactory":{"index":80,"kind":"parameter","displayName":"Transaction Metadata Factory","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory","configurationClass":"org.apache.camel.component.debezium.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Class to make transaction context & transaction struct/schemas"}}} +{"component":{"kind":"component","name":"debezium-db2","title":"Debezium DB2 Connector","description":"Capture changes from a DB2 database.","deprecated":false,"firstVersion":"3.17.0","label":"database","javaType":"org.apache.camel.component.debezium.db2.DebeziumDb2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-debezium-db2","version":"4.8.2","scheme":"debezium-db2","extendsScheme":"","syntax":"debezium-db2:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelDebeziumSourceMetadata":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_SOURCE_METADATA"},"CamelDebeziumIdentifier":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The identifier of the connector, normally is this format {server-name}.{database-name}.{table-name}.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_IDENTIFIER"},"CamelDebeziumKey":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the event, normally is the table Primary Key.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_KEY"},"CamelDebeziumOperation":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r for read (in the case of a initial sync) or in case of a snapshot event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_OPERATION"},"CamelDebeziumTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the time (using the system clock in the JVM) at which the connector processed the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_TIMESTAMP"},"CamelDebeziumBefore":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, contains the state of the row before the event occurred.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_BEFORE"},"CamelDebeziumDdlSQL":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the ddl sql text of the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_DDL_SQL"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Unique name for the connector. Attempting to register again with the same name will fail."},"additionalProperties":{"index":1,"kind":"parameter","displayName":"Additional Properties","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.Map","prefix":"additionalProperties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro"},"internalKeyConverter":{"index":2,"kind":"parameter","displayName":"Internal Key Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter."},"internalValueConverter":{"index":3,"kind":"parameter","displayName":"Internal Value Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter."},"offsetCommitPolicy":{"index":4,"kind":"parameter","displayName":"Offset Commit Policy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals."},"offsetCommitTimeoutMs":{"index":5,"kind":"parameter","displayName":"Offset Commit Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds."},"offsetFlushIntervalMs":{"index":6,"kind":"parameter","displayName":"Offset Flush Interval Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval at which to try committing offsets. The default is 1 minute."},"offsetStorage":{"index":7,"kind":"parameter","displayName":"Offset Storage","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.storage.FileOffsetBackingStore","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class that is responsible for persistence of connector offsets."},"offsetStorageFileName":{"index":8,"kind":"parameter","displayName":"Offset Storage File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore."},"offsetStoragePartitions":{"index":9,"kind":"parameter","displayName":"Offset Storage Partitions","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'."},"offsetStorageReplicationFactor":{"index":10,"kind":"parameter","displayName":"Offset Storage Replication Factor","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore"},"offsetStorageTopic":{"index":11,"kind":"parameter","displayName":"Offset Storage Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"cdcChangeTablesSchema":{"index":15,"kind":"parameter","displayName":"Cdc Change Tables Schema","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ASNCDC","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the schema where CDC change tables are located; defaults to 'ASNCDC'"},"cdcControlSchema":{"index":16,"kind":"parameter","displayName":"Cdc Control Schema","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ASNCDC","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the schema where CDC control structures are located; defaults to 'ASNCDC'"},"columnExcludeList":{"index":17,"kind":"parameter","displayName":"Column Exclude List","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to exclude from change events"},"columnIncludeList":{"index":18,"kind":"parameter","displayName":"Column Include List","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to include in change events"},"columnPropagateSourceType":{"index":19,"kind":"parameter","displayName":"Column Propagate Source Type","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records."},"converters":{"index":20,"kind":"parameter","displayName":"Converters","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'"},"customMetricTags":{"index":21,"kind":"parameter","displayName":"Custom Metric Tags","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2"},"databaseDbname":{"index":22,"kind":"parameter","displayName":"Database Dbname","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the database from which the connector should capture changes"},"databaseHostname":{"index":23,"kind":"parameter","displayName":"Database Hostname","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Resolvable hostname or IP address of the database server."},"databasePassword":{"index":24,"kind":"parameter","displayName":"Database Password","group":"db2","label":"consumer,db2","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Password of the database user to be used when connecting to the database."},"databasePort":{"index":25,"kind":"parameter","displayName":"Database Port","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":50000,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Port of the database server."},"databaseUser":{"index":26,"kind":"parameter","displayName":"Database User","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Name of the database user to be used when connecting to the database."},"datatypePropagateSourceType":{"index":27,"kind":"parameter","displayName":"Datatype Propagate Source Type","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching the database-specific data type names that adds the data type's original type and original length as parameters to the corresponding field schemas in the emitted change records."},"db2Platform":{"index":28,"kind":"parameter","displayName":"Db2 Platform","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"LUW","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Informs connector which Db2 implementation platform it is connected to. The default is 'LUW', which means Windows, UNIX, Linux. Using a value of 'Z' ensures that the Db2 for z/OS specific SQL statements are used."},"decimalHandlingMode":{"index":29,"kind":"parameter","displayName":"Decimal Handling Mode","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"precise","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how DECIMAL and NUMERIC columns should be represented in change events, including: 'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers."},"errorsMaxRetries":{"index":30,"kind":"parameter","displayName":"Errors Max Retries","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries)."},"eventProcessingFailureHandlingMode":{"index":31,"kind":"parameter","displayName":"Event Processing Failure Handling Mode","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped."},"heartbeatIntervalMs":{"index":32,"kind":"parameter","displayName":"Heartbeat Interval Ms","group":"db2","label":"consumer,db2","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default."},"heartbeatTopicsPrefix":{"index":33,"kind":"parameter","displayName":"Heartbeat Topics Prefix","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium-heartbeat","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat."},"includeSchemaChanges":{"index":34,"kind":"parameter","displayName":"Include Schema Changes","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s). The default is 'true'. This is independent of how the connector internally records database schema history."},"incrementalSnapshotChunkSize":{"index":35,"kind":"parameter","displayName":"Incremental Snapshot Chunk Size","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum size of chunk (number of documents/rows) for incremental snapshotting"},"incrementalSnapshotWatermarkingStrategy":{"index":36,"kind":"parameter","displayName":"Incremental Snapshot Watermarking Strategy","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INSERT_INSERT","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;"},"maxBatchSize":{"index":37,"kind":"parameter","displayName":"Max Batch Size","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of each batch of source records. Defaults to 2048."},"maxQueueSize":{"index":38,"kind":"parameter","displayName":"Max Queue Size","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size."},"maxQueueSizeInBytes":{"index":39,"kind":"parameter","displayName":"Max Queue Size In Bytes","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled"},"messageKeyColumns":{"index":40,"kind":"parameter","displayName":"Message Key Columns","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':', where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector, and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key. Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id"},"notificationEnabledChannels":{"index":41,"kind":"parameter","displayName":"Notification Enabled Channels","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of notification channels names that are enabled."},"notificationSinkTopicName":{"index":42,"kind":"parameter","displayName":"Notification Sink Topic Name","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels"},"pollIntervalMs":{"index":43,"kind":"parameter","displayName":"Poll Interval Ms","group":"db2","label":"consumer,db2","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500ms","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms."},"postProcessors":{"index":44,"kind":"parameter","displayName":"Post Processors","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of post processors. The processors are defined using '.type' config option and configured using options ''"},"provideTransactionMetadata":{"index":45,"kind":"parameter","displayName":"Provide Transaction Metadata","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Enables transaction metadata extraction together with event counting"},"queryFetchSize":{"index":46,"kind":"parameter","displayName":"Query Fetch Size","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size. The default value is '10000'."},"retriableRestartConnectorWaitMs":{"index":47,"kind":"parameter","displayName":"Retriable Restart Connector Wait Ms","group":"db2","label":"consumer,db2","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms."},"schemaHistoryInternal":{"index":48,"kind":"parameter","displayName":"Schema History Internal","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.storage.kafka.history.KafkaSchemaHistory","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SchemaHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'schema.history.internal.' string."},"schemaHistoryInternalFileFilename":{"index":49,"kind":"parameter","displayName":"Schema History Internal File Filename","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The path to the file that will be used to record the database schema history"},"schemaHistoryInternalSkipUnparseableDdl":{"index":50,"kind":"parameter","displayName":"Schema History Internal Skip Unparseable Ddl","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes."},"schemaHistoryInternalStoreOnlyCapturedDatabasesDdl":{"index":51,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Databases Ddl","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (true) only DDL that manipulates a table from captured schema/database will be stored. If set to false, then Debezium will store all incoming DDL statements."},"schemaHistoryInternalStoreOnlyCapturedTablesDdl":{"index":52,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Tables Ddl","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a captured table will be stored."},"schemaNameAdjustmentMode":{"index":53,"kind":"parameter","displayName":"Schema Name Adjustment Mode","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)"},"signalDataCollection":{"index":54,"kind":"parameter","displayName":"Signal Data Collection","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set."},"signalEnabledChannels":{"index":55,"kind":"parameter","displayName":"Signal Enabled Channels","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"source","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of channels names that are enabled. Source channel is enabled by default"},"signalPollIntervalMs":{"index":56,"kind":"parameter","displayName":"Signal Poll Interval Ms","group":"db2","label":"consumer,db2","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds."},"skippedOperations":{"index":57,"kind":"parameter","displayName":"Skipped Operations","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"t","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped."},"snapshotDelayMs":{"index":58,"kind":"parameter","displayName":"Snapshot Delay Ms","group":"db2","label":"consumer,db2","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms."},"snapshotFetchSize":{"index":59,"kind":"parameter","displayName":"Snapshot Fetch Size","group":"db2","label":"consumer,db2","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while performing a snapshot."},"snapshotIncludeCollectionList":{"index":60,"kind":"parameter","displayName":"Snapshot Include Collection List","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector."},"snapshotLockTimeoutMs":{"index":61,"kind":"parameter","displayName":"Snapshot Lock Timeout Ms","group":"db2","label":"consumer,db2","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds"},"snapshotMode":{"index":62,"kind":"parameter","displayName":"Snapshot Mode","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"initial","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The criteria for running a snapshot upon startup of the connector. Options include: 'initial' (the default) to specify the connector should run a snapshot only when no offsets are available for the logical server name; 'schema_only' to specify the connector should run a snapshot of the schema when no offsets are available for the logical server name."},"snapshotModeConfigurationBasedSnapshotData":{"index":63,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Data","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not."},"snapshotModeConfigurationBasedSnapshotOnDataError":{"index":64,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Data Error","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotOnSchemaError":{"index":65,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Schema Error","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotSchema":{"index":66,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Schema","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not."},"snapshotModeConfigurationBasedStartStream":{"index":67,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Start Stream","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot."},"snapshotModeCustomName":{"index":68,"kind":"parameter","displayName":"Snapshot Mode Custom Name","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot."},"snapshotSelectStatementOverrides":{"index":69,"kind":"parameter","displayName":"Snapshot Select Statement Overrides","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connectors. Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted."},"snapshotTablesOrderByRowCount":{"index":70,"kind":"parameter","displayName":"Snapshot Tables Order By Row Count","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"disabled","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the order in which tables are processed in the initial snapshot. A descending value will order the tables by row count descending. A ascending value will order the tables by row count ascending. A value of disabled (the default) will disable ordering by row count."},"sourceinfoStructMaker":{"index":71,"kind":"parameter","displayName":"Sourceinfo Struct Maker","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.connector.db2.Db2SourceInfoStructMaker","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct."},"streamingDelayMs":{"index":72,"kind":"parameter","displayName":"Streaming Delay Ms","group":"db2","label":"consumer,db2","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms."},"tableExcludeList":{"index":73,"kind":"parameter","displayName":"Table Exclude List","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring"},"tableIgnoreBuiltin":{"index":74,"kind":"parameter","displayName":"Table Ignore Builtin","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Flag specifying whether built-in tables should be ignored."},"tableIncludeList":{"index":75,"kind":"parameter","displayName":"Table Include List","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The tables for which changes are to be captured"},"timePrecisionMode":{"index":76,"kind":"parameter","displayName":"Time Precision Mode","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"adaptive","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time, date, and timestamps can be represented with different kinds of precisions, including: 'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column's precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision; 'connect' always represents time, date, and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision."},"tombstonesOnDelete":{"index":77,"kind":"parameter","displayName":"Tombstones On Delete","group":"db2","label":"consumer,db2","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted."},"topicNamingStrategy":{"index":78,"kind":"parameter","displayName":"Topic Naming Strategy","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.schema.SchemaTopicNamingStrategy","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc."},"topicPrefix":{"index":79,"kind":"parameter","displayName":"Topic Prefix","group":"db2","label":"consumer,db2","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted."},"transactionMetadataFactory":{"index":80,"kind":"parameter","displayName":"Transaction Metadata Factory","group":"db2","label":"consumer,db2","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory","configurationClass":"org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Class to make transaction context & transaction struct/schemas"}}} , -{"component":{"kind":"component","name":"debezium-mongodb","title":"Debezium MongoDB Connector","description":"Capture changes from a MongoDB database.","deprecated":false,"firstVersion":"3.0.0","label":"database","javaType":"org.apache.camel.component.debezium.DebeziumMongodbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-debezium-mongodb","version":"4.8.1","scheme":"debezium-mongodb","extendsScheme":"","syntax":"debezium-mongodb:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelDebeziumSourceMetadata":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_SOURCE_METADATA"},"CamelDebeziumIdentifier":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The identifier of the connector, normally is this format {server-name}.{database-name}.{table-name}.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_IDENTIFIER"},"CamelDebeziumKey":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the event, normally is the table Primary Key.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_KEY"},"CamelDebeziumOperation":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r for read (in the case of a initial sync) or in case of a snapshot event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_OPERATION"},"CamelDebeziumTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the time (using the system clock in the JVM) at which the connector processed the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_TIMESTAMP"},"CamelDebeziumBefore":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, contains the state of the row before the event occurred.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_BEFORE"},"CamelDebeziumDdlSQL":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the ddl sql text of the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_DDL_SQL"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Unique name for the connector. Attempting to register again with the same name will fail."},"additionalProperties":{"index":1,"kind":"parameter","displayName":"Additional Properties","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.Map","prefix":"additionalProperties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro"},"internalKeyConverter":{"index":2,"kind":"parameter","displayName":"Internal Key Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter."},"internalValueConverter":{"index":3,"kind":"parameter","displayName":"Internal Value Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter."},"offsetCommitPolicy":{"index":4,"kind":"parameter","displayName":"Offset Commit Policy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals."},"offsetCommitTimeoutMs":{"index":5,"kind":"parameter","displayName":"Offset Commit Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds."},"offsetFlushIntervalMs":{"index":6,"kind":"parameter","displayName":"Offset Flush Interval Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval at which to try committing offsets. The default is 1 minute."},"offsetStorage":{"index":7,"kind":"parameter","displayName":"Offset Storage","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.storage.FileOffsetBackingStore","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class that is responsible for persistence of connector offsets."},"offsetStorageFileName":{"index":8,"kind":"parameter","displayName":"Offset Storage File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore."},"offsetStoragePartitions":{"index":9,"kind":"parameter","displayName":"Offset Storage Partitions","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'."},"offsetStorageReplicationFactor":{"index":10,"kind":"parameter","displayName":"Offset Storage Replication Factor","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore"},"offsetStorageTopic":{"index":11,"kind":"parameter","displayName":"Offset Storage Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"captureMode":{"index":15,"kind":"parameter","displayName":"Capture Mode","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"change_streams_update_full","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The method used to capture changes from MongoDB server. Options include: 'change_streams' to capture changes via MongoDB Change Streams, update events do not contain full documents; 'change_streams_update_full' (the default) to capture changes via MongoDB Change Streams, update events contain full documents"},"collectionExcludeList":{"index":16,"kind":"parameter","displayName":"Collection Exclude List","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions or literals that match the collection names for which changes are to be excluded"},"collectionIncludeList":{"index":17,"kind":"parameter","displayName":"Collection Include List","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions or literals that match the collection names for which changes are to be captured"},"converters":{"index":18,"kind":"parameter","displayName":"Converters","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'"},"cursorMaxAwaitTimeMs":{"index":19,"kind":"parameter","displayName":"Cursor Max Await Time Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum processing time in milliseconds to wait for the oplog cursor to process a single poll request"},"customMetricTags":{"index":20,"kind":"parameter","displayName":"Custom Metric Tags","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2"},"databaseExcludeList":{"index":21,"kind":"parameter","displayName":"Database Exclude List","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions or literals that match the database names for which changes are to be excluded"},"databaseIncludeList":{"index":22,"kind":"parameter","displayName":"Database Include List","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions or literals that match the database names for which changes are to be captured"},"errorsMaxRetries":{"index":23,"kind":"parameter","displayName":"Errors Max Retries","group":"mongodb","label":"consumer,mongodb","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries)."},"eventProcessingFailureHandlingMode":{"index":24,"kind":"parameter","displayName":"Event Processing Failure Handling Mode","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped."},"fieldExcludeList":{"index":25,"kind":"parameter","displayName":"Field Exclude List","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of the fully-qualified names of fields that should be excluded from change event message values"},"fieldRenames":{"index":26,"kind":"parameter","displayName":"Field Renames","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of the fully-qualified replacements of fields that should be used to rename fields in change event message values. Fully-qualified replacements for fields are of the form databaseName.collectionName.fieldName.nestedFieldName:newNestedFieldName, where databaseName and collectionName may contain the wildcard () which matches any characters, the colon character (:) is used to determine rename mapping of field."},"heartbeatIntervalMs":{"index":27,"kind":"parameter","displayName":"Heartbeat Interval Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default."},"heartbeatTopicsPrefix":{"index":28,"kind":"parameter","displayName":"Heartbeat Topics Prefix","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium-heartbeat","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat."},"incrementalSnapshotWatermarkingStrategy":{"index":29,"kind":"parameter","displayName":"Incremental Snapshot Watermarking Strategy","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INSERT_INSERT","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;"},"maxBatchSize":{"index":30,"kind":"parameter","displayName":"Max Batch Size","group":"mongodb","label":"consumer,mongodb","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of each batch of source records. Defaults to 2048."},"maxQueueSize":{"index":31,"kind":"parameter","displayName":"Max Queue Size","group":"mongodb","label":"consumer,mongodb","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size."},"maxQueueSizeInBytes":{"index":32,"kind":"parameter","displayName":"Max Queue Size In Bytes","group":"mongodb","label":"consumer,mongodb","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled"},"mongodbAuthsource":{"index":33,"kind":"parameter","displayName":"Mongodb Authsource","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"admin","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Database containing user credentials."},"mongodbConnectionString":{"index":34,"kind":"parameter","displayName":"Mongodb Connection String","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Database connection string."},"mongodbConnectTimeoutMs":{"index":35,"kind":"parameter","displayName":"Mongodb Connect Timeout Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The connection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms)."},"mongodbHeartbeatFrequencyMs":{"index":36,"kind":"parameter","displayName":"Mongodb Heartbeat Frequency Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The frequency that the cluster monitor attempts to reach each server. Defaults to 10 seconds (10,000 ms)."},"mongodbPassword":{"index":37,"kind":"parameter","displayName":"Mongodb Password","group":"mongodb","label":"consumer,mongodb","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Password to be used when connecting to MongoDB, if necessary."},"mongodbPollIntervalMs":{"index":38,"kind":"parameter","displayName":"Mongodb Poll Interval Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30s","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for looking for new, removed, or changed replica sets, given in milliseconds. Defaults to 30 seconds (30,000 ms)."},"mongodbServerSelectionTimeoutMs":{"index":39,"kind":"parameter","displayName":"Mongodb Server Selection Timeout Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30s","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The server selection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms)."},"mongodbSocketTimeoutMs":{"index":40,"kind":"parameter","displayName":"Mongodb Socket Timeout Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The socket timeout, given in milliseconds. Defaults to 0 ms."},"mongodbSslEnabled":{"index":41,"kind":"parameter","displayName":"Mongodb Ssl Enabled","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Should connector use SSL to connect to MongoDB instances"},"mongodbSslInvalidHostnameAllowed":{"index":42,"kind":"parameter","displayName":"Mongodb Ssl Invalid Hostname Allowed","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether invalid host names are allowed when using SSL. If true the connection will not prevent man-in-the-middle attacks"},"mongodbUser":{"index":43,"kind":"parameter","displayName":"Mongodb User","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Database user for connecting to MongoDB, if necessary."},"notificationEnabledChannels":{"index":44,"kind":"parameter","displayName":"Notification Enabled Channels","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of notification channels names that are enabled."},"notificationSinkTopicName":{"index":45,"kind":"parameter","displayName":"Notification Sink Topic Name","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels"},"pollIntervalMs":{"index":46,"kind":"parameter","displayName":"Poll Interval Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500ms","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms."},"postProcessors":{"index":47,"kind":"parameter","displayName":"Post Processors","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of post processors. The processors are defined using '.type' config option and configured using options ''"},"provideTransactionMetadata":{"index":48,"kind":"parameter","displayName":"Provide Transaction Metadata","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Enables transaction metadata extraction together with event counting"},"queryFetchSize":{"index":49,"kind":"parameter","displayName":"Query Fetch Size","group":"mongodb","label":"consumer,mongodb","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size."},"retriableRestartConnectorWaitMs":{"index":50,"kind":"parameter","displayName":"Retriable Restart Connector Wait Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms."},"schemaHistoryInternalFileFilename":{"index":51,"kind":"parameter","displayName":"Schema History Internal File Filename","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The path to the file that will be used to record the database schema history"},"schemaNameAdjustmentMode":{"index":52,"kind":"parameter","displayName":"Schema Name Adjustment Mode","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)"},"signalDataCollection":{"index":53,"kind":"parameter","displayName":"Signal Data Collection","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set."},"signalEnabledChannels":{"index":54,"kind":"parameter","displayName":"Signal Enabled Channels","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"source","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of channels names that are enabled. Source channel is enabled by default"},"signalPollIntervalMs":{"index":55,"kind":"parameter","displayName":"Signal Poll Interval Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds."},"skippedOperations":{"index":56,"kind":"parameter","displayName":"Skipped Operations","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"t","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped."},"snapshotCollectionFilterOverrides":{"index":57,"kind":"parameter","displayName":"Snapshot Collection Filter Overrides","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This property contains a comma-separated list of ., for which the initial snapshot may be a subset of data present in the data source. The subset would be defined by mongodb filter query specified as value for property snapshot.collection.filter.override.."},"snapshotDelayMs":{"index":58,"kind":"parameter","displayName":"Snapshot Delay Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms."},"snapshotFetchSize":{"index":59,"kind":"parameter","displayName":"Snapshot Fetch Size","group":"mongodb","label":"consumer,mongodb","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while performing a snapshot."},"snapshotIncludeCollectionList":{"index":60,"kind":"parameter","displayName":"Snapshot Include Collection List","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector."},"snapshotMaxThreads":{"index":61,"kind":"parameter","displayName":"Snapshot Max Threads","group":"mongodb","label":"consumer,mongodb","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of threads used to perform the snapshot. Defaults to 1."},"snapshotMode":{"index":62,"kind":"parameter","displayName":"Snapshot Mode","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"initial","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the oplog. 'never': The connector does not run a snapshot. Upon first startup, the connector immediately begins reading from the beginning of the oplog."},"snapshotModeConfigurationBasedSnapshotData":{"index":63,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Data","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not."},"snapshotModeConfigurationBasedSnapshotOnDataError":{"index":64,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Data Error","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotOnSchemaError":{"index":65,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Schema Error","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotSchema":{"index":66,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Schema","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not."},"snapshotModeConfigurationBasedStartStream":{"index":67,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Start Stream","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot."},"snapshotModeCustomName":{"index":68,"kind":"parameter","displayName":"Snapshot Mode Custom Name","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot."},"sourceinfoStructMaker":{"index":69,"kind":"parameter","displayName":"Sourceinfo Struct Maker","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.connector.mongodb.MongoDbSourceInfoStructMaker","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct."},"streamingDelayMs":{"index":70,"kind":"parameter","displayName":"Streaming Delay Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms."},"tombstonesOnDelete":{"index":71,"kind":"parameter","displayName":"Tombstones On Delete","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted."},"topicNamingStrategy":{"index":72,"kind":"parameter","displayName":"Topic Naming Strategy","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.schema.SchemaTopicNamingStrategy","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc."},"topicPrefix":{"index":73,"kind":"parameter","displayName":"Topic Prefix","group":"mongodb","label":"consumer,mongodb","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted."},"transactionMetadataFactory":{"index":74,"kind":"parameter","displayName":"Transaction Metadata Factory","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory","configurationClass":"org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Class to make transaction context & transaction struct/schemas"}}} +{"component":{"kind":"component","name":"debezium-mongodb","title":"Debezium MongoDB Connector","description":"Capture changes from a MongoDB database.","deprecated":false,"firstVersion":"3.0.0","label":"database","javaType":"org.apache.camel.component.debezium.mongodb.DebeziumMongodbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-debezium-mongodb","version":"4.8.2","scheme":"debezium-mongodb","extendsScheme":"","syntax":"debezium-mongodb:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelDebeziumSourceMetadata":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_SOURCE_METADATA"},"CamelDebeziumIdentifier":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The identifier of the connector, normally is this format {server-name}.{database-name}.{table-name}.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_IDENTIFIER"},"CamelDebeziumKey":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the event, normally is the table Primary Key.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_KEY"},"CamelDebeziumOperation":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r for read (in the case of a initial sync) or in case of a snapshot event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_OPERATION"},"CamelDebeziumTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the time (using the system clock in the JVM) at which the connector processed the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_TIMESTAMP"},"CamelDebeziumBefore":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, contains the state of the row before the event occurred.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_BEFORE"},"CamelDebeziumDdlSQL":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the ddl sql text of the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_DDL_SQL"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Unique name for the connector. Attempting to register again with the same name will fail."},"additionalProperties":{"index":1,"kind":"parameter","displayName":"Additional Properties","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.Map","prefix":"additionalProperties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro"},"internalKeyConverter":{"index":2,"kind":"parameter","displayName":"Internal Key Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter."},"internalValueConverter":{"index":3,"kind":"parameter","displayName":"Internal Value Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter."},"offsetCommitPolicy":{"index":4,"kind":"parameter","displayName":"Offset Commit Policy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals."},"offsetCommitTimeoutMs":{"index":5,"kind":"parameter","displayName":"Offset Commit Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds."},"offsetFlushIntervalMs":{"index":6,"kind":"parameter","displayName":"Offset Flush Interval Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval at which to try committing offsets. The default is 1 minute."},"offsetStorage":{"index":7,"kind":"parameter","displayName":"Offset Storage","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.storage.FileOffsetBackingStore","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class that is responsible for persistence of connector offsets."},"offsetStorageFileName":{"index":8,"kind":"parameter","displayName":"Offset Storage File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore."},"offsetStoragePartitions":{"index":9,"kind":"parameter","displayName":"Offset Storage Partitions","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'."},"offsetStorageReplicationFactor":{"index":10,"kind":"parameter","displayName":"Offset Storage Replication Factor","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore"},"offsetStorageTopic":{"index":11,"kind":"parameter","displayName":"Offset Storage Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"captureMode":{"index":15,"kind":"parameter","displayName":"Capture Mode","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"change_streams_update_full","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The method used to capture changes from MongoDB server. Options include: 'change_streams' to capture changes via MongoDB Change Streams, update events do not contain full documents; 'change_streams_update_full' (the default) to capture changes via MongoDB Change Streams, update events contain full documents"},"collectionExcludeList":{"index":16,"kind":"parameter","displayName":"Collection Exclude List","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions or literals that match the collection names for which changes are to be excluded"},"collectionIncludeList":{"index":17,"kind":"parameter","displayName":"Collection Include List","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions or literals that match the collection names for which changes are to be captured"},"converters":{"index":18,"kind":"parameter","displayName":"Converters","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'"},"cursorMaxAwaitTimeMs":{"index":19,"kind":"parameter","displayName":"Cursor Max Await Time Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum processing time in milliseconds to wait for the oplog cursor to process a single poll request"},"customMetricTags":{"index":20,"kind":"parameter","displayName":"Custom Metric Tags","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2"},"databaseExcludeList":{"index":21,"kind":"parameter","displayName":"Database Exclude List","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions or literals that match the database names for which changes are to be excluded"},"databaseIncludeList":{"index":22,"kind":"parameter","displayName":"Database Include List","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions or literals that match the database names for which changes are to be captured"},"errorsMaxRetries":{"index":23,"kind":"parameter","displayName":"Errors Max Retries","group":"mongodb","label":"consumer,mongodb","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries)."},"eventProcessingFailureHandlingMode":{"index":24,"kind":"parameter","displayName":"Event Processing Failure Handling Mode","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped."},"fieldExcludeList":{"index":25,"kind":"parameter","displayName":"Field Exclude List","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of the fully-qualified names of fields that should be excluded from change event message values"},"fieldRenames":{"index":26,"kind":"parameter","displayName":"Field Renames","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of the fully-qualified replacements of fields that should be used to rename fields in change event message values. Fully-qualified replacements for fields are of the form databaseName.collectionName.fieldName.nestedFieldName:newNestedFieldName, where databaseName and collectionName may contain the wildcard () which matches any characters, the colon character (:) is used to determine rename mapping of field."},"heartbeatIntervalMs":{"index":27,"kind":"parameter","displayName":"Heartbeat Interval Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default."},"heartbeatTopicsPrefix":{"index":28,"kind":"parameter","displayName":"Heartbeat Topics Prefix","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium-heartbeat","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat."},"incrementalSnapshotWatermarkingStrategy":{"index":29,"kind":"parameter","displayName":"Incremental Snapshot Watermarking Strategy","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INSERT_INSERT","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;"},"maxBatchSize":{"index":30,"kind":"parameter","displayName":"Max Batch Size","group":"mongodb","label":"consumer,mongodb","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of each batch of source records. Defaults to 2048."},"maxQueueSize":{"index":31,"kind":"parameter","displayName":"Max Queue Size","group":"mongodb","label":"consumer,mongodb","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size."},"maxQueueSizeInBytes":{"index":32,"kind":"parameter","displayName":"Max Queue Size In Bytes","group":"mongodb","label":"consumer,mongodb","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled"},"mongodbAuthsource":{"index":33,"kind":"parameter","displayName":"Mongodb Authsource","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"admin","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Database containing user credentials."},"mongodbConnectionString":{"index":34,"kind":"parameter","displayName":"Mongodb Connection String","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Database connection string."},"mongodbConnectTimeoutMs":{"index":35,"kind":"parameter","displayName":"Mongodb Connect Timeout Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The connection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms)."},"mongodbHeartbeatFrequencyMs":{"index":36,"kind":"parameter","displayName":"Mongodb Heartbeat Frequency Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The frequency that the cluster monitor attempts to reach each server. Defaults to 10 seconds (10,000 ms)."},"mongodbPassword":{"index":37,"kind":"parameter","displayName":"Mongodb Password","group":"mongodb","label":"consumer,mongodb","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Password to be used when connecting to MongoDB, if necessary."},"mongodbPollIntervalMs":{"index":38,"kind":"parameter","displayName":"Mongodb Poll Interval Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30s","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for looking for new, removed, or changed replica sets, given in milliseconds. Defaults to 30 seconds (30,000 ms)."},"mongodbServerSelectionTimeoutMs":{"index":39,"kind":"parameter","displayName":"Mongodb Server Selection Timeout Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30s","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The server selection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms)."},"mongodbSocketTimeoutMs":{"index":40,"kind":"parameter","displayName":"Mongodb Socket Timeout Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The socket timeout, given in milliseconds. Defaults to 0 ms."},"mongodbSslEnabled":{"index":41,"kind":"parameter","displayName":"Mongodb Ssl Enabled","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Should connector use SSL to connect to MongoDB instances"},"mongodbSslInvalidHostnameAllowed":{"index":42,"kind":"parameter","displayName":"Mongodb Ssl Invalid Hostname Allowed","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether invalid host names are allowed when using SSL. If true the connection will not prevent man-in-the-middle attacks"},"mongodbUser":{"index":43,"kind":"parameter","displayName":"Mongodb User","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Database user for connecting to MongoDB, if necessary."},"notificationEnabledChannels":{"index":44,"kind":"parameter","displayName":"Notification Enabled Channels","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of notification channels names that are enabled."},"notificationSinkTopicName":{"index":45,"kind":"parameter","displayName":"Notification Sink Topic Name","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels"},"pollIntervalMs":{"index":46,"kind":"parameter","displayName":"Poll Interval Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500ms","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms."},"postProcessors":{"index":47,"kind":"parameter","displayName":"Post Processors","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of post processors. The processors are defined using '.type' config option and configured using options ''"},"provideTransactionMetadata":{"index":48,"kind":"parameter","displayName":"Provide Transaction Metadata","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Enables transaction metadata extraction together with event counting"},"queryFetchSize":{"index":49,"kind":"parameter","displayName":"Query Fetch Size","group":"mongodb","label":"consumer,mongodb","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size."},"retriableRestartConnectorWaitMs":{"index":50,"kind":"parameter","displayName":"Retriable Restart Connector Wait Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms."},"schemaHistoryInternalFileFilename":{"index":51,"kind":"parameter","displayName":"Schema History Internal File Filename","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The path to the file that will be used to record the database schema history"},"schemaNameAdjustmentMode":{"index":52,"kind":"parameter","displayName":"Schema Name Adjustment Mode","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)"},"signalDataCollection":{"index":53,"kind":"parameter","displayName":"Signal Data Collection","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set."},"signalEnabledChannels":{"index":54,"kind":"parameter","displayName":"Signal Enabled Channels","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"source","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of channels names that are enabled. Source channel is enabled by default"},"signalPollIntervalMs":{"index":55,"kind":"parameter","displayName":"Signal Poll Interval Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds."},"skippedOperations":{"index":56,"kind":"parameter","displayName":"Skipped Operations","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"t","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped."},"snapshotCollectionFilterOverrides":{"index":57,"kind":"parameter","displayName":"Snapshot Collection Filter Overrides","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This property contains a comma-separated list of ., for which the initial snapshot may be a subset of data present in the data source. The subset would be defined by mongodb filter query specified as value for property snapshot.collection.filter.override.."},"snapshotDelayMs":{"index":58,"kind":"parameter","displayName":"Snapshot Delay Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms."},"snapshotFetchSize":{"index":59,"kind":"parameter","displayName":"Snapshot Fetch Size","group":"mongodb","label":"consumer,mongodb","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while performing a snapshot."},"snapshotIncludeCollectionList":{"index":60,"kind":"parameter","displayName":"Snapshot Include Collection List","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector."},"snapshotMaxThreads":{"index":61,"kind":"parameter","displayName":"Snapshot Max Threads","group":"mongodb","label":"consumer,mongodb","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of threads used to perform the snapshot. Defaults to 1."},"snapshotMode":{"index":62,"kind":"parameter","displayName":"Snapshot Mode","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"initial","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the oplog. 'never': The connector does not run a snapshot. Upon first startup, the connector immediately begins reading from the beginning of the oplog."},"snapshotModeConfigurationBasedSnapshotData":{"index":63,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Data","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not."},"snapshotModeConfigurationBasedSnapshotOnDataError":{"index":64,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Data Error","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotOnSchemaError":{"index":65,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Schema Error","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotSchema":{"index":66,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Schema","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not."},"snapshotModeConfigurationBasedStartStream":{"index":67,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Start Stream","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot."},"snapshotModeCustomName":{"index":68,"kind":"parameter","displayName":"Snapshot Mode Custom Name","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot."},"sourceinfoStructMaker":{"index":69,"kind":"parameter","displayName":"Sourceinfo Struct Maker","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.connector.mongodb.MongoDbSourceInfoStructMaker","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct."},"streamingDelayMs":{"index":70,"kind":"parameter","displayName":"Streaming Delay Ms","group":"mongodb","label":"consumer,mongodb","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms."},"tombstonesOnDelete":{"index":71,"kind":"parameter","displayName":"Tombstones On Delete","group":"mongodb","label":"consumer,mongodb","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted."},"topicNamingStrategy":{"index":72,"kind":"parameter","displayName":"Topic Naming Strategy","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.schema.SchemaTopicNamingStrategy","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc."},"topicPrefix":{"index":73,"kind":"parameter","displayName":"Topic Prefix","group":"mongodb","label":"consumer,mongodb","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted."},"transactionMetadataFactory":{"index":74,"kind":"parameter","displayName":"Transaction Metadata Factory","group":"mongodb","label":"consumer,mongodb","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory","configurationClass":"org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Class to make transaction context & transaction struct/schemas"}}} , -{"component":{"kind":"component","name":"debezium-mysql","title":"Debezium MySQL Connector","description":"Capture changes from a MySQL database.","deprecated":false,"firstVersion":"3.0.0","label":"database","javaType":"org.apache.camel.component.debezium.DebeziumMySqlComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-debezium-mysql","version":"4.8.1","scheme":"debezium-mysql","extendsScheme":"","syntax":"debezium-mysql:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelDebeziumSourceMetadata":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_SOURCE_METADATA"},"CamelDebeziumIdentifier":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The identifier of the connector, normally is this format {server-name}.{database-name}.{table-name}.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_IDENTIFIER"},"CamelDebeziumKey":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the event, normally is the table Primary Key.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_KEY"},"CamelDebeziumOperation":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r for read (in the case of a initial sync) or in case of a snapshot event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_OPERATION"},"CamelDebeziumTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the time (using the system clock in the JVM) at which the connector processed the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_TIMESTAMP"},"CamelDebeziumBefore":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, contains the state of the row before the event occurred.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_BEFORE"},"CamelDebeziumDdlSQL":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the ddl sql text of the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_DDL_SQL"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Unique name for the connector. Attempting to register again with the same name will fail."},"additionalProperties":{"index":1,"kind":"parameter","displayName":"Additional Properties","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.Map","prefix":"additionalProperties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro"},"internalKeyConverter":{"index":2,"kind":"parameter","displayName":"Internal Key Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter."},"internalValueConverter":{"index":3,"kind":"parameter","displayName":"Internal Value Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter."},"offsetCommitPolicy":{"index":4,"kind":"parameter","displayName":"Offset Commit Policy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals."},"offsetCommitTimeoutMs":{"index":5,"kind":"parameter","displayName":"Offset Commit Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds."},"offsetFlushIntervalMs":{"index":6,"kind":"parameter","displayName":"Offset Flush Interval Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval at which to try committing offsets. The default is 1 minute."},"offsetStorage":{"index":7,"kind":"parameter","displayName":"Offset Storage","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.storage.FileOffsetBackingStore","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class that is responsible for persistence of connector offsets."},"offsetStorageFileName":{"index":8,"kind":"parameter","displayName":"Offset Storage File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore."},"offsetStoragePartitions":{"index":9,"kind":"parameter","displayName":"Offset Storage Partitions","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'."},"offsetStorageReplicationFactor":{"index":10,"kind":"parameter","displayName":"Offset Storage Replication Factor","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore"},"offsetStorageTopic":{"index":11,"kind":"parameter","displayName":"Offset Storage Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"bigintUnsignedHandlingMode":{"index":15,"kind":"parameter","displayName":"Bigint Unsigned Handling Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"long","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how BIGINT UNSIGNED columns should be represented in change events, including: 'precise' uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'long' (the default) represents values using Java's 'long', which may not offer the precision but will be far easier to use in consumers."},"binlogBufferSize":{"index":16,"kind":"parameter","displayName":"Binlog Buffer Size","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The size of a look-ahead buffer used by the binlog reader to decide whether the transaction in progress is going to be committed or rolled back. Use 0 to disable look-ahead buffering. Defaults to 0 (i.e. buffering is disabled."},"columnExcludeList":{"index":17,"kind":"parameter","displayName":"Column Exclude List","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to exclude from change events"},"columnIncludeList":{"index":18,"kind":"parameter","displayName":"Column Include List","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to include in change events"},"columnPropagateSourceType":{"index":19,"kind":"parameter","displayName":"Column Propagate Source Type","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records."},"connectKeepAlive":{"index":20,"kind":"parameter","displayName":"Connect Keep Alive","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether a separate thread should be used to ensure the connection is kept alive."},"connectKeepAliveIntervalMs":{"index":21,"kind":"parameter","displayName":"Connect Keep Alive Interval Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1m","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for connection checking if keep alive thread is used, given in milliseconds Defaults to 1 minute (60,000 ms)."},"connectTimeoutMs":{"index":22,"kind":"parameter","displayName":"Connect Timeout Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30s","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum time to wait after trying to connect to the database before timing out, given in milliseconds. Defaults to 30 seconds (30,000 ms)."},"converters":{"index":23,"kind":"parameter","displayName":"Converters","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'"},"customMetricTags":{"index":24,"kind":"parameter","displayName":"Custom Metric Tags","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2"},"databaseExcludeList":{"index":25,"kind":"parameter","displayName":"Database Exclude List","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match database names to be excluded from monitoring"},"databaseHostname":{"index":26,"kind":"parameter","displayName":"Database Hostname","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Resolvable hostname or IP address of the database server."},"databaseIncludeList":{"index":27,"kind":"parameter","displayName":"Database Include List","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The databases for which changes are to be captured"},"databaseInitialStatements":{"index":28,"kind":"parameter","displayName":"Database Initial Statements","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A semicolon separated list of SQL statements to be executed when a JDBC connection (not binlog reading connection) to the database is established. Note that the connector may establish JDBC connections at its own discretion, so this should typically be used for configuration of session parameters only, but not for executing DML statements. Use doubled semicolon (';;') to use a semicolon as a character and not as a delimiter."},"databaseJdbcDriver":{"index":29,"kind":"parameter","displayName":"Database Jdbc Driver","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"com.mysql.cj.jdbc.Driver","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"JDBC Driver class name used to connect to the MySQL database server."},"databasePassword":{"index":30,"kind":"parameter","displayName":"Database Password","group":"mysql","label":"consumer,mysql","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Password of the database user to be used when connecting to the database."},"databasePort":{"index":31,"kind":"parameter","displayName":"Database Port","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":3306,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Port of the database server."},"databaseProtocol":{"index":32,"kind":"parameter","displayName":"Database Protocol","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"jdbc:mysql","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"JDBC protocol to use with the driver."},"databaseQueryTimeoutMs":{"index":33,"kind":"parameter","displayName":"Database Query Timeout Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10m","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for a query to execute, given in milliseconds. Defaults to 600 seconds (600,000 ms); zero means there is no limit."},"databaseServerId":{"index":34,"kind":"parameter","displayName":"Database Server Id","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A numeric ID of this database client, which must be unique across all currently-running database processes in the cluster. This connector joins the database cluster as another server (with this unique ID) so it can read the binlog."},"databaseServerIdOffset":{"index":35,"kind":"parameter","displayName":"Database Server Id Offset","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Only relevant if parallel snapshotting is configured. During parallel snapshotting, multiple (4) connections open to the database client, and they each need their own unique connection ID. This offset is used to generate those IDs from the base configured cluster ID."},"databaseSslKeystore":{"index":36,"kind":"parameter","displayName":"Database Ssl Keystore","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The location of the key store file. This is optional and can be used for two-way authentication between the client and the database."},"databaseSslKeystorePassword":{"index":37,"kind":"parameter","displayName":"Database Ssl Keystore Password","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The password for the key store file. This is optional and only needed if 'database.ssl.keystore' is configured."},"databaseSslMode":{"index":38,"kind":"parameter","displayName":"Database Ssl Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"preferred","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether to use an encrypted connection to the database. Options include: 'disabled' to use an unencrypted connection; 'preferred' (the default) to establish a secure (encrypted) connection if the server supports secure connections, but fall back to an unencrypted connection otherwise; 'required' to use a secure (encrypted) connection, and fail if one cannot be established; 'verify_ca' like 'required' but additionally verify the server TLS certificate against the configured Certificate Authority (CA) certificates, or fail if no valid matching CA certificates are found; or 'verify_identity' like 'verify_ca' but additionally verify that the server certificate matches the host to which the connection is attempted."},"databaseSslTruststore":{"index":39,"kind":"parameter","displayName":"Database Ssl Truststore","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The location of the trust store file for the server certificate verification."},"databaseSslTruststorePassword":{"index":40,"kind":"parameter","displayName":"Database Ssl Truststore Password","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The password for the trust store file. Used to check the integrity of the truststore, and unlock the truststore."},"databaseUser":{"index":41,"kind":"parameter","displayName":"Database User","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Name of the database user to be used when connecting to the database."},"datatypePropagateSourceType":{"index":42,"kind":"parameter","displayName":"Datatype Propagate Source Type","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching the database-specific data type names that adds the data type's original type and original length as parameters to the corresponding field schemas in the emitted change records."},"decimalHandlingMode":{"index":43,"kind":"parameter","displayName":"Decimal Handling Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"precise","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how DECIMAL and NUMERIC columns should be represented in change events, including: 'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers."},"enableTimeAdjuster":{"index":44,"kind":"parameter","displayName":"Enable Time Adjuster","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The database allows the user to insert year value as either 2-digit or 4-digit. In case of two digit the value is automatically mapped into 1970 - 2069.false - delegates the implicit conversion to the database; true - (the default) Debezium makes the conversion"},"errorsMaxRetries":{"index":45,"kind":"parameter","displayName":"Errors Max Retries","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries)."},"eventDeserializationFailureHandlingMode":{"index":46,"kind":"parameter","displayName":"Event Deserialization Failure Handling Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how failures during deserialization of binlog events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its binlog position is raised, causing the connector to be stopped; 'warn' the problematic event and its binlog position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped."},"eventProcessingFailureHandlingMode":{"index":47,"kind":"parameter","displayName":"Event Processing Failure Handling Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped."},"gtidSourceExcludes":{"index":48,"kind":"parameter","displayName":"Gtid Source Excludes","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The source UUIDs used to exclude GTID ranges when determine the starting position in the MySQL server's binlog."},"gtidSourceFilterDmlEvents":{"index":49,"kind":"parameter","displayName":"Gtid Source Filter Dml Events","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When set to true, only produce DML events for transactions that were written on the server with matching GTIDs defined by the gtid.source.includes or gtid.source.excludes, if they were specified."},"gtidSourceIncludes":{"index":50,"kind":"parameter","displayName":"Gtid Source Includes","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The source UUIDs used to include GTID ranges when determine the starting position in the MySQL server's binlog."},"heartbeatActionQuery":{"index":51,"kind":"parameter","displayName":"Heartbeat Action Query","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The query executed with every heartbeat."},"heartbeatIntervalMs":{"index":52,"kind":"parameter","displayName":"Heartbeat Interval Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default."},"heartbeatTopicsPrefix":{"index":53,"kind":"parameter","displayName":"Heartbeat Topics Prefix","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium-heartbeat","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat."},"includeQuery":{"index":54,"kind":"parameter","displayName":"Include Query","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector should include the original SQL query that generated the change event. Note: This option requires the database to be configured using the server option binlog_rows_query_log_events (MySQL) or binlog_annotate_row_events (MariaDB) set to ON.Query will not be present for events generated from snapshot. WARNING: Enabling this option may expose tables or fields explicitly excluded or masked by including the original SQL statement in the change event. For this reason the default value is 'false'."},"includeSchemaChanges":{"index":55,"kind":"parameter","displayName":"Include Schema Changes","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s). The default is 'true'. This is independent of how the connector internally records database schema history."},"includeSchemaComments":{"index":56,"kind":"parameter","displayName":"Include Schema Comments","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector parse table and column's comment to metadata object. Note: Enable this option will bring the implications on memory usage. The number and size of ColumnImpl objects is what largely impacts how much memory is consumed by the Debezium connectors, and adding a String to each of them can potentially be quite heavy. The default is 'false'."},"inconsistentSchemaHandlingMode":{"index":57,"kind":"parameter","displayName":"Inconsistent Schema Handling Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how binlog events that belong to a table missing from internal schema representation (i.e. internal representation is not consistent with database) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its binlog position is raised, causing the connector to be stopped; 'warn' the problematic event and its binlog position will be logged and the event will be skipped; 'skip' the problematic event will be skipped."},"incrementalSnapshotAllowSchemaChanges":{"index":58,"kind":"parameter","displayName":"Incremental Snapshot Allow Schema Changes","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Detect schema change during an incremental snapshot and re-select a current chunk to avoid locking DDLs. Note that changes to a primary key are not supported and can cause incorrect results if performed during an incremental snapshot. Another limitation is that if a schema change affects only columns' default values, then the change won't be detected until the DDL is processed from the binlog stream. This doesn't affect the snapshot events' values, but the schema of snapshot events may have outdated defaults."},"incrementalSnapshotChunkSize":{"index":59,"kind":"parameter","displayName":"Incremental Snapshot Chunk Size","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum size of chunk (number of documents/rows) for incremental snapshotting"},"incrementalSnapshotWatermarkingStrategy":{"index":60,"kind":"parameter","displayName":"Incremental Snapshot Watermarking Strategy","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INSERT_INSERT","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;"},"maxBatchSize":{"index":61,"kind":"parameter","displayName":"Max Batch Size","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of each batch of source records. Defaults to 2048."},"maxQueueSize":{"index":62,"kind":"parameter","displayName":"Max Queue Size","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size."},"maxQueueSizeInBytes":{"index":63,"kind":"parameter","displayName":"Max Queue Size In Bytes","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled"},"messageKeyColumns":{"index":64,"kind":"parameter","displayName":"Message Key Columns","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':', where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector, and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key. Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id"},"minRowCountToStreamResults":{"index":65,"kind":"parameter","displayName":"Min Row Count To Stream Results","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of rows a table must contain to stream results rather than pull all into memory during snapshots. Defaults to 1,000. Use 0 to stream all results and completely avoid checking the size of each table."},"notificationEnabledChannels":{"index":66,"kind":"parameter","displayName":"Notification Enabled Channels","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of notification channels names that are enabled."},"notificationSinkTopicName":{"index":67,"kind":"parameter","displayName":"Notification Sink Topic Name","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels"},"pollIntervalMs":{"index":68,"kind":"parameter","displayName":"Poll Interval Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500ms","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms."},"postProcessors":{"index":69,"kind":"parameter","displayName":"Post Processors","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of post processors. The processors are defined using '.type' config option and configured using options ''"},"provideTransactionMetadata":{"index":70,"kind":"parameter","displayName":"Provide Transaction Metadata","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Enables transaction metadata extraction together with event counting"},"queryFetchSize":{"index":71,"kind":"parameter","displayName":"Query Fetch Size","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size."},"retriableRestartConnectorWaitMs":{"index":72,"kind":"parameter","displayName":"Retriable Restart Connector Wait Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms."},"schemaHistoryInternal":{"index":73,"kind":"parameter","displayName":"Schema History Internal","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.storage.kafka.history.KafkaSchemaHistory","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SchemaHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'schema.history.internal.' string."},"schemaHistoryInternalFileFilename":{"index":74,"kind":"parameter","displayName":"Schema History Internal File Filename","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The path to the file that will be used to record the database schema history"},"schemaHistoryInternalSkipUnparseableDdl":{"index":75,"kind":"parameter","displayName":"Schema History Internal Skip Unparseable Ddl","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes."},"schemaHistoryInternalStoreOnlyCapturedDatabasesDdl":{"index":76,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Databases Ddl","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (true) only DDL that manipulates a table from captured schema/database will be stored. If set to false, then Debezium will store all incoming DDL statements."},"schemaHistoryInternalStoreOnlyCapturedTablesDdl":{"index":77,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Tables Ddl","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a captured table will be stored."},"schemaNameAdjustmentMode":{"index":78,"kind":"parameter","displayName":"Schema Name Adjustment Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)"},"signalDataCollection":{"index":79,"kind":"parameter","displayName":"Signal Data Collection","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set."},"signalEnabledChannels":{"index":80,"kind":"parameter","displayName":"Signal Enabled Channels","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"source","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of channels names that are enabled. Source channel is enabled by default"},"signalPollIntervalMs":{"index":81,"kind":"parameter","displayName":"Signal Poll Interval Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds."},"skippedOperations":{"index":82,"kind":"parameter","displayName":"Skipped Operations","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"t","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped."},"snapshotDelayMs":{"index":83,"kind":"parameter","displayName":"Snapshot Delay Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms."},"snapshotFetchSize":{"index":84,"kind":"parameter","displayName":"Snapshot Fetch Size","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while performing a snapshot."},"snapshotIncludeCollectionList":{"index":85,"kind":"parameter","displayName":"Snapshot Include Collection List","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector."},"snapshotLockingMode":{"index":86,"kind":"parameter","displayName":"Snapshot Locking Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"minimal","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls how long the connector holds onto the global read lock while it is performing a snapshot. The default is 'minimal', which means the connector holds the global read lock (and thus prevents any updates) for just the initial portion of the snapshot while the database schemas and other metadata are being read. The remaining work in a snapshot involves selecting all rows from each table, and this can be done using the snapshot process' REPEATABLE READ transaction even when the lock is no longer held and other operations are updating the database. However, in some cases it may be desirable to block all writes for the entire duration of the snapshot; in such cases set this property to 'extended'. Using a value of 'none' will prevent the connector from acquiring any table locks during the snapshot process. This mode can only be used in combination with snapshot.mode values of 'schema_only' or 'schema_only_recovery' and is only safe to use if no schema changes are happening while the snapshot is taken."},"snapshotLockTimeoutMs":{"index":87,"kind":"parameter","displayName":"Snapshot Lock Timeout Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds"},"snapshotMaxThreads":{"index":88,"kind":"parameter","displayName":"Snapshot Max Threads","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of threads used to perform the snapshot. Defaults to 1."},"snapshotMode":{"index":89,"kind":"parameter","displayName":"Snapshot Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"initial","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'when_needed': On startup, the connector runs a snapshot if one is needed.; 'schema_only': If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures only the schema (table structures), but not any table data. After the snapshot completes, the connector begins to stream changes from the binlog.; 'schema_only_recovery': The connector performs a snapshot that captures only the database schema history. The connector then transitions back to streaming. Use this setting to restore a corrupted or lost database schema history topic. Do not use if the database schema was modified after the connector stopped.; 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the binlog.; 'initial_only': The connector performs a snapshot as it does for the 'initial' option, but after the connector completes the snapshot, it stops, and does not stream changes from the binlog.; 'never': The connector does not run a snapshot. Upon first startup, the connector immediately begins reading from the beginning of the binlog. The 'never' mode should be used with care, and only when the binlog is known to contain all history."},"snapshotModeConfigurationBasedSnapshotData":{"index":90,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Data","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not."},"snapshotModeConfigurationBasedSnapshotOnDataError":{"index":91,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Data Error","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotOnSchemaError":{"index":92,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Schema Error","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotSchema":{"index":93,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Schema","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not."},"snapshotModeConfigurationBasedStartStream":{"index":94,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Start Stream","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot."},"snapshotModeCustomName":{"index":95,"kind":"parameter","displayName":"Snapshot Mode Custom Name","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot."},"snapshotQueryMode":{"index":96,"kind":"parameter","displayName":"Snapshot Query Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"select_all","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls query used during the snapshot"},"snapshotQueryModeCustomName":{"index":97,"kind":"parameter","displayName":"Snapshot Query Mode Custom Name","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.query.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'SnapshotterQuery' interface and is called to determine how to build queries during snapshot."},"snapshotSelectStatementOverrides":{"index":98,"kind":"parameter","displayName":"Snapshot Select Statement Overrides","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connectors. Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted."},"snapshotTablesOrderByRowCount":{"index":99,"kind":"parameter","displayName":"Snapshot Tables Order By Row Count","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"disabled","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the order in which tables are processed in the initial snapshot. A descending value will order the tables by row count descending. A ascending value will order the tables by row count ascending. A value of disabled (the default) will disable ordering by row count."},"sourceinfoStructMaker":{"index":100,"kind":"parameter","displayName":"Sourceinfo Struct Maker","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.connector.mysql.MySqlSourceInfoStructMaker","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct."},"streamingDelayMs":{"index":101,"kind":"parameter","displayName":"Streaming Delay Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms."},"tableExcludeList":{"index":102,"kind":"parameter","displayName":"Table Exclude List","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring"},"tableIgnoreBuiltin":{"index":103,"kind":"parameter","displayName":"Table Ignore Builtin","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Flag specifying whether built-in tables should be ignored."},"tableIncludeList":{"index":104,"kind":"parameter","displayName":"Table Include List","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The tables for which changes are to be captured"},"timePrecisionMode":{"index":105,"kind":"parameter","displayName":"Time Precision Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"adaptive_time_microseconds","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time, date and timestamps can be represented with different kinds of precisions, including: 'adaptive_time_microseconds': the precision of date and timestamp values is based the database column's precision; but time fields always use microseconds precision; 'connect': always represents time, date and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision."},"tombstonesOnDelete":{"index":106,"kind":"parameter","displayName":"Tombstones On Delete","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted."},"topicNamingStrategy":{"index":107,"kind":"parameter","displayName":"Topic Naming Strategy","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.schema.SchemaTopicNamingStrategy","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc."},"topicPrefix":{"index":108,"kind":"parameter","displayName":"Topic Prefix","group":"mysql","label":"consumer,mysql","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted."},"transactionMetadataFactory":{"index":109,"kind":"parameter","displayName":"Transaction Metadata Factory","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory","configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Class to make transaction context & transaction struct/schemas"},"useNongracefulDisconnect":{"index":110,"kind":"parameter","displayName":"Use Nongraceful Disconnect","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether to use socket.setSoLinger(true, 0) when BinaryLogClient keepalive thread triggers a disconnect for a stale connection."}}} +{"component":{"kind":"component","name":"debezium-mysql","title":"Debezium MySQL Connector","description":"Capture changes from a MySQL database.","deprecated":false,"firstVersion":"3.0.0","label":"database","javaType":"org.apache.camel.component.debezium.mysql.DebeziumMySqlComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-debezium-mysql","version":"4.8.2","scheme":"debezium-mysql","extendsScheme":"","syntax":"debezium-mysql:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelDebeziumSourceMetadata":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_SOURCE_METADATA"},"CamelDebeziumIdentifier":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The identifier of the connector, normally is this format {server-name}.{database-name}.{table-name}.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_IDENTIFIER"},"CamelDebeziumKey":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the event, normally is the table Primary Key.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_KEY"},"CamelDebeziumOperation":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r for read (in the case of a initial sync) or in case of a snapshot event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_OPERATION"},"CamelDebeziumTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the time (using the system clock in the JVM) at which the connector processed the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_TIMESTAMP"},"CamelDebeziumBefore":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, contains the state of the row before the event occurred.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_BEFORE"},"CamelDebeziumDdlSQL":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the ddl sql text of the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_DDL_SQL"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Unique name for the connector. Attempting to register again with the same name will fail."},"additionalProperties":{"index":1,"kind":"parameter","displayName":"Additional Properties","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.Map","prefix":"additionalProperties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro"},"internalKeyConverter":{"index":2,"kind":"parameter","displayName":"Internal Key Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter."},"internalValueConverter":{"index":3,"kind":"parameter","displayName":"Internal Value Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter."},"offsetCommitPolicy":{"index":4,"kind":"parameter","displayName":"Offset Commit Policy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals."},"offsetCommitTimeoutMs":{"index":5,"kind":"parameter","displayName":"Offset Commit Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds."},"offsetFlushIntervalMs":{"index":6,"kind":"parameter","displayName":"Offset Flush Interval Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval at which to try committing offsets. The default is 1 minute."},"offsetStorage":{"index":7,"kind":"parameter","displayName":"Offset Storage","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.storage.FileOffsetBackingStore","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class that is responsible for persistence of connector offsets."},"offsetStorageFileName":{"index":8,"kind":"parameter","displayName":"Offset Storage File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore."},"offsetStoragePartitions":{"index":9,"kind":"parameter","displayName":"Offset Storage Partitions","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'."},"offsetStorageReplicationFactor":{"index":10,"kind":"parameter","displayName":"Offset Storage Replication Factor","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore"},"offsetStorageTopic":{"index":11,"kind":"parameter","displayName":"Offset Storage Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"bigintUnsignedHandlingMode":{"index":15,"kind":"parameter","displayName":"Bigint Unsigned Handling Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"long","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how BIGINT UNSIGNED columns should be represented in change events, including: 'precise' uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'long' (the default) represents values using Java's 'long', which may not offer the precision but will be far easier to use in consumers."},"binlogBufferSize":{"index":16,"kind":"parameter","displayName":"Binlog Buffer Size","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The size of a look-ahead buffer used by the binlog reader to decide whether the transaction in progress is going to be committed or rolled back. Use 0 to disable look-ahead buffering. Defaults to 0 (i.e. buffering is disabled."},"columnExcludeList":{"index":17,"kind":"parameter","displayName":"Column Exclude List","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to exclude from change events"},"columnIncludeList":{"index":18,"kind":"parameter","displayName":"Column Include List","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to include in change events"},"columnPropagateSourceType":{"index":19,"kind":"parameter","displayName":"Column Propagate Source Type","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records."},"connectKeepAlive":{"index":20,"kind":"parameter","displayName":"Connect Keep Alive","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether a separate thread should be used to ensure the connection is kept alive."},"connectKeepAliveIntervalMs":{"index":21,"kind":"parameter","displayName":"Connect Keep Alive Interval Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1m","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for connection checking if keep alive thread is used, given in milliseconds Defaults to 1 minute (60,000 ms)."},"connectTimeoutMs":{"index":22,"kind":"parameter","displayName":"Connect Timeout Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30s","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum time to wait after trying to connect to the database before timing out, given in milliseconds. Defaults to 30 seconds (30,000 ms)."},"converters":{"index":23,"kind":"parameter","displayName":"Converters","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'"},"customMetricTags":{"index":24,"kind":"parameter","displayName":"Custom Metric Tags","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2"},"databaseExcludeList":{"index":25,"kind":"parameter","displayName":"Database Exclude List","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match database names to be excluded from monitoring"},"databaseHostname":{"index":26,"kind":"parameter","displayName":"Database Hostname","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Resolvable hostname or IP address of the database server."},"databaseIncludeList":{"index":27,"kind":"parameter","displayName":"Database Include List","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The databases for which changes are to be captured"},"databaseInitialStatements":{"index":28,"kind":"parameter","displayName":"Database Initial Statements","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A semicolon separated list of SQL statements to be executed when a JDBC connection (not binlog reading connection) to the database is established. Note that the connector may establish JDBC connections at its own discretion, so this should typically be used for configuration of session parameters only, but not for executing DML statements. Use doubled semicolon (';;') to use a semicolon as a character and not as a delimiter."},"databaseJdbcDriver":{"index":29,"kind":"parameter","displayName":"Database Jdbc Driver","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"com.mysql.cj.jdbc.Driver","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"JDBC Driver class name used to connect to the MySQL database server."},"databasePassword":{"index":30,"kind":"parameter","displayName":"Database Password","group":"mysql","label":"consumer,mysql","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Password of the database user to be used when connecting to the database."},"databasePort":{"index":31,"kind":"parameter","displayName":"Database Port","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":3306,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Port of the database server."},"databaseProtocol":{"index":32,"kind":"parameter","displayName":"Database Protocol","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"jdbc:mysql","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"JDBC protocol to use with the driver."},"databaseQueryTimeoutMs":{"index":33,"kind":"parameter","displayName":"Database Query Timeout Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10m","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for a query to execute, given in milliseconds. Defaults to 600 seconds (600,000 ms); zero means there is no limit."},"databaseServerId":{"index":34,"kind":"parameter","displayName":"Database Server Id","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A numeric ID of this database client, which must be unique across all currently-running database processes in the cluster. This connector joins the database cluster as another server (with this unique ID) so it can read the binlog."},"databaseServerIdOffset":{"index":35,"kind":"parameter","displayName":"Database Server Id Offset","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Only relevant if parallel snapshotting is configured. During parallel snapshotting, multiple (4) connections open to the database client, and they each need their own unique connection ID. This offset is used to generate those IDs from the base configured cluster ID."},"databaseSslKeystore":{"index":36,"kind":"parameter","displayName":"Database Ssl Keystore","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The location of the key store file. This is optional and can be used for two-way authentication between the client and the database."},"databaseSslKeystorePassword":{"index":37,"kind":"parameter","displayName":"Database Ssl Keystore Password","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The password for the key store file. This is optional and only needed if 'database.ssl.keystore' is configured."},"databaseSslMode":{"index":38,"kind":"parameter","displayName":"Database Ssl Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"preferred","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether to use an encrypted connection to the database. Options include: 'disabled' to use an unencrypted connection; 'preferred' (the default) to establish a secure (encrypted) connection if the server supports secure connections, but fall back to an unencrypted connection otherwise; 'required' to use a secure (encrypted) connection, and fail if one cannot be established; 'verify_ca' like 'required' but additionally verify the server TLS certificate against the configured Certificate Authority (CA) certificates, or fail if no valid matching CA certificates are found; or 'verify_identity' like 'verify_ca' but additionally verify that the server certificate matches the host to which the connection is attempted."},"databaseSslTruststore":{"index":39,"kind":"parameter","displayName":"Database Ssl Truststore","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The location of the trust store file for the server certificate verification."},"databaseSslTruststorePassword":{"index":40,"kind":"parameter","displayName":"Database Ssl Truststore Password","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The password for the trust store file. Used to check the integrity of the truststore, and unlock the truststore."},"databaseUser":{"index":41,"kind":"parameter","displayName":"Database User","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Name of the database user to be used when connecting to the database."},"datatypePropagateSourceType":{"index":42,"kind":"parameter","displayName":"Datatype Propagate Source Type","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching the database-specific data type names that adds the data type's original type and original length as parameters to the corresponding field schemas in the emitted change records."},"decimalHandlingMode":{"index":43,"kind":"parameter","displayName":"Decimal Handling Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"precise","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how DECIMAL and NUMERIC columns should be represented in change events, including: 'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers."},"enableTimeAdjuster":{"index":44,"kind":"parameter","displayName":"Enable Time Adjuster","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The database allows the user to insert year value as either 2-digit or 4-digit. In case of two digit the value is automatically mapped into 1970 - 2069.false - delegates the implicit conversion to the database; true - (the default) Debezium makes the conversion"},"errorsMaxRetries":{"index":45,"kind":"parameter","displayName":"Errors Max Retries","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries)."},"eventDeserializationFailureHandlingMode":{"index":46,"kind":"parameter","displayName":"Event Deserialization Failure Handling Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how failures during deserialization of binlog events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its binlog position is raised, causing the connector to be stopped; 'warn' the problematic event and its binlog position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped."},"eventProcessingFailureHandlingMode":{"index":47,"kind":"parameter","displayName":"Event Processing Failure Handling Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped."},"gtidSourceExcludes":{"index":48,"kind":"parameter","displayName":"Gtid Source Excludes","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The source UUIDs used to exclude GTID ranges when determine the starting position in the MySQL server's binlog."},"gtidSourceFilterDmlEvents":{"index":49,"kind":"parameter","displayName":"Gtid Source Filter Dml Events","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When set to true, only produce DML events for transactions that were written on the server with matching GTIDs defined by the gtid.source.includes or gtid.source.excludes, if they were specified."},"gtidSourceIncludes":{"index":50,"kind":"parameter","displayName":"Gtid Source Includes","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The source UUIDs used to include GTID ranges when determine the starting position in the MySQL server's binlog."},"heartbeatActionQuery":{"index":51,"kind":"parameter","displayName":"Heartbeat Action Query","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The query executed with every heartbeat."},"heartbeatIntervalMs":{"index":52,"kind":"parameter","displayName":"Heartbeat Interval Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default."},"heartbeatTopicsPrefix":{"index":53,"kind":"parameter","displayName":"Heartbeat Topics Prefix","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium-heartbeat","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat."},"includeQuery":{"index":54,"kind":"parameter","displayName":"Include Query","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector should include the original SQL query that generated the change event. Note: This option requires the database to be configured using the server option binlog_rows_query_log_events (MySQL) or binlog_annotate_row_events (MariaDB) set to ON.Query will not be present for events generated from snapshot. WARNING: Enabling this option may expose tables or fields explicitly excluded or masked by including the original SQL statement in the change event. For this reason the default value is 'false'."},"includeSchemaChanges":{"index":55,"kind":"parameter","displayName":"Include Schema Changes","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s). The default is 'true'. This is independent of how the connector internally records database schema history."},"includeSchemaComments":{"index":56,"kind":"parameter","displayName":"Include Schema Comments","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector parse table and column's comment to metadata object. Note: Enable this option will bring the implications on memory usage. The number and size of ColumnImpl objects is what largely impacts how much memory is consumed by the Debezium connectors, and adding a String to each of them can potentially be quite heavy. The default is 'false'."},"inconsistentSchemaHandlingMode":{"index":57,"kind":"parameter","displayName":"Inconsistent Schema Handling Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how binlog events that belong to a table missing from internal schema representation (i.e. internal representation is not consistent with database) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its binlog position is raised, causing the connector to be stopped; 'warn' the problematic event and its binlog position will be logged and the event will be skipped; 'skip' the problematic event will be skipped."},"incrementalSnapshotAllowSchemaChanges":{"index":58,"kind":"parameter","displayName":"Incremental Snapshot Allow Schema Changes","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Detect schema change during an incremental snapshot and re-select a current chunk to avoid locking DDLs. Note that changes to a primary key are not supported and can cause incorrect results if performed during an incremental snapshot. Another limitation is that if a schema change affects only columns' default values, then the change won't be detected until the DDL is processed from the binlog stream. This doesn't affect the snapshot events' values, but the schema of snapshot events may have outdated defaults."},"incrementalSnapshotChunkSize":{"index":59,"kind":"parameter","displayName":"Incremental Snapshot Chunk Size","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum size of chunk (number of documents/rows) for incremental snapshotting"},"incrementalSnapshotWatermarkingStrategy":{"index":60,"kind":"parameter","displayName":"Incremental Snapshot Watermarking Strategy","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INSERT_INSERT","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;"},"maxBatchSize":{"index":61,"kind":"parameter","displayName":"Max Batch Size","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of each batch of source records. Defaults to 2048."},"maxQueueSize":{"index":62,"kind":"parameter","displayName":"Max Queue Size","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size."},"maxQueueSizeInBytes":{"index":63,"kind":"parameter","displayName":"Max Queue Size In Bytes","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled"},"messageKeyColumns":{"index":64,"kind":"parameter","displayName":"Message Key Columns","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':', where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector, and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key. Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id"},"minRowCountToStreamResults":{"index":65,"kind":"parameter","displayName":"Min Row Count To Stream Results","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of rows a table must contain to stream results rather than pull all into memory during snapshots. Defaults to 1,000. Use 0 to stream all results and completely avoid checking the size of each table."},"notificationEnabledChannels":{"index":66,"kind":"parameter","displayName":"Notification Enabled Channels","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of notification channels names that are enabled."},"notificationSinkTopicName":{"index":67,"kind":"parameter","displayName":"Notification Sink Topic Name","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels"},"pollIntervalMs":{"index":68,"kind":"parameter","displayName":"Poll Interval Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500ms","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms."},"postProcessors":{"index":69,"kind":"parameter","displayName":"Post Processors","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of post processors. The processors are defined using '.type' config option and configured using options ''"},"provideTransactionMetadata":{"index":70,"kind":"parameter","displayName":"Provide Transaction Metadata","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Enables transaction metadata extraction together with event counting"},"queryFetchSize":{"index":71,"kind":"parameter","displayName":"Query Fetch Size","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size."},"retriableRestartConnectorWaitMs":{"index":72,"kind":"parameter","displayName":"Retriable Restart Connector Wait Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms."},"schemaHistoryInternal":{"index":73,"kind":"parameter","displayName":"Schema History Internal","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.storage.kafka.history.KafkaSchemaHistory","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SchemaHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'schema.history.internal.' string."},"schemaHistoryInternalFileFilename":{"index":74,"kind":"parameter","displayName":"Schema History Internal File Filename","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The path to the file that will be used to record the database schema history"},"schemaHistoryInternalSkipUnparseableDdl":{"index":75,"kind":"parameter","displayName":"Schema History Internal Skip Unparseable Ddl","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes."},"schemaHistoryInternalStoreOnlyCapturedDatabasesDdl":{"index":76,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Databases Ddl","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (true) only DDL that manipulates a table from captured schema/database will be stored. If set to false, then Debezium will store all incoming DDL statements."},"schemaHistoryInternalStoreOnlyCapturedTablesDdl":{"index":77,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Tables Ddl","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a captured table will be stored."},"schemaNameAdjustmentMode":{"index":78,"kind":"parameter","displayName":"Schema Name Adjustment Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)"},"signalDataCollection":{"index":79,"kind":"parameter","displayName":"Signal Data Collection","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set."},"signalEnabledChannels":{"index":80,"kind":"parameter","displayName":"Signal Enabled Channels","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"source","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of channels names that are enabled. Source channel is enabled by default"},"signalPollIntervalMs":{"index":81,"kind":"parameter","displayName":"Signal Poll Interval Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds."},"skippedOperations":{"index":82,"kind":"parameter","displayName":"Skipped Operations","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"t","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped."},"snapshotDelayMs":{"index":83,"kind":"parameter","displayName":"Snapshot Delay Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms."},"snapshotFetchSize":{"index":84,"kind":"parameter","displayName":"Snapshot Fetch Size","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while performing a snapshot."},"snapshotIncludeCollectionList":{"index":85,"kind":"parameter","displayName":"Snapshot Include Collection List","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector."},"snapshotLockingMode":{"index":86,"kind":"parameter","displayName":"Snapshot Locking Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"minimal","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls how long the connector holds onto the global read lock while it is performing a snapshot. The default is 'minimal', which means the connector holds the global read lock (and thus prevents any updates) for just the initial portion of the snapshot while the database schemas and other metadata are being read. The remaining work in a snapshot involves selecting all rows from each table, and this can be done using the snapshot process' REPEATABLE READ transaction even when the lock is no longer held and other operations are updating the database. However, in some cases it may be desirable to block all writes for the entire duration of the snapshot; in such cases set this property to 'extended'. Using a value of 'none' will prevent the connector from acquiring any table locks during the snapshot process. This mode can only be used in combination with snapshot.mode values of 'schema_only' or 'schema_only_recovery' and is only safe to use if no schema changes are happening while the snapshot is taken."},"snapshotLockTimeoutMs":{"index":87,"kind":"parameter","displayName":"Snapshot Lock Timeout Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds"},"snapshotMaxThreads":{"index":88,"kind":"parameter","displayName":"Snapshot Max Threads","group":"mysql","label":"consumer,mysql","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of threads used to perform the snapshot. Defaults to 1."},"snapshotMode":{"index":89,"kind":"parameter","displayName":"Snapshot Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"initial","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'when_needed': On startup, the connector runs a snapshot if one is needed.; 'schema_only': If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures only the schema (table structures), but not any table data. After the snapshot completes, the connector begins to stream changes from the binlog.; 'schema_only_recovery': The connector performs a snapshot that captures only the database schema history. The connector then transitions back to streaming. Use this setting to restore a corrupted or lost database schema history topic. Do not use if the database schema was modified after the connector stopped.; 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the binlog.; 'initial_only': The connector performs a snapshot as it does for the 'initial' option, but after the connector completes the snapshot, it stops, and does not stream changes from the binlog.; 'never': The connector does not run a snapshot. Upon first startup, the connector immediately begins reading from the beginning of the binlog. The 'never' mode should be used with care, and only when the binlog is known to contain all history."},"snapshotModeConfigurationBasedSnapshotData":{"index":90,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Data","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not."},"snapshotModeConfigurationBasedSnapshotOnDataError":{"index":91,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Data Error","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotOnSchemaError":{"index":92,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Schema Error","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotSchema":{"index":93,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Schema","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not."},"snapshotModeConfigurationBasedStartStream":{"index":94,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Start Stream","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot."},"snapshotModeCustomName":{"index":95,"kind":"parameter","displayName":"Snapshot Mode Custom Name","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot."},"snapshotQueryMode":{"index":96,"kind":"parameter","displayName":"Snapshot Query Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"select_all","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls query used during the snapshot"},"snapshotQueryModeCustomName":{"index":97,"kind":"parameter","displayName":"Snapshot Query Mode Custom Name","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.query.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'SnapshotterQuery' interface and is called to determine how to build queries during snapshot."},"snapshotSelectStatementOverrides":{"index":98,"kind":"parameter","displayName":"Snapshot Select Statement Overrides","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connectors. Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted."},"snapshotTablesOrderByRowCount":{"index":99,"kind":"parameter","displayName":"Snapshot Tables Order By Row Count","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"disabled","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the order in which tables are processed in the initial snapshot. A descending value will order the tables by row count descending. A ascending value will order the tables by row count ascending. A value of disabled (the default) will disable ordering by row count."},"sourceinfoStructMaker":{"index":100,"kind":"parameter","displayName":"Sourceinfo Struct Maker","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.connector.mysql.MySqlSourceInfoStructMaker","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct."},"streamingDelayMs":{"index":101,"kind":"parameter","displayName":"Streaming Delay Ms","group":"mysql","label":"consumer,mysql","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms."},"tableExcludeList":{"index":102,"kind":"parameter","displayName":"Table Exclude List","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring"},"tableIgnoreBuiltin":{"index":103,"kind":"parameter","displayName":"Table Ignore Builtin","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Flag specifying whether built-in tables should be ignored."},"tableIncludeList":{"index":104,"kind":"parameter","displayName":"Table Include List","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The tables for which changes are to be captured"},"timePrecisionMode":{"index":105,"kind":"parameter","displayName":"Time Precision Mode","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"adaptive_time_microseconds","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time, date and timestamps can be represented with different kinds of precisions, including: 'adaptive_time_microseconds': the precision of date and timestamp values is based the database column's precision; but time fields always use microseconds precision; 'connect': always represents time, date and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision."},"tombstonesOnDelete":{"index":106,"kind":"parameter","displayName":"Tombstones On Delete","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted."},"topicNamingStrategy":{"index":107,"kind":"parameter","displayName":"Topic Naming Strategy","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.schema.SchemaTopicNamingStrategy","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc."},"topicPrefix":{"index":108,"kind":"parameter","displayName":"Topic Prefix","group":"mysql","label":"consumer,mysql","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted."},"transactionMetadataFactory":{"index":109,"kind":"parameter","displayName":"Transaction Metadata Factory","group":"mysql","label":"consumer,mysql","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory","configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Class to make transaction context & transaction struct/schemas"},"useNongracefulDisconnect":{"index":110,"kind":"parameter","displayName":"Use Nongraceful Disconnect","group":"mysql","label":"consumer,mysql","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.mysql.configuration.MySqlConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether to use socket.setSoLinger(true, 0) when BinaryLogClient keepalive thread triggers a disconnect for a stale connection."}}} , -{"component":{"kind":"component","name":"debezium-oracle","title":"Debezium Oracle Connector","description":"Capture changes from an Oracle database.","deprecated":false,"firstVersion":"3.17.0","label":"database","javaType":"org.apache.camel.component.debezium.DebeziumOracleComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-debezium-oracle","version":"4.8.1","scheme":"debezium-oracle","extendsScheme":"","syntax":"debezium-oracle:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelDebeziumSourceMetadata":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_SOURCE_METADATA"},"CamelDebeziumIdentifier":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The identifier of the connector, normally is this format {server-name}.{database-name}.{table-name}.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_IDENTIFIER"},"CamelDebeziumKey":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the event, normally is the table Primary Key.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_KEY"},"CamelDebeziumOperation":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r for read (in the case of a initial sync) or in case of a snapshot event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_OPERATION"},"CamelDebeziumTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the time (using the system clock in the JVM) at which the connector processed the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_TIMESTAMP"},"CamelDebeziumBefore":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, contains the state of the row before the event occurred.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_BEFORE"},"CamelDebeziumDdlSQL":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the ddl sql text of the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_DDL_SQL"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Unique name for the connector. Attempting to register again with the same name will fail."},"additionalProperties":{"index":1,"kind":"parameter","displayName":"Additional Properties","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.Map","prefix":"additionalProperties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro"},"internalKeyConverter":{"index":2,"kind":"parameter","displayName":"Internal Key Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter."},"internalValueConverter":{"index":3,"kind":"parameter","displayName":"Internal Value Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter."},"offsetCommitPolicy":{"index":4,"kind":"parameter","displayName":"Offset Commit Policy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals."},"offsetCommitTimeoutMs":{"index":5,"kind":"parameter","displayName":"Offset Commit Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds."},"offsetFlushIntervalMs":{"index":6,"kind":"parameter","displayName":"Offset Flush Interval Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval at which to try committing offsets. The default is 1 minute."},"offsetStorage":{"index":7,"kind":"parameter","displayName":"Offset Storage","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.storage.FileOffsetBackingStore","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class that is responsible for persistence of connector offsets."},"offsetStorageFileName":{"index":8,"kind":"parameter","displayName":"Offset Storage File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore."},"offsetStoragePartitions":{"index":9,"kind":"parameter","displayName":"Offset Storage Partitions","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'."},"offsetStorageReplicationFactor":{"index":10,"kind":"parameter","displayName":"Offset Storage Replication Factor","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore"},"offsetStorageTopic":{"index":11,"kind":"parameter","displayName":"Offset Storage Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"archiveDestinationName":{"index":15,"kind":"parameter","displayName":"Archive Destination Name","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Sets the specific archive log destination as the source for reading archive logs.When not set, the connector will automatically select the first LOCAL and VALID destination."},"archiveLogHours":{"index":16,"kind":"parameter","displayName":"Archive Log Hours","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of hours in the past from SYSDATE to mine archive logs. Using 0 mines all available archive logs"},"binaryHandlingMode":{"index":17,"kind":"parameter","displayName":"Binary Handling Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"bytes","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how binary (blob, binary, etc.) columns should be represented in change events, including: 'bytes' represents binary data as byte array (default); 'base64' represents binary data as base64-encoded string; 'base64-url-safe' represents binary data as base64-url-safe-encoded string; 'hex' represents binary data as hex-encoded (base16) string"},"columnExcludeList":{"index":18,"kind":"parameter","displayName":"Column Exclude List","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to exclude from change events"},"columnIncludeList":{"index":19,"kind":"parameter","displayName":"Column Include List","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to include in change events"},"columnPropagateSourceType":{"index":20,"kind":"parameter","displayName":"Column Propagate Source Type","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records."},"converters":{"index":21,"kind":"parameter","displayName":"Converters","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'"},"customMetricTags":{"index":22,"kind":"parameter","displayName":"Custom Metric Tags","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2"},"databaseConnectionAdapter":{"index":23,"kind":"parameter","displayName":"Database Connection Adapter","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"LogMiner","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The adapter to use when capturing changes from the database. Options include: 'logminer': (the default) to capture changes using native Oracle LogMiner; 'xstream' to capture changes using Oracle XStreams"},"databaseDbname":{"index":24,"kind":"parameter","displayName":"Database Dbname","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the database from which the connector should capture changes"},"databaseHostname":{"index":25,"kind":"parameter","displayName":"Database Hostname","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Resolvable hostname or IP address of the database server."},"databaseOutServerName":{"index":26,"kind":"parameter","displayName":"Database Out Server Name","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Name of the XStream Out server to connect to."},"databasePassword":{"index":27,"kind":"parameter","displayName":"Database Password","group":"oracle","label":"consumer,oracle","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Password of the database user to be used when connecting to the database."},"databasePdbName":{"index":28,"kind":"parameter","displayName":"Database Pdb Name","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Name of the pluggable database when working with a multi-tenant set-up. The CDB name must be given via database.dbname in this case."},"databasePort":{"index":29,"kind":"parameter","displayName":"Database Port","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1528,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Port of the database server."},"databaseQueryTimeoutMs":{"index":30,"kind":"parameter","displayName":"Database Query Timeout Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10m","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for a query to execute, given in milliseconds. Defaults to 600 seconds (600,000 ms); zero means there is no limit."},"databaseUrl":{"index":31,"kind":"parameter","displayName":"Database Url","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Complete JDBC URL as an alternative to specifying hostname, port and database provided as a way to support alternative connection scenarios."},"databaseUser":{"index":32,"kind":"parameter","displayName":"Database User","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Name of the database user to be used when connecting to the database."},"datatypePropagateSourceType":{"index":33,"kind":"parameter","displayName":"Datatype Propagate Source Type","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching the database-specific data type names that adds the data type's original type and original length as parameters to the corresponding field schemas in the emitted change records."},"decimalHandlingMode":{"index":34,"kind":"parameter","displayName":"Decimal Handling Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"precise","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how DECIMAL and NUMERIC columns should be represented in change events, including: 'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers."},"errorsMaxRetries":{"index":35,"kind":"parameter","displayName":"Errors Max Retries","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries)."},"eventProcessingFailureHandlingMode":{"index":36,"kind":"parameter","displayName":"Event Processing Failure Handling Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped."},"heartbeatActionQuery":{"index":37,"kind":"parameter","displayName":"Heartbeat Action Query","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The query executed with every heartbeat."},"heartbeatIntervalMs":{"index":38,"kind":"parameter","displayName":"Heartbeat Interval Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default."},"heartbeatTopicsPrefix":{"index":39,"kind":"parameter","displayName":"Heartbeat Topics Prefix","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium-heartbeat","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat."},"includeSchemaChanges":{"index":40,"kind":"parameter","displayName":"Include Schema Changes","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s). The default is 'true'. This is independent of how the connector internally records database schema history."},"includeSchemaComments":{"index":41,"kind":"parameter","displayName":"Include Schema Comments","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector parse table and column's comment to metadata object. Note: Enable this option will bring the implications on memory usage. The number and size of ColumnImpl objects is what largely impacts how much memory is consumed by the Debezium connectors, and adding a String to each of them can potentially be quite heavy. The default is 'false'."},"incrementalSnapshotWatermarkingStrategy":{"index":42,"kind":"parameter","displayName":"Incremental Snapshot Watermarking Strategy","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INSERT_INSERT","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;"},"intervalHandlingMode":{"index":43,"kind":"parameter","displayName":"Interval Handling Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"numeric","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how INTERVAL columns should be represented in change events, including: 'string' represents values as an exact ISO formatted string; 'numeric' (default) represents values using the inexact conversion into microseconds"},"lobEnabled":{"index":44,"kind":"parameter","displayName":"Lob Enabled","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When set to 'false', the default, LOB fields will not be captured nor emitted. When set to 'true', the connector will capture LOB fields and emit changes for those fields like any other column type."},"logMiningArchiveLogOnlyMode":{"index":45,"kind":"parameter","displayName":"Log Mining Archive Log Only Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When set to 'false', the default, the connector will mine both archive log and redo logs to emit change events. When set to 'true', the connector will only mine archive logs. There are circumstances where its advantageous to only mine archive logs and accept latency in event emission due to frequent revolving redo logs."},"logMiningArchiveLogOnlyScnPollIntervalMs":{"index":46,"kind":"parameter","displayName":"Log Mining Archive Log Only Scn Poll Interval Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The interval in milliseconds to wait between polls checking to see if the SCN is in the archive logs."},"logMiningBatchSizeDefault":{"index":47,"kind":"parameter","displayName":"Log Mining Batch Size Default","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":20000,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The starting SCN interval size that the connector will use for reading data from redo/archive logs."},"logMiningBatchSizeMax":{"index":48,"kind":"parameter","displayName":"Log Mining Batch Size Max","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":100000,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum SCN interval size that this connector will use when reading from redo/archive logs."},"logMiningBatchSizeMin":{"index":49,"kind":"parameter","displayName":"Log Mining Batch Size Min","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The minimum SCN interval size that this connector will try to read from redo/archive logs. Active batch size will be also increased/decreased by this amount for tuning connector throughput when needed."},"logMiningBufferDropOnStop":{"index":50,"kind":"parameter","displayName":"Log Mining Buffer Drop On Stop","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When set to true the underlying buffer cache is not retained when the connector is stopped. When set to false (the default), the buffer cache is retained across restarts."},"logMiningBufferInfinispanCacheEvents":{"index":51,"kind":"parameter","displayName":"Log Mining Buffer Infinispan Cache Events","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specifies the XML configuration for the Infinispan 'events' cache"},"logMiningBufferInfinispanCacheGlobal":{"index":52,"kind":"parameter","displayName":"Log Mining Buffer Infinispan Cache Global","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specifies the XML configuration for the Infinispan 'global' configuration"},"logMiningBufferInfinispanCacheProcessedTransactions":{"index":53,"kind":"parameter","displayName":"Log Mining Buffer Infinispan Cache Processed Transactions","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specifies the XML configuration for the Infinispan 'processed-transactions' cache"},"logMiningBufferInfinispanCacheSchemaChanges":{"index":54,"kind":"parameter","displayName":"Log Mining Buffer Infinispan Cache Schema Changes","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specifies the XML configuration for the Infinispan 'schema-changes' cache"},"logMiningBufferInfinispanCacheTransactions":{"index":55,"kind":"parameter","displayName":"Log Mining Buffer Infinispan Cache Transactions","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specifies the XML configuration for the Infinispan 'transactions' cache"},"logMiningBufferTransactionEventsThreshold":{"index":56,"kind":"parameter","displayName":"Log Mining Buffer Transaction Events Threshold","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of events a transaction can include before the transaction is discarded. This is useful for managing buffer memory and/or space when dealing with very large transactions. Defaults to 0, meaning that no threshold is applied and transactions can have unlimited events."},"logMiningBufferType":{"index":57,"kind":"parameter","displayName":"Log Mining Buffer Type","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"memory","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The buffer type controls how the connector manages buffering transaction data. memory - Uses the JVM process' heap to buffer all transaction data. infinispan_embedded - This option uses an embedded Infinispan cache to buffer transaction data and persist it to disk. infinispan_remote - This option uses a remote Infinispan cluster to buffer transaction data and persist it to disk."},"logMiningFlushTableName":{"index":58,"kind":"parameter","displayName":"Log Mining Flush Table Name","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"LOG_MINING_FLUSH","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the flush table used by the connector, defaults to LOG_MINING_FLUSH."},"logMiningIncludeRedoSql":{"index":59,"kind":"parameter","displayName":"Log Mining Include Redo Sql","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When enabled, the transaction log REDO SQL will be included in the source information block."},"logMiningQueryFilterMode":{"index":60,"kind":"parameter","displayName":"Log Mining Query Filter Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specifies how the filter configuration is applied to the LogMiner database query. none - The query does not apply any schema or table filters, all filtering is at runtime by the connector. in - The query uses SQL in-clause expressions to specify the schema or table filters. regex - The query uses Oracle REGEXP_LIKE expressions to specify the schema or table filters."},"logMiningRestartConnection":{"index":61,"kind":"parameter","displayName":"Log Mining Restart Connection","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Debezium opens a database connection and keeps that connection open throughout the entire streaming phase. In some situations, this can lead to excessive SGA memory usage. By setting this option to 'true' (the default is 'false'), the connector will close and re-open a database connection after every detected log switch or if the log.mining.session.max.ms has been reached."},"logMiningScnGapDetectionGapSizeMin":{"index":62,"kind":"parameter","displayName":"Log Mining Scn Gap Detection Gap Size Min","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000000,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Used for SCN gap detection, if the difference between current SCN and previous end SCN is bigger than this value, and the time difference of current SCN and previous end SCN is smaller than log.mining.scn.gap.detection.time.interval.max.ms, consider it a SCN gap."},"logMiningScnGapDetectionTimeIntervalMaxMs":{"index":63,"kind":"parameter","displayName":"Log Mining Scn Gap Detection Time Interval Max Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20s","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Used for SCN gap detection, if the difference between current SCN and previous end SCN is bigger than log.mining.scn.gap.detection.gap.size.min, and the time difference of current SCN and previous end SCN is smaller than this value, consider it a SCN gap."},"logMiningSessionMaxMs":{"index":64,"kind":"parameter","displayName":"Log Mining Session Max Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of milliseconds that a LogMiner session lives for before being restarted. Defaults to 0 (indefinite until a log switch occurs)"},"logMiningSleepTimeDefaultMs":{"index":65,"kind":"parameter","displayName":"Log Mining Sleep Time Default Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1s","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The amount of time that the connector will sleep after reading data from redo/archive logs and before starting reading data again. Value is in milliseconds."},"logMiningSleepTimeIncrementMs":{"index":66,"kind":"parameter","displayName":"Log Mining Sleep Time Increment Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"200ms","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum amount of time that the connector will use to tune the optimal sleep time when reading data from LogMiner. Value is in milliseconds."},"logMiningSleepTimeMaxMs":{"index":67,"kind":"parameter","displayName":"Log Mining Sleep Time Max Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3s","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum amount of time that the connector will sleep after reading data from redo/archive logs and before starting reading data again. Value is in milliseconds."},"logMiningSleepTimeMinMs":{"index":68,"kind":"parameter","displayName":"Log Mining Sleep Time Min Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The minimum amount of time that the connector will sleep after reading data from redo/archive logs and before starting reading data again. Value is in milliseconds."},"logMiningStrategy":{"index":69,"kind":"parameter","displayName":"Log Mining Strategy","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"redo_log_catalog","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"There are strategies: Online catalog with faster mining but no captured DDL. Another - with data dictionary loaded into REDO LOG files"},"logMiningTransactionRetentionMs":{"index":70,"kind":"parameter","displayName":"Log Mining Transaction Retention Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Duration in milliseconds to keep long running transactions in transaction buffer between log mining sessions. By default, all transactions are retained."},"logMiningUsernameExcludeList":{"index":71,"kind":"parameter","displayName":"Log Mining Username Exclude List","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Comma separated list of usernames to exclude from LogMiner query."},"logMiningUsernameIncludeList":{"index":72,"kind":"parameter","displayName":"Log Mining Username Include List","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Comma separated list of usernames to include from LogMiner query."},"maxBatchSize":{"index":73,"kind":"parameter","displayName":"Max Batch Size","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of each batch of source records. Defaults to 2048."},"maxQueueSize":{"index":74,"kind":"parameter","displayName":"Max Queue Size","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size."},"maxQueueSizeInBytes":{"index":75,"kind":"parameter","displayName":"Max Queue Size In Bytes","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled"},"messageKeyColumns":{"index":76,"kind":"parameter","displayName":"Message Key Columns","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':', where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector, and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key. Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id"},"notificationEnabledChannels":{"index":77,"kind":"parameter","displayName":"Notification Enabled Channels","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of notification channels names that are enabled."},"notificationSinkTopicName":{"index":78,"kind":"parameter","displayName":"Notification Sink Topic Name","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels"},"openlogreplicatorHost":{"index":79,"kind":"parameter","displayName":"Openlogreplicator Host","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The hostname of the OpenLogReplicator network service"},"openlogreplicatorPort":{"index":80,"kind":"parameter","displayName":"Openlogreplicator Port","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The port of the OpenLogReplicator network service"},"openlogreplicatorSource":{"index":81,"kind":"parameter","displayName":"Openlogreplicator Source","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The configured logical source name in the OpenLogReplicator configuration that is to stream changes"},"pollIntervalMs":{"index":82,"kind":"parameter","displayName":"Poll Interval Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500ms","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms."},"postProcessors":{"index":83,"kind":"parameter","displayName":"Post Processors","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of post processors. The processors are defined using '.type' config option and configured using options ''"},"provideTransactionMetadata":{"index":84,"kind":"parameter","displayName":"Provide Transaction Metadata","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Enables transaction metadata extraction together with event counting"},"queryFetchSize":{"index":85,"kind":"parameter","displayName":"Query Fetch Size","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size, defaults to '2000'."},"racNodes":{"index":86,"kind":"parameter","displayName":"Rac Nodes","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of RAC node hostnames or ip addresses"},"retriableRestartConnectorWaitMs":{"index":87,"kind":"parameter","displayName":"Retriable Restart Connector Wait Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms."},"schemaHistoryInternal":{"index":88,"kind":"parameter","displayName":"Schema History Internal","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.storage.kafka.history.KafkaSchemaHistory","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SchemaHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'schema.history.internal.' string."},"schemaHistoryInternalFileFilename":{"index":89,"kind":"parameter","displayName":"Schema History Internal File Filename","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The path to the file that will be used to record the database schema history"},"schemaHistoryInternalSkipUnparseableDdl":{"index":90,"kind":"parameter","displayName":"Schema History Internal Skip Unparseable Ddl","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes."},"schemaHistoryInternalStoreOnlyCapturedDatabasesDdl":{"index":91,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Databases Ddl","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (true) only DDL that manipulates a table from captured schema/database will be stored. If set to false, then Debezium will store all incoming DDL statements."},"schemaHistoryInternalStoreOnlyCapturedTablesDdl":{"index":92,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Tables Ddl","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a captured table will be stored."},"schemaNameAdjustmentMode":{"index":93,"kind":"parameter","displayName":"Schema Name Adjustment Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)"},"signalDataCollection":{"index":94,"kind":"parameter","displayName":"Signal Data Collection","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set."},"signalEnabledChannels":{"index":95,"kind":"parameter","displayName":"Signal Enabled Channels","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"source","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of channels names that are enabled. Source channel is enabled by default"},"signalPollIntervalMs":{"index":96,"kind":"parameter","displayName":"Signal Poll Interval Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds."},"skippedOperations":{"index":97,"kind":"parameter","displayName":"Skipped Operations","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"t","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped."},"snapshotDatabaseErrorsMaxRetries":{"index":98,"kind":"parameter","displayName":"Snapshot Database Errors Max Retries","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of attempts to retry database errors during snapshots before failing."},"snapshotDelayMs":{"index":99,"kind":"parameter","displayName":"Snapshot Delay Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms."},"snapshotFetchSize":{"index":100,"kind":"parameter","displayName":"Snapshot Fetch Size","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while performing a snapshot."},"snapshotIncludeCollectionList":{"index":101,"kind":"parameter","displayName":"Snapshot Include Collection List","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector."},"snapshotLockingMode":{"index":102,"kind":"parameter","displayName":"Snapshot Locking Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"shared","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls how the connector holds locks on tables while performing the schema snapshot. The default is 'shared', which means the connector will hold a table lock that prevents exclusive table access for just the initial portion of the snapshot while the database schemas and other metadata are being read. The remaining work in a snapshot involves selecting all rows from each table, and this is done using a flashback query that requires no locks. However, in some cases it may be desirable to avoid locks entirely which can be done by specifying 'none'. This mode is only safe to use if no schema changes are happening while the snapshot is taken."},"snapshotLockTimeoutMs":{"index":103,"kind":"parameter","displayName":"Snapshot Lock Timeout Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds"},"snapshotMaxThreads":{"index":104,"kind":"parameter","displayName":"Snapshot Max Threads","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of threads used to perform the snapshot. Defaults to 1."},"snapshotMode":{"index":105,"kind":"parameter","displayName":"Snapshot Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"initial","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'always': The connector runs a snapshot every time that it starts. After the snapshot completes, the connector begins to stream changes from the redo logs.; 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the redo logs. 'initial_only': The connector performs a snapshot as it does for the 'initial' option, but after the connector completes the snapshot, it stops, and does not stream changes from the redo logs.; 'schema_only': If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures only the schema (table structures), but not any table data. After the snapshot completes, the connector begins to stream changes from the redo logs.; 'schema_only_recovery': The connector performs a snapshot that captures only the database schema history. The connector then transitions to streaming from the redo logs. Use this setting to restore a corrupted or lost database schema history topic. Do not use if the database schema was modified after the connector stopped."},"snapshotModeConfigurationBasedSnapshotData":{"index":106,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Data","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not."},"snapshotModeConfigurationBasedSnapshotOnDataError":{"index":107,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Data Error","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotOnSchemaError":{"index":108,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Schema Error","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotSchema":{"index":109,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Schema","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not."},"snapshotModeConfigurationBasedStartStream":{"index":110,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Start Stream","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot."},"snapshotModeCustomName":{"index":111,"kind":"parameter","displayName":"Snapshot Mode Custom Name","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot."},"snapshotSelectStatementOverrides":{"index":112,"kind":"parameter","displayName":"Snapshot Select Statement Overrides","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connectors. Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted."},"snapshotTablesOrderByRowCount":{"index":113,"kind":"parameter","displayName":"Snapshot Tables Order By Row Count","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"disabled","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the order in which tables are processed in the initial snapshot. A descending value will order the tables by row count descending. A ascending value will order the tables by row count ascending. A value of disabled (the default) will disable ordering by row count."},"sourceinfoStructMaker":{"index":114,"kind":"parameter","displayName":"Sourceinfo Struct Maker","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.connector.oracle.OracleSourceInfoStructMaker","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct."},"streamingDelayMs":{"index":115,"kind":"parameter","displayName":"Streaming Delay Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms."},"tableExcludeList":{"index":116,"kind":"parameter","displayName":"Table Exclude List","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring"},"tableIncludeList":{"index":117,"kind":"parameter","displayName":"Table Include List","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The tables for which changes are to be captured"},"timePrecisionMode":{"index":118,"kind":"parameter","displayName":"Time Precision Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"adaptive","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time, date, and timestamps can be represented with different kinds of precisions, including: 'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column's precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision; 'connect' always represents time, date, and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision."},"tombstonesOnDelete":{"index":119,"kind":"parameter","displayName":"Tombstones On Delete","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted."},"topicNamingStrategy":{"index":120,"kind":"parameter","displayName":"Topic Naming Strategy","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.schema.SchemaTopicNamingStrategy","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc."},"topicPrefix":{"index":121,"kind":"parameter","displayName":"Topic Prefix","group":"oracle","label":"consumer,oracle","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted."},"transactionMetadataFactory":{"index":122,"kind":"parameter","displayName":"Transaction Metadata Factory","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Class to make transaction context & transaction struct/schemas"},"unavailableValuePlaceholder":{"index":123,"kind":"parameter","displayName":"Unavailable Value Placeholder","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium_unavailable_value","configurationClass":"org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the constant that will be provided by Debezium to indicate that the original value is unavailable and not provided by the database."}}} +{"component":{"kind":"component","name":"debezium-oracle","title":"Debezium Oracle Connector","description":"Capture changes from an Oracle database.","deprecated":false,"firstVersion":"3.17.0","label":"database","javaType":"org.apache.camel.component.debezium.oracle.DebeziumOracleComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-debezium-oracle","version":"4.8.2","scheme":"debezium-oracle","extendsScheme":"","syntax":"debezium-oracle:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelDebeziumSourceMetadata":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_SOURCE_METADATA"},"CamelDebeziumIdentifier":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The identifier of the connector, normally is this format {server-name}.{database-name}.{table-name}.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_IDENTIFIER"},"CamelDebeziumKey":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the event, normally is the table Primary Key.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_KEY"},"CamelDebeziumOperation":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r for read (in the case of a initial sync) or in case of a snapshot event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_OPERATION"},"CamelDebeziumTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the time (using the system clock in the JVM) at which the connector processed the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_TIMESTAMP"},"CamelDebeziumBefore":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, contains the state of the row before the event occurred.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_BEFORE"},"CamelDebeziumDdlSQL":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the ddl sql text of the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_DDL_SQL"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Unique name for the connector. Attempting to register again with the same name will fail."},"additionalProperties":{"index":1,"kind":"parameter","displayName":"Additional Properties","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.Map","prefix":"additionalProperties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro"},"internalKeyConverter":{"index":2,"kind":"parameter","displayName":"Internal Key Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter."},"internalValueConverter":{"index":3,"kind":"parameter","displayName":"Internal Value Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter."},"offsetCommitPolicy":{"index":4,"kind":"parameter","displayName":"Offset Commit Policy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals."},"offsetCommitTimeoutMs":{"index":5,"kind":"parameter","displayName":"Offset Commit Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds."},"offsetFlushIntervalMs":{"index":6,"kind":"parameter","displayName":"Offset Flush Interval Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval at which to try committing offsets. The default is 1 minute."},"offsetStorage":{"index":7,"kind":"parameter","displayName":"Offset Storage","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.storage.FileOffsetBackingStore","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class that is responsible for persistence of connector offsets."},"offsetStorageFileName":{"index":8,"kind":"parameter","displayName":"Offset Storage File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore."},"offsetStoragePartitions":{"index":9,"kind":"parameter","displayName":"Offset Storage Partitions","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'."},"offsetStorageReplicationFactor":{"index":10,"kind":"parameter","displayName":"Offset Storage Replication Factor","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore"},"offsetStorageTopic":{"index":11,"kind":"parameter","displayName":"Offset Storage Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"archiveDestinationName":{"index":15,"kind":"parameter","displayName":"Archive Destination Name","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Sets the specific archive log destination as the source for reading archive logs.When not set, the connector will automatically select the first LOCAL and VALID destination."},"archiveLogHours":{"index":16,"kind":"parameter","displayName":"Archive Log Hours","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of hours in the past from SYSDATE to mine archive logs. Using 0 mines all available archive logs"},"binaryHandlingMode":{"index":17,"kind":"parameter","displayName":"Binary Handling Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"bytes","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how binary (blob, binary, etc.) columns should be represented in change events, including: 'bytes' represents binary data as byte array (default); 'base64' represents binary data as base64-encoded string; 'base64-url-safe' represents binary data as base64-url-safe-encoded string; 'hex' represents binary data as hex-encoded (base16) string"},"columnExcludeList":{"index":18,"kind":"parameter","displayName":"Column Exclude List","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to exclude from change events"},"columnIncludeList":{"index":19,"kind":"parameter","displayName":"Column Include List","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to include in change events"},"columnPropagateSourceType":{"index":20,"kind":"parameter","displayName":"Column Propagate Source Type","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records."},"converters":{"index":21,"kind":"parameter","displayName":"Converters","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'"},"customMetricTags":{"index":22,"kind":"parameter","displayName":"Custom Metric Tags","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2"},"databaseConnectionAdapter":{"index":23,"kind":"parameter","displayName":"Database Connection Adapter","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"LogMiner","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The adapter to use when capturing changes from the database. Options include: 'logminer': (the default) to capture changes using native Oracle LogMiner; 'xstream' to capture changes using Oracle XStreams"},"databaseDbname":{"index":24,"kind":"parameter","displayName":"Database Dbname","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the database from which the connector should capture changes"},"databaseHostname":{"index":25,"kind":"parameter","displayName":"Database Hostname","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Resolvable hostname or IP address of the database server."},"databaseOutServerName":{"index":26,"kind":"parameter","displayName":"Database Out Server Name","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Name of the XStream Out server to connect to."},"databasePassword":{"index":27,"kind":"parameter","displayName":"Database Password","group":"oracle","label":"consumer,oracle","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Password of the database user to be used when connecting to the database."},"databasePdbName":{"index":28,"kind":"parameter","displayName":"Database Pdb Name","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Name of the pluggable database when working with a multi-tenant set-up. The CDB name must be given via database.dbname in this case."},"databasePort":{"index":29,"kind":"parameter","displayName":"Database Port","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1528,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Port of the database server."},"databaseQueryTimeoutMs":{"index":30,"kind":"parameter","displayName":"Database Query Timeout Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10m","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for a query to execute, given in milliseconds. Defaults to 600 seconds (600,000 ms); zero means there is no limit."},"databaseUrl":{"index":31,"kind":"parameter","displayName":"Database Url","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Complete JDBC URL as an alternative to specifying hostname, port and database provided as a way to support alternative connection scenarios."},"databaseUser":{"index":32,"kind":"parameter","displayName":"Database User","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Name of the database user to be used when connecting to the database."},"datatypePropagateSourceType":{"index":33,"kind":"parameter","displayName":"Datatype Propagate Source Type","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching the database-specific data type names that adds the data type's original type and original length as parameters to the corresponding field schemas in the emitted change records."},"decimalHandlingMode":{"index":34,"kind":"parameter","displayName":"Decimal Handling Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"precise","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how DECIMAL and NUMERIC columns should be represented in change events, including: 'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers."},"errorsMaxRetries":{"index":35,"kind":"parameter","displayName":"Errors Max Retries","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries)."},"eventProcessingFailureHandlingMode":{"index":36,"kind":"parameter","displayName":"Event Processing Failure Handling Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped."},"heartbeatActionQuery":{"index":37,"kind":"parameter","displayName":"Heartbeat Action Query","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The query executed with every heartbeat."},"heartbeatIntervalMs":{"index":38,"kind":"parameter","displayName":"Heartbeat Interval Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default."},"heartbeatTopicsPrefix":{"index":39,"kind":"parameter","displayName":"Heartbeat Topics Prefix","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium-heartbeat","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat."},"includeSchemaChanges":{"index":40,"kind":"parameter","displayName":"Include Schema Changes","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s). The default is 'true'. This is independent of how the connector internally records database schema history."},"includeSchemaComments":{"index":41,"kind":"parameter","displayName":"Include Schema Comments","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector parse table and column's comment to metadata object. Note: Enable this option will bring the implications on memory usage. The number and size of ColumnImpl objects is what largely impacts how much memory is consumed by the Debezium connectors, and adding a String to each of them can potentially be quite heavy. The default is 'false'."},"incrementalSnapshotWatermarkingStrategy":{"index":42,"kind":"parameter","displayName":"Incremental Snapshot Watermarking Strategy","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INSERT_INSERT","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;"},"intervalHandlingMode":{"index":43,"kind":"parameter","displayName":"Interval Handling Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"numeric","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how INTERVAL columns should be represented in change events, including: 'string' represents values as an exact ISO formatted string; 'numeric' (default) represents values using the inexact conversion into microseconds"},"lobEnabled":{"index":44,"kind":"parameter","displayName":"Lob Enabled","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When set to 'false', the default, LOB fields will not be captured nor emitted. When set to 'true', the connector will capture LOB fields and emit changes for those fields like any other column type."},"logMiningArchiveLogOnlyMode":{"index":45,"kind":"parameter","displayName":"Log Mining Archive Log Only Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When set to 'false', the default, the connector will mine both archive log and redo logs to emit change events. When set to 'true', the connector will only mine archive logs. There are circumstances where its advantageous to only mine archive logs and accept latency in event emission due to frequent revolving redo logs."},"logMiningArchiveLogOnlyScnPollIntervalMs":{"index":46,"kind":"parameter","displayName":"Log Mining Archive Log Only Scn Poll Interval Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The interval in milliseconds to wait between polls checking to see if the SCN is in the archive logs."},"logMiningBatchSizeDefault":{"index":47,"kind":"parameter","displayName":"Log Mining Batch Size Default","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":20000,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The starting SCN interval size that the connector will use for reading data from redo/archive logs."},"logMiningBatchSizeMax":{"index":48,"kind":"parameter","displayName":"Log Mining Batch Size Max","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":100000,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum SCN interval size that this connector will use when reading from redo/archive logs."},"logMiningBatchSizeMin":{"index":49,"kind":"parameter","displayName":"Log Mining Batch Size Min","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The minimum SCN interval size that this connector will try to read from redo/archive logs. Active batch size will be also increased/decreased by this amount for tuning connector throughput when needed."},"logMiningBufferDropOnStop":{"index":50,"kind":"parameter","displayName":"Log Mining Buffer Drop On Stop","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When set to true the underlying buffer cache is not retained when the connector is stopped. When set to false (the default), the buffer cache is retained across restarts."},"logMiningBufferInfinispanCacheEvents":{"index":51,"kind":"parameter","displayName":"Log Mining Buffer Infinispan Cache Events","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specifies the XML configuration for the Infinispan 'events' cache"},"logMiningBufferInfinispanCacheGlobal":{"index":52,"kind":"parameter","displayName":"Log Mining Buffer Infinispan Cache Global","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specifies the XML configuration for the Infinispan 'global' configuration"},"logMiningBufferInfinispanCacheProcessedTransactions":{"index":53,"kind":"parameter","displayName":"Log Mining Buffer Infinispan Cache Processed Transactions","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specifies the XML configuration for the Infinispan 'processed-transactions' cache"},"logMiningBufferInfinispanCacheSchemaChanges":{"index":54,"kind":"parameter","displayName":"Log Mining Buffer Infinispan Cache Schema Changes","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specifies the XML configuration for the Infinispan 'schema-changes' cache"},"logMiningBufferInfinispanCacheTransactions":{"index":55,"kind":"parameter","displayName":"Log Mining Buffer Infinispan Cache Transactions","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specifies the XML configuration for the Infinispan 'transactions' cache"},"logMiningBufferTransactionEventsThreshold":{"index":56,"kind":"parameter","displayName":"Log Mining Buffer Transaction Events Threshold","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of events a transaction can include before the transaction is discarded. This is useful for managing buffer memory and/or space when dealing with very large transactions. Defaults to 0, meaning that no threshold is applied and transactions can have unlimited events."},"logMiningBufferType":{"index":57,"kind":"parameter","displayName":"Log Mining Buffer Type","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"memory","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The buffer type controls how the connector manages buffering transaction data. memory - Uses the JVM process' heap to buffer all transaction data. infinispan_embedded - This option uses an embedded Infinispan cache to buffer transaction data and persist it to disk. infinispan_remote - This option uses a remote Infinispan cluster to buffer transaction data and persist it to disk."},"logMiningFlushTableName":{"index":58,"kind":"parameter","displayName":"Log Mining Flush Table Name","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"LOG_MINING_FLUSH","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the flush table used by the connector, defaults to LOG_MINING_FLUSH."},"logMiningIncludeRedoSql":{"index":59,"kind":"parameter","displayName":"Log Mining Include Redo Sql","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When enabled, the transaction log REDO SQL will be included in the source information block."},"logMiningQueryFilterMode":{"index":60,"kind":"parameter","displayName":"Log Mining Query Filter Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specifies how the filter configuration is applied to the LogMiner database query. none - The query does not apply any schema or table filters, all filtering is at runtime by the connector. in - The query uses SQL in-clause expressions to specify the schema or table filters. regex - The query uses Oracle REGEXP_LIKE expressions to specify the schema or table filters."},"logMiningRestartConnection":{"index":61,"kind":"parameter","displayName":"Log Mining Restart Connection","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Debezium opens a database connection and keeps that connection open throughout the entire streaming phase. In some situations, this can lead to excessive SGA memory usage. By setting this option to 'true' (the default is 'false'), the connector will close and re-open a database connection after every detected log switch or if the log.mining.session.max.ms has been reached."},"logMiningScnGapDetectionGapSizeMin":{"index":62,"kind":"parameter","displayName":"Log Mining Scn Gap Detection Gap Size Min","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000000,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Used for SCN gap detection, if the difference between current SCN and previous end SCN is bigger than this value, and the time difference of current SCN and previous end SCN is smaller than log.mining.scn.gap.detection.time.interval.max.ms, consider it a SCN gap."},"logMiningScnGapDetectionTimeIntervalMaxMs":{"index":63,"kind":"parameter","displayName":"Log Mining Scn Gap Detection Time Interval Max Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20s","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Used for SCN gap detection, if the difference between current SCN and previous end SCN is bigger than log.mining.scn.gap.detection.gap.size.min, and the time difference of current SCN and previous end SCN is smaller than this value, consider it a SCN gap."},"logMiningSessionMaxMs":{"index":64,"kind":"parameter","displayName":"Log Mining Session Max Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of milliseconds that a LogMiner session lives for before being restarted. Defaults to 0 (indefinite until a log switch occurs)"},"logMiningSleepTimeDefaultMs":{"index":65,"kind":"parameter","displayName":"Log Mining Sleep Time Default Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1s","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The amount of time that the connector will sleep after reading data from redo/archive logs and before starting reading data again. Value is in milliseconds."},"logMiningSleepTimeIncrementMs":{"index":66,"kind":"parameter","displayName":"Log Mining Sleep Time Increment Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"200ms","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum amount of time that the connector will use to tune the optimal sleep time when reading data from LogMiner. Value is in milliseconds."},"logMiningSleepTimeMaxMs":{"index":67,"kind":"parameter","displayName":"Log Mining Sleep Time Max Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3s","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum amount of time that the connector will sleep after reading data from redo/archive logs and before starting reading data again. Value is in milliseconds."},"logMiningSleepTimeMinMs":{"index":68,"kind":"parameter","displayName":"Log Mining Sleep Time Min Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The minimum amount of time that the connector will sleep after reading data from redo/archive logs and before starting reading data again. Value is in milliseconds."},"logMiningStrategy":{"index":69,"kind":"parameter","displayName":"Log Mining Strategy","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"redo_log_catalog","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"There are strategies: Online catalog with faster mining but no captured DDL. Another - with data dictionary loaded into REDO LOG files"},"logMiningTransactionRetentionMs":{"index":70,"kind":"parameter","displayName":"Log Mining Transaction Retention Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Duration in milliseconds to keep long running transactions in transaction buffer between log mining sessions. By default, all transactions are retained."},"logMiningUsernameExcludeList":{"index":71,"kind":"parameter","displayName":"Log Mining Username Exclude List","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Comma separated list of usernames to exclude from LogMiner query."},"logMiningUsernameIncludeList":{"index":72,"kind":"parameter","displayName":"Log Mining Username Include List","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Comma separated list of usernames to include from LogMiner query."},"maxBatchSize":{"index":73,"kind":"parameter","displayName":"Max Batch Size","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of each batch of source records. Defaults to 2048."},"maxQueueSize":{"index":74,"kind":"parameter","displayName":"Max Queue Size","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size."},"maxQueueSizeInBytes":{"index":75,"kind":"parameter","displayName":"Max Queue Size In Bytes","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled"},"messageKeyColumns":{"index":76,"kind":"parameter","displayName":"Message Key Columns","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':', where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector, and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key. Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id"},"notificationEnabledChannels":{"index":77,"kind":"parameter","displayName":"Notification Enabled Channels","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of notification channels names that are enabled."},"notificationSinkTopicName":{"index":78,"kind":"parameter","displayName":"Notification Sink Topic Name","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels"},"openlogreplicatorHost":{"index":79,"kind":"parameter","displayName":"Openlogreplicator Host","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The hostname of the OpenLogReplicator network service"},"openlogreplicatorPort":{"index":80,"kind":"parameter","displayName":"Openlogreplicator Port","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The port of the OpenLogReplicator network service"},"openlogreplicatorSource":{"index":81,"kind":"parameter","displayName":"Openlogreplicator Source","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The configured logical source name in the OpenLogReplicator configuration that is to stream changes"},"pollIntervalMs":{"index":82,"kind":"parameter","displayName":"Poll Interval Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500ms","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms."},"postProcessors":{"index":83,"kind":"parameter","displayName":"Post Processors","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of post processors. The processors are defined using '.type' config option and configured using options ''"},"provideTransactionMetadata":{"index":84,"kind":"parameter","displayName":"Provide Transaction Metadata","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Enables transaction metadata extraction together with event counting"},"queryFetchSize":{"index":85,"kind":"parameter","displayName":"Query Fetch Size","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size, defaults to '2000'."},"racNodes":{"index":86,"kind":"parameter","displayName":"Rac Nodes","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of RAC node hostnames or ip addresses"},"retriableRestartConnectorWaitMs":{"index":87,"kind":"parameter","displayName":"Retriable Restart Connector Wait Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms."},"schemaHistoryInternal":{"index":88,"kind":"parameter","displayName":"Schema History Internal","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.storage.kafka.history.KafkaSchemaHistory","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SchemaHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'schema.history.internal.' string."},"schemaHistoryInternalFileFilename":{"index":89,"kind":"parameter","displayName":"Schema History Internal File Filename","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The path to the file that will be used to record the database schema history"},"schemaHistoryInternalSkipUnparseableDdl":{"index":90,"kind":"parameter","displayName":"Schema History Internal Skip Unparseable Ddl","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes."},"schemaHistoryInternalStoreOnlyCapturedDatabasesDdl":{"index":91,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Databases Ddl","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (true) only DDL that manipulates a table from captured schema/database will be stored. If set to false, then Debezium will store all incoming DDL statements."},"schemaHistoryInternalStoreOnlyCapturedTablesDdl":{"index":92,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Tables Ddl","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a captured table will be stored."},"schemaNameAdjustmentMode":{"index":93,"kind":"parameter","displayName":"Schema Name Adjustment Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)"},"signalDataCollection":{"index":94,"kind":"parameter","displayName":"Signal Data Collection","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set."},"signalEnabledChannels":{"index":95,"kind":"parameter","displayName":"Signal Enabled Channels","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"source","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of channels names that are enabled. Source channel is enabled by default"},"signalPollIntervalMs":{"index":96,"kind":"parameter","displayName":"Signal Poll Interval Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds."},"skippedOperations":{"index":97,"kind":"parameter","displayName":"Skipped Operations","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"t","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped."},"snapshotDatabaseErrorsMaxRetries":{"index":98,"kind":"parameter","displayName":"Snapshot Database Errors Max Retries","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of attempts to retry database errors during snapshots before failing."},"snapshotDelayMs":{"index":99,"kind":"parameter","displayName":"Snapshot Delay Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms."},"snapshotFetchSize":{"index":100,"kind":"parameter","displayName":"Snapshot Fetch Size","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while performing a snapshot."},"snapshotIncludeCollectionList":{"index":101,"kind":"parameter","displayName":"Snapshot Include Collection List","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector."},"snapshotLockingMode":{"index":102,"kind":"parameter","displayName":"Snapshot Locking Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"shared","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls how the connector holds locks on tables while performing the schema snapshot. The default is 'shared', which means the connector will hold a table lock that prevents exclusive table access for just the initial portion of the snapshot while the database schemas and other metadata are being read. The remaining work in a snapshot involves selecting all rows from each table, and this is done using a flashback query that requires no locks. However, in some cases it may be desirable to avoid locks entirely which can be done by specifying 'none'. This mode is only safe to use if no schema changes are happening while the snapshot is taken."},"snapshotLockTimeoutMs":{"index":103,"kind":"parameter","displayName":"Snapshot Lock Timeout Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds"},"snapshotMaxThreads":{"index":104,"kind":"parameter","displayName":"Snapshot Max Threads","group":"oracle","label":"consumer,oracle","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of threads used to perform the snapshot. Defaults to 1."},"snapshotMode":{"index":105,"kind":"parameter","displayName":"Snapshot Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"initial","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'always': The connector runs a snapshot every time that it starts. After the snapshot completes, the connector begins to stream changes from the redo logs.; 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the redo logs. 'initial_only': The connector performs a snapshot as it does for the 'initial' option, but after the connector completes the snapshot, it stops, and does not stream changes from the redo logs.; 'schema_only': If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures only the schema (table structures), but not any table data. After the snapshot completes, the connector begins to stream changes from the redo logs.; 'schema_only_recovery': The connector performs a snapshot that captures only the database schema history. The connector then transitions to streaming from the redo logs. Use this setting to restore a corrupted or lost database schema history topic. Do not use if the database schema was modified after the connector stopped."},"snapshotModeConfigurationBasedSnapshotData":{"index":106,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Data","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not."},"snapshotModeConfigurationBasedSnapshotOnDataError":{"index":107,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Data Error","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotOnSchemaError":{"index":108,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Schema Error","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotSchema":{"index":109,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Schema","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not."},"snapshotModeConfigurationBasedStartStream":{"index":110,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Start Stream","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot."},"snapshotModeCustomName":{"index":111,"kind":"parameter","displayName":"Snapshot Mode Custom Name","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot."},"snapshotSelectStatementOverrides":{"index":112,"kind":"parameter","displayName":"Snapshot Select Statement Overrides","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connectors. Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted."},"snapshotTablesOrderByRowCount":{"index":113,"kind":"parameter","displayName":"Snapshot Tables Order By Row Count","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"disabled","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the order in which tables are processed in the initial snapshot. A descending value will order the tables by row count descending. A ascending value will order the tables by row count ascending. A value of disabled (the default) will disable ordering by row count."},"sourceinfoStructMaker":{"index":114,"kind":"parameter","displayName":"Sourceinfo Struct Maker","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.connector.oracle.OracleSourceInfoStructMaker","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct."},"streamingDelayMs":{"index":115,"kind":"parameter","displayName":"Streaming Delay Ms","group":"oracle","label":"consumer,oracle","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms."},"tableExcludeList":{"index":116,"kind":"parameter","displayName":"Table Exclude List","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring"},"tableIncludeList":{"index":117,"kind":"parameter","displayName":"Table Include List","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The tables for which changes are to be captured"},"timePrecisionMode":{"index":118,"kind":"parameter","displayName":"Time Precision Mode","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"adaptive","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time, date, and timestamps can be represented with different kinds of precisions, including: 'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column's precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision; 'connect' always represents time, date, and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision."},"tombstonesOnDelete":{"index":119,"kind":"parameter","displayName":"Tombstones On Delete","group":"oracle","label":"consumer,oracle","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted."},"topicNamingStrategy":{"index":120,"kind":"parameter","displayName":"Topic Naming Strategy","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.schema.SchemaTopicNamingStrategy","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc."},"topicPrefix":{"index":121,"kind":"parameter","displayName":"Topic Prefix","group":"oracle","label":"consumer,oracle","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted."},"transactionMetadataFactory":{"index":122,"kind":"parameter","displayName":"Transaction Metadata Factory","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Class to make transaction context & transaction struct/schemas"},"unavailableValuePlaceholder":{"index":123,"kind":"parameter","displayName":"Unavailable Value Placeholder","group":"oracle","label":"consumer,oracle","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium_unavailable_value","configurationClass":"org.apache.camel.component.debezium.oracle.configuration.OracleConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the constant that will be provided by Debezium to indicate that the original value is unavailable and not provided by the database."}}} , -{"component":{"kind":"component","name":"debezium-postgres","title":"Debezium PostgresSQL Connector","description":"Capture changes from a PostgresSQL database.","deprecated":false,"firstVersion":"3.0.0","label":"database","javaType":"org.apache.camel.component.debezium.DebeziumPostgresComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-debezium-postgres","version":"4.8.1","scheme":"debezium-postgres","extendsScheme":"","syntax":"debezium-postgres:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelDebeziumSourceMetadata":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_SOURCE_METADATA"},"CamelDebeziumIdentifier":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The identifier of the connector, normally is this format {server-name}.{database-name}.{table-name}.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_IDENTIFIER"},"CamelDebeziumKey":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the event, normally is the table Primary Key.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_KEY"},"CamelDebeziumOperation":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r for read (in the case of a initial sync) or in case of a snapshot event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_OPERATION"},"CamelDebeziumTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the time (using the system clock in the JVM) at which the connector processed the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_TIMESTAMP"},"CamelDebeziumBefore":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, contains the state of the row before the event occurred.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_BEFORE"},"CamelDebeziumDdlSQL":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the ddl sql text of the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_DDL_SQL"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Unique name for the connector. Attempting to register again with the same name will fail."},"additionalProperties":{"index":1,"kind":"parameter","displayName":"Additional Properties","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.Map","prefix":"additionalProperties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro"},"internalKeyConverter":{"index":2,"kind":"parameter","displayName":"Internal Key Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter."},"internalValueConverter":{"index":3,"kind":"parameter","displayName":"Internal Value Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter."},"offsetCommitPolicy":{"index":4,"kind":"parameter","displayName":"Offset Commit Policy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals."},"offsetCommitTimeoutMs":{"index":5,"kind":"parameter","displayName":"Offset Commit Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds."},"offsetFlushIntervalMs":{"index":6,"kind":"parameter","displayName":"Offset Flush Interval Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval at which to try committing offsets. The default is 1 minute."},"offsetStorage":{"index":7,"kind":"parameter","displayName":"Offset Storage","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.storage.FileOffsetBackingStore","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class that is responsible for persistence of connector offsets."},"offsetStorageFileName":{"index":8,"kind":"parameter","displayName":"Offset Storage File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore."},"offsetStoragePartitions":{"index":9,"kind":"parameter","displayName":"Offset Storage Partitions","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'."},"offsetStorageReplicationFactor":{"index":10,"kind":"parameter","displayName":"Offset Storage Replication Factor","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore"},"offsetStorageTopic":{"index":11,"kind":"parameter","displayName":"Offset Storage Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"binaryHandlingMode":{"index":15,"kind":"parameter","displayName":"Binary Handling Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"bytes","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how binary (blob, binary, etc.) columns should be represented in change events, including: 'bytes' represents binary data as byte array (default); 'base64' represents binary data as base64-encoded string; 'base64-url-safe' represents binary data as base64-url-safe-encoded string; 'hex' represents binary data as hex-encoded (base16) string"},"columnExcludeList":{"index":16,"kind":"parameter","displayName":"Column Exclude List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to exclude from change events"},"columnIncludeList":{"index":17,"kind":"parameter","displayName":"Column Include List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to include in change events"},"columnPropagateSourceType":{"index":18,"kind":"parameter","displayName":"Column Propagate Source Type","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records."},"converters":{"index":19,"kind":"parameter","displayName":"Converters","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'"},"customMetricTags":{"index":20,"kind":"parameter","displayName":"Custom Metric Tags","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2"},"databaseDbname":{"index":21,"kind":"parameter","displayName":"Database Dbname","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the database from which the connector should capture changes"},"databaseHostname":{"index":22,"kind":"parameter","displayName":"Database Hostname","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Resolvable hostname or IP address of the database server."},"databaseInitialStatements":{"index":23,"kind":"parameter","displayName":"Database Initial Statements","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A semicolon separated list of SQL statements to be executed when a JDBC connection to the database is established. Note that the connector may establish JDBC connections at its own discretion, so this should typically be used for configuration of session parameters only, but not for executing DML statements. Use doubled semicolon (';;') to use a semicolon as a character and not as a delimiter."},"databasePassword":{"index":24,"kind":"parameter","displayName":"Database Password","group":"postgres","label":"consumer,postgres","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Password of the database user to be used when connecting to the database."},"databasePort":{"index":25,"kind":"parameter","displayName":"Database Port","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5432,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Port of the database server."},"databaseQueryTimeoutMs":{"index":26,"kind":"parameter","displayName":"Database Query Timeout Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10m","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for a query to execute, given in milliseconds. Defaults to 600 seconds (600,000 ms); zero means there is no limit."},"databaseSslcert":{"index":27,"kind":"parameter","displayName":"Database Sslcert","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"File containing the SSL Certificate for the client. See the Postgres SSL docs for further information"},"databaseSslfactory":{"index":28,"kind":"parameter","displayName":"Database Sslfactory","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A name of class to that creates SSL Sockets. Use org.postgresql.ssl.NonValidatingFactory to disable SSL validation in development environments"},"databaseSslkey":{"index":29,"kind":"parameter","displayName":"Database Sslkey","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"File containing the SSL private key for the client. See the Postgres SSL docs for further information"},"databaseSslmode":{"index":30,"kind":"parameter","displayName":"Database Sslmode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"prefer","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether to use an encrypted connection to Postgres. Options include: 'disable' (the default) to use an unencrypted connection; 'allow' to try and use an unencrypted connection first and, failing that, a secure (encrypted) connection; 'prefer' (the default) to try and use a secure (encrypted) connection first and, failing that, an unencrypted connection; 'require' to use a secure (encrypted) connection, and fail if one cannot be established; 'verify-ca' like 'required' but additionally verify the server TLS certificate against the configured Certificate Authority (CA) certificates, or fail if no valid matching CA certificates are found; or 'verify-full' like 'verify-ca' but additionally verify that the server certificate matches the host to which the connection is attempted."},"databaseSslpassword":{"index":31,"kind":"parameter","displayName":"Database Sslpassword","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Password to access the client private key from the file specified by 'database.sslkey'. See the Postgres SSL docs for further information"},"databaseSslrootcert":{"index":32,"kind":"parameter","displayName":"Database Sslrootcert","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"File containing the root certificate(s) against which the server is validated. See the Postgres JDBC SSL docs for further information"},"databaseTcpkeepalive":{"index":33,"kind":"parameter","displayName":"Database Tcpkeepalive","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Enable or disable TCP keep-alive probe to avoid dropping TCP connection"},"databaseUser":{"index":34,"kind":"parameter","displayName":"Database User","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Name of the database user to be used when connecting to the database."},"datatypePropagateSourceType":{"index":35,"kind":"parameter","displayName":"Datatype Propagate Source Type","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching the database-specific data type names that adds the data type's original type and original length as parameters to the corresponding field schemas in the emitted change records."},"decimalHandlingMode":{"index":36,"kind":"parameter","displayName":"Decimal Handling Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"precise","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how DECIMAL and NUMERIC columns should be represented in change events, including: 'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers."},"errorsMaxRetries":{"index":37,"kind":"parameter","displayName":"Errors Max Retries","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries)."},"eventProcessingFailureHandlingMode":{"index":38,"kind":"parameter","displayName":"Event Processing Failure Handling Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped."},"flushLsnSource":{"index":39,"kind":"parameter","displayName":"Flush Lsn Source","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Boolean to determine if Debezium should flush LSN in the source postgres database. If set to false, user will have to flush the LSN manually outside Debezium."},"heartbeatActionQuery":{"index":40,"kind":"parameter","displayName":"Heartbeat Action Query","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The query executed with every heartbeat."},"heartbeatIntervalMs":{"index":41,"kind":"parameter","displayName":"Heartbeat Interval Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default."},"heartbeatTopicsPrefix":{"index":42,"kind":"parameter","displayName":"Heartbeat Topics Prefix","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium-heartbeat","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat."},"hstoreHandlingMode":{"index":43,"kind":"parameter","displayName":"Hstore Handling Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"json","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how HSTORE columns should be represented in change events, including: 'json' represents values as string-ified JSON (default); 'map' represents values as a key/value map"},"includeSchemaComments":{"index":44,"kind":"parameter","displayName":"Include Schema Comments","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector parse table and column's comment to metadata object. Note: Enable this option will bring the implications on memory usage. The number and size of ColumnImpl objects is what largely impacts how much memory is consumed by the Debezium connectors, and adding a String to each of them can potentially be quite heavy. The default is 'false'."},"includeUnknownDatatypes":{"index":45,"kind":"parameter","displayName":"Include Unknown Datatypes","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify whether the fields of data type not supported by Debezium should be processed: 'false' (the default) omits the fields; 'true' converts the field into an implementation dependent binary representation."},"incrementalSnapshotChunkSize":{"index":46,"kind":"parameter","displayName":"Incremental Snapshot Chunk Size","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum size of chunk (number of documents/rows) for incremental snapshotting"},"incrementalSnapshotWatermarkingStrategy":{"index":47,"kind":"parameter","displayName":"Incremental Snapshot Watermarking Strategy","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INSERT_INSERT","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;"},"intervalHandlingMode":{"index":48,"kind":"parameter","displayName":"Interval Handling Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"numeric","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how INTERVAL columns should be represented in change events, including: 'string' represents values as an exact ISO formatted string; 'numeric' (default) represents values using the inexact conversion into microseconds"},"maxBatchSize":{"index":49,"kind":"parameter","displayName":"Max Batch Size","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of each batch of source records. Defaults to 2048."},"maxQueueSize":{"index":50,"kind":"parameter","displayName":"Max Queue Size","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size."},"maxQueueSizeInBytes":{"index":51,"kind":"parameter","displayName":"Max Queue Size In Bytes","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled"},"messageKeyColumns":{"index":52,"kind":"parameter","displayName":"Message Key Columns","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':', where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector, and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key. Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id"},"messagePrefixExcludeList":{"index":53,"kind":"parameter","displayName":"Message Prefix Exclude List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match the logical decoding message prefixes to be excluded from monitoring."},"messagePrefixIncludeList":{"index":54,"kind":"parameter","displayName":"Message Prefix Include List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match the logical decoding message prefixes to be monitored. All prefixes are monitored by default."},"notificationEnabledChannels":{"index":55,"kind":"parameter","displayName":"Notification Enabled Channels","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of notification channels names that are enabled."},"notificationSinkTopicName":{"index":56,"kind":"parameter","displayName":"Notification Sink Topic Name","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels"},"pluginName":{"index":57,"kind":"parameter","displayName":"Plugin Name","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"decoderbufs","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Postgres logical decoding plugin installed on the server. Supported values are 'decoderbufs' and 'pgoutput'. Defaults to 'decoderbufs'."},"pollIntervalMs":{"index":58,"kind":"parameter","displayName":"Poll Interval Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500ms","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms."},"postProcessors":{"index":59,"kind":"parameter","displayName":"Post Processors","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of post processors. The processors are defined using '.type' config option and configured using options ''"},"provideTransactionMetadata":{"index":60,"kind":"parameter","displayName":"Provide Transaction Metadata","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Enables transaction metadata extraction together with event counting"},"publicationAutocreateMode":{"index":61,"kind":"parameter","displayName":"Publication Autocreate Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"all_tables","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Applies only when streaming changes using pgoutput.Determine how creation of a publication should work, the default is all_tables.DISABLED - The connector will not attempt to create a publication at all. The expectation is that the user has created the publication up-front. If the publication isn't found to exist upon startup, the connector will throw an exception and stop.ALL_TABLES - If no publication exists, the connector will create a new publication for all tables. Note this requires that the configured user has access. If the publication already exists, it will be used. i.e CREATE PUBLICATION FOR ALL TABLES;FILTERED - If no publication exists, the connector will create a new publication for all those tables matchingthe current filter configuration (see table/database include/exclude list properties). If the publication already exists, it will be used. i.e CREATE PUBLICATION FOR TABLE"},"publicationName":{"index":62,"kind":"parameter","displayName":"Publication Name","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"dbz_publication","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Postgres 10 publication used for streaming changes from a plugin. Defaults to 'dbz_publication'"},"queryFetchSize":{"index":63,"kind":"parameter","displayName":"Query Fetch Size","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size."},"replicaIdentityAutosetValues":{"index":64,"kind":"parameter","displayName":"Replica Identity Autoset Values","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Applies only when streaming changes using pgoutput.Determines the value for Replica Identity at table level. This option will overwrite the existing value in databaseA comma-separated list of regular expressions that match fully-qualified tables and Replica Identity value to be used in the table. Each expression must match the pattern ':', where the table names could be defined as (SCHEMA_NAME.TABLE_NAME), and the replica identity values are: DEFAULT - Records the old values of the columns of the primary key, if any. This is the default for non-system tables.INDEX index_name - Records the old values of the columns covered by the named index, that must be unique, not partial, not deferrable, and include only columns marked NOT NULL. If this index is dropped, the behavior is the same as NOTHING.FULL - Records the old values of all columns in the row.NOTHING - Records no information about the old row. This is the default for system tables."},"retriableRestartConnectorWaitMs":{"index":65,"kind":"parameter","displayName":"Retriable Restart Connector Wait Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms."},"schemaExcludeList":{"index":66,"kind":"parameter","displayName":"Schema Exclude List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The schemas for which events must not be captured"},"schemaHistoryInternalFileFilename":{"index":67,"kind":"parameter","displayName":"Schema History Internal File Filename","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The path to the file that will be used to record the database schema history"},"schemaIncludeList":{"index":68,"kind":"parameter","displayName":"Schema Include List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The schemas for which events should be captured"},"schemaNameAdjustmentMode":{"index":69,"kind":"parameter","displayName":"Schema Name Adjustment Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)"},"schemaRefreshMode":{"index":70,"kind":"parameter","displayName":"Schema Refresh Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"columns_diff","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the conditions that trigger a refresh of the in-memory schema for a table. 'columns_diff' (the default) is the safest mode, ensuring the in-memory schema stays in-sync with the database table's schema at all times. 'columns_diff_exclude_unchanged_toast' instructs the connector to refresh the in-memory schema cache if there is a discrepancy between it and the schema derived from the incoming message, unless unchanged TOASTable data fully accounts for the discrepancy. This setting can improve connector performance significantly if there are frequently-updated tables that have TOASTed data that are rarely part of these updates. However, it is possible for the in-memory schema to become outdated if TOASTable columns are dropped from the table."},"signalDataCollection":{"index":71,"kind":"parameter","displayName":"Signal Data Collection","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set."},"signalEnabledChannels":{"index":72,"kind":"parameter","displayName":"Signal Enabled Channels","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"source","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of channels names that are enabled. Source channel is enabled by default"},"signalPollIntervalMs":{"index":73,"kind":"parameter","displayName":"Signal Poll Interval Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds."},"skippedOperations":{"index":74,"kind":"parameter","displayName":"Skipped Operations","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"t","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped."},"slotDropOnStop":{"index":75,"kind":"parameter","displayName":"Slot Drop On Stop","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether or not to drop the logical replication slot when the connector finishes orderly. By default the replication is kept so that on restart progress can resume from the last recorded location"},"slotMaxRetries":{"index":76,"kind":"parameter","displayName":"Slot Max Retries","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":6,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"How many times to retry connecting to a replication slot when an attempt fails."},"slotName":{"index":77,"kind":"parameter","displayName":"Slot Name","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"debezium","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Postgres logical decoding slot created for streaming changes from a plugin. Defaults to 'debezium"},"slotRetryDelayMs":{"index":78,"kind":"parameter","displayName":"Slot Retry Delay Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait between retry attempts when the connector fails to connect to a replication slot, given in milliseconds. Defaults to 10 seconds (10,000 ms)."},"slotStreamParams":{"index":79,"kind":"parameter","displayName":"Slot Stream Params","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Any optional parameters used by logical decoding plugin. Semi-colon separated. E.g. 'add-tables=public.table,public.table2;include-lsn=true'"},"snapshotDelayMs":{"index":80,"kind":"parameter","displayName":"Snapshot Delay Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms."},"snapshotFetchSize":{"index":81,"kind":"parameter","displayName":"Snapshot Fetch Size","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while performing a snapshot."},"snapshotIncludeCollectionList":{"index":82,"kind":"parameter","displayName":"Snapshot Include Collection List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector."},"snapshotLockingMode":{"index":83,"kind":"parameter","displayName":"Snapshot Locking Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls how the connector holds locks on tables while performing the schema snapshot. The 'shared' which means the connector will hold a table lock that prevents exclusive table access for just the initial portion of the snapshot while the database schemas and other metadata are being read. The remaining work in a snapshot involves selecting all rows from each table, and this is done using a flashback query that requires no locks. However, in some cases it may be desirable to avoid locks entirely which can be done by specifying 'none'. This mode is only safe to use if no schema changes are happening while the snapshot is taken."},"snapshotLockingModeCustomName":{"index":84,"kind":"parameter","displayName":"Snapshot Locking Mode Custom Name","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.locking.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'SnapshotterLocking' interface and is called to determine how to lock tables during schema snapshot."},"snapshotLockTimeoutMs":{"index":85,"kind":"parameter","displayName":"Snapshot Lock Timeout Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds"},"snapshotMaxThreads":{"index":86,"kind":"parameter","displayName":"Snapshot Max Threads","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of threads used to perform the snapshot. Defaults to 1."},"snapshotMode":{"index":87,"kind":"parameter","displayName":"Snapshot Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"initial","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'always': The connector runs a snapshot every time that it starts. After the snapshot completes, the connector begins to stream changes from the transaction log.; 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the transaction log. 'initial_only': The connector performs a snapshot as it does for the 'initial' option, but after the connector completes the snapshot, it stops, and does not stream changes from the transaction log.; 'never': The connector does not run a snapshot. Upon first startup, the connector immediately begins reading from the beginning of the transaction log. 'exported': This option is deprecated; use 'initial' instead.; 'custom': The connector loads a custom class to specify how the connector performs snapshots. For more information, see Custom snapshotter SPI in the PostgreSQL connector documentation."},"snapshotModeConfigurationBasedSnapshotData":{"index":88,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Data","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not."},"snapshotModeConfigurationBasedSnapshotOnDataError":{"index":89,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Data Error","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotOnSchemaError":{"index":90,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Schema Error","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotSchema":{"index":91,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Schema","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not."},"snapshotModeConfigurationBasedStartStream":{"index":92,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Start Stream","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot."},"snapshotModeCustomName":{"index":93,"kind":"parameter","displayName":"Snapshot Mode Custom Name","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot."},"snapshotQueryMode":{"index":94,"kind":"parameter","displayName":"Snapshot Query Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"select_all","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls query used during the snapshot"},"snapshotQueryModeCustomName":{"index":95,"kind":"parameter","displayName":"Snapshot Query Mode Custom Name","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.query.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'SnapshotterQuery' interface and is called to determine how to build queries during snapshot."},"snapshotSelectStatementOverrides":{"index":96,"kind":"parameter","displayName":"Snapshot Select Statement Overrides","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connectors. Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted."},"snapshotTablesOrderByRowCount":{"index":97,"kind":"parameter","displayName":"Snapshot Tables Order By Row Count","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"disabled","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the order in which tables are processed in the initial snapshot. A descending value will order the tables by row count descending. A ascending value will order the tables by row count ascending. A value of disabled (the default) will disable ordering by row count."},"sourceinfoStructMaker":{"index":98,"kind":"parameter","displayName":"Sourceinfo Struct Maker","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.connector.postgresql.PostgresSourceInfoStructMaker","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct."},"statusUpdateIntervalMs":{"index":99,"kind":"parameter","displayName":"Status Update Interval Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Frequency for sending replication connection status updates to the server, given in milliseconds. Defaults to 10 seconds (10,000 ms)."},"streamingDelayMs":{"index":100,"kind":"parameter","displayName":"Streaming Delay Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms."},"tableExcludeList":{"index":101,"kind":"parameter","displayName":"Table Exclude List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring"},"tableIgnoreBuiltin":{"index":102,"kind":"parameter","displayName":"Table Ignore Builtin","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Flag specifying whether built-in tables should be ignored."},"tableIncludeList":{"index":103,"kind":"parameter","displayName":"Table Include List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The tables for which changes are to be captured"},"timePrecisionMode":{"index":104,"kind":"parameter","displayName":"Time Precision Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"adaptive","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time, date, and timestamps can be represented with different kinds of precisions, including: 'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column's precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision; 'connect' always represents time, date, and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision."},"tombstonesOnDelete":{"index":105,"kind":"parameter","displayName":"Tombstones On Delete","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted."},"topicNamingStrategy":{"index":106,"kind":"parameter","displayName":"Topic Naming Strategy","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.schema.SchemaTopicNamingStrategy","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc."},"topicPrefix":{"index":107,"kind":"parameter","displayName":"Topic Prefix","group":"postgres","label":"consumer,postgres","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted."},"transactionMetadataFactory":{"index":108,"kind":"parameter","displayName":"Transaction Metadata Factory","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Class to make transaction context & transaction struct/schemas"},"unavailableValuePlaceholder":{"index":109,"kind":"parameter","displayName":"Unavailable Value Placeholder","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium_unavailable_value","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the constant that will be provided by Debezium to indicate that the original value is a toasted value not provided by the database. If starts with 'hex:' prefix it is expected that the rest of the string represents hexadecimal encoded octets."},"xminFetchIntervalMs":{"index":110,"kind":"parameter","displayName":"Xmin Fetch Interval Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how often (in ms) the xmin will be fetched from the replication slot. This xmin value is exposed by the slot which gives a lower bound of where a new replication slot could start from. The lower the value, the more likely this value is to be the current 'true' value, but the bigger the performance cost. The bigger the value, the less likely this value is to be the current 'true' value, but the lower the performance penalty. The default is set to 0 ms, which disables tracking xmin."}}} +{"component":{"kind":"component","name":"debezium-postgres","title":"Debezium PostgresSQL Connector","description":"Capture changes from a PostgresSQL database.","deprecated":false,"firstVersion":"3.0.0","label":"database","javaType":"org.apache.camel.component.debezium.postgres.DebeziumPostgresComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-debezium-postgres","version":"4.8.2","scheme":"debezium-postgres","extendsScheme":"","syntax":"debezium-postgres:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelDebeziumSourceMetadata":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_SOURCE_METADATA"},"CamelDebeziumIdentifier":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The identifier of the connector, normally is this format {server-name}.{database-name}.{table-name}.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_IDENTIFIER"},"CamelDebeziumKey":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the event, normally is the table Primary Key.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_KEY"},"CamelDebeziumOperation":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r for read (in the case of a initial sync) or in case of a snapshot event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_OPERATION"},"CamelDebeziumTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the time (using the system clock in the JVM) at which the connector processed the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_TIMESTAMP"},"CamelDebeziumBefore":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, contains the state of the row before the event occurred.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_BEFORE"},"CamelDebeziumDdlSQL":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the ddl sql text of the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_DDL_SQL"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Unique name for the connector. Attempting to register again with the same name will fail."},"additionalProperties":{"index":1,"kind":"parameter","displayName":"Additional Properties","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.Map","prefix":"additionalProperties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro"},"internalKeyConverter":{"index":2,"kind":"parameter","displayName":"Internal Key Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter."},"internalValueConverter":{"index":3,"kind":"parameter","displayName":"Internal Value Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter."},"offsetCommitPolicy":{"index":4,"kind":"parameter","displayName":"Offset Commit Policy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals."},"offsetCommitTimeoutMs":{"index":5,"kind":"parameter","displayName":"Offset Commit Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds."},"offsetFlushIntervalMs":{"index":6,"kind":"parameter","displayName":"Offset Flush Interval Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval at which to try committing offsets. The default is 1 minute."},"offsetStorage":{"index":7,"kind":"parameter","displayName":"Offset Storage","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.storage.FileOffsetBackingStore","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class that is responsible for persistence of connector offsets."},"offsetStorageFileName":{"index":8,"kind":"parameter","displayName":"Offset Storage File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore."},"offsetStoragePartitions":{"index":9,"kind":"parameter","displayName":"Offset Storage Partitions","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'."},"offsetStorageReplicationFactor":{"index":10,"kind":"parameter","displayName":"Offset Storage Replication Factor","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore"},"offsetStorageTopic":{"index":11,"kind":"parameter","displayName":"Offset Storage Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"binaryHandlingMode":{"index":15,"kind":"parameter","displayName":"Binary Handling Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"bytes","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how binary (blob, binary, etc.) columns should be represented in change events, including: 'bytes' represents binary data as byte array (default); 'base64' represents binary data as base64-encoded string; 'base64-url-safe' represents binary data as base64-url-safe-encoded string; 'hex' represents binary data as hex-encoded (base16) string"},"columnExcludeList":{"index":16,"kind":"parameter","displayName":"Column Exclude List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to exclude from change events"},"columnIncludeList":{"index":17,"kind":"parameter","displayName":"Column Include List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to include in change events"},"columnPropagateSourceType":{"index":18,"kind":"parameter","displayName":"Column Propagate Source Type","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records."},"converters":{"index":19,"kind":"parameter","displayName":"Converters","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'"},"customMetricTags":{"index":20,"kind":"parameter","displayName":"Custom Metric Tags","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2"},"databaseDbname":{"index":21,"kind":"parameter","displayName":"Database Dbname","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the database from which the connector should capture changes"},"databaseHostname":{"index":22,"kind":"parameter","displayName":"Database Hostname","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Resolvable hostname or IP address of the database server."},"databaseInitialStatements":{"index":23,"kind":"parameter","displayName":"Database Initial Statements","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A semicolon separated list of SQL statements to be executed when a JDBC connection to the database is established. Note that the connector may establish JDBC connections at its own discretion, so this should typically be used for configuration of session parameters only, but not for executing DML statements. Use doubled semicolon (';;') to use a semicolon as a character and not as a delimiter."},"databasePassword":{"index":24,"kind":"parameter","displayName":"Database Password","group":"postgres","label":"consumer,postgres","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Password of the database user to be used when connecting to the database."},"databasePort":{"index":25,"kind":"parameter","displayName":"Database Port","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5432,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Port of the database server."},"databaseQueryTimeoutMs":{"index":26,"kind":"parameter","displayName":"Database Query Timeout Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10m","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for a query to execute, given in milliseconds. Defaults to 600 seconds (600,000 ms); zero means there is no limit."},"databaseSslcert":{"index":27,"kind":"parameter","displayName":"Database Sslcert","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"File containing the SSL Certificate for the client. See the Postgres SSL docs for further information"},"databaseSslfactory":{"index":28,"kind":"parameter","displayName":"Database Sslfactory","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A name of class to that creates SSL Sockets. Use org.postgresql.ssl.NonValidatingFactory to disable SSL validation in development environments"},"databaseSslkey":{"index":29,"kind":"parameter","displayName":"Database Sslkey","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"File containing the SSL private key for the client. See the Postgres SSL docs for further information"},"databaseSslmode":{"index":30,"kind":"parameter","displayName":"Database Sslmode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"prefer","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether to use an encrypted connection to Postgres. Options include: 'disable' (the default) to use an unencrypted connection; 'allow' to try and use an unencrypted connection first and, failing that, a secure (encrypted) connection; 'prefer' (the default) to try and use a secure (encrypted) connection first and, failing that, an unencrypted connection; 'require' to use a secure (encrypted) connection, and fail if one cannot be established; 'verify-ca' like 'required' but additionally verify the server TLS certificate against the configured Certificate Authority (CA) certificates, or fail if no valid matching CA certificates are found; or 'verify-full' like 'verify-ca' but additionally verify that the server certificate matches the host to which the connection is attempted."},"databaseSslpassword":{"index":31,"kind":"parameter","displayName":"Database Sslpassword","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Password to access the client private key from the file specified by 'database.sslkey'. See the Postgres SSL docs for further information"},"databaseSslrootcert":{"index":32,"kind":"parameter","displayName":"Database Sslrootcert","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"File containing the root certificate(s) against which the server is validated. See the Postgres JDBC SSL docs for further information"},"databaseTcpkeepalive":{"index":33,"kind":"parameter","displayName":"Database Tcpkeepalive","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Enable or disable TCP keep-alive probe to avoid dropping TCP connection"},"databaseUser":{"index":34,"kind":"parameter","displayName":"Database User","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Name of the database user to be used when connecting to the database."},"datatypePropagateSourceType":{"index":35,"kind":"parameter","displayName":"Datatype Propagate Source Type","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching the database-specific data type names that adds the data type's original type and original length as parameters to the corresponding field schemas in the emitted change records."},"decimalHandlingMode":{"index":36,"kind":"parameter","displayName":"Decimal Handling Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"precise","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how DECIMAL and NUMERIC columns should be represented in change events, including: 'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers."},"errorsMaxRetries":{"index":37,"kind":"parameter","displayName":"Errors Max Retries","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries)."},"eventProcessingFailureHandlingMode":{"index":38,"kind":"parameter","displayName":"Event Processing Failure Handling Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped."},"flushLsnSource":{"index":39,"kind":"parameter","displayName":"Flush Lsn Source","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Boolean to determine if Debezium should flush LSN in the source postgres database. If set to false, user will have to flush the LSN manually outside Debezium."},"heartbeatActionQuery":{"index":40,"kind":"parameter","displayName":"Heartbeat Action Query","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The query executed with every heartbeat."},"heartbeatIntervalMs":{"index":41,"kind":"parameter","displayName":"Heartbeat Interval Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default."},"heartbeatTopicsPrefix":{"index":42,"kind":"parameter","displayName":"Heartbeat Topics Prefix","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium-heartbeat","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat."},"hstoreHandlingMode":{"index":43,"kind":"parameter","displayName":"Hstore Handling Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"json","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how HSTORE columns should be represented in change events, including: 'json' represents values as string-ified JSON (default); 'map' represents values as a key/value map"},"includeSchemaComments":{"index":44,"kind":"parameter","displayName":"Include Schema Comments","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector parse table and column's comment to metadata object. Note: Enable this option will bring the implications on memory usage. The number and size of ColumnImpl objects is what largely impacts how much memory is consumed by the Debezium connectors, and adding a String to each of them can potentially be quite heavy. The default is 'false'."},"includeUnknownDatatypes":{"index":45,"kind":"parameter","displayName":"Include Unknown Datatypes","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify whether the fields of data type not supported by Debezium should be processed: 'false' (the default) omits the fields; 'true' converts the field into an implementation dependent binary representation."},"incrementalSnapshotChunkSize":{"index":46,"kind":"parameter","displayName":"Incremental Snapshot Chunk Size","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum size of chunk (number of documents/rows) for incremental snapshotting"},"incrementalSnapshotWatermarkingStrategy":{"index":47,"kind":"parameter","displayName":"Incremental Snapshot Watermarking Strategy","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INSERT_INSERT","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;"},"intervalHandlingMode":{"index":48,"kind":"parameter","displayName":"Interval Handling Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"numeric","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how INTERVAL columns should be represented in change events, including: 'string' represents values as an exact ISO formatted string; 'numeric' (default) represents values using the inexact conversion into microseconds"},"maxBatchSize":{"index":49,"kind":"parameter","displayName":"Max Batch Size","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of each batch of source records. Defaults to 2048."},"maxQueueSize":{"index":50,"kind":"parameter","displayName":"Max Queue Size","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size."},"maxQueueSizeInBytes":{"index":51,"kind":"parameter","displayName":"Max Queue Size In Bytes","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled"},"messageKeyColumns":{"index":52,"kind":"parameter","displayName":"Message Key Columns","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':', where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector, and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key. Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id"},"messagePrefixExcludeList":{"index":53,"kind":"parameter","displayName":"Message Prefix Exclude List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match the logical decoding message prefixes to be excluded from monitoring."},"messagePrefixIncludeList":{"index":54,"kind":"parameter","displayName":"Message Prefix Include List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match the logical decoding message prefixes to be monitored. All prefixes are monitored by default."},"notificationEnabledChannels":{"index":55,"kind":"parameter","displayName":"Notification Enabled Channels","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of notification channels names that are enabled."},"notificationSinkTopicName":{"index":56,"kind":"parameter","displayName":"Notification Sink Topic Name","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels"},"pluginName":{"index":57,"kind":"parameter","displayName":"Plugin Name","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"decoderbufs","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Postgres logical decoding plugin installed on the server. Supported values are 'decoderbufs' and 'pgoutput'. Defaults to 'decoderbufs'."},"pollIntervalMs":{"index":58,"kind":"parameter","displayName":"Poll Interval Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500ms","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms."},"postProcessors":{"index":59,"kind":"parameter","displayName":"Post Processors","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of post processors. The processors are defined using '.type' config option and configured using options ''"},"provideTransactionMetadata":{"index":60,"kind":"parameter","displayName":"Provide Transaction Metadata","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Enables transaction metadata extraction together with event counting"},"publicationAutocreateMode":{"index":61,"kind":"parameter","displayName":"Publication Autocreate Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"all_tables","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Applies only when streaming changes using pgoutput.Determine how creation of a publication should work, the default is all_tables.DISABLED - The connector will not attempt to create a publication at all. The expectation is that the user has created the publication up-front. If the publication isn't found to exist upon startup, the connector will throw an exception and stop.ALL_TABLES - If no publication exists, the connector will create a new publication for all tables. Note this requires that the configured user has access. If the publication already exists, it will be used. i.e CREATE PUBLICATION FOR ALL TABLES;FILTERED - If no publication exists, the connector will create a new publication for all those tables matchingthe current filter configuration (see table/database include/exclude list properties). If the publication already exists, it will be used. i.e CREATE PUBLICATION FOR TABLE"},"publicationName":{"index":62,"kind":"parameter","displayName":"Publication Name","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"dbz_publication","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Postgres 10 publication used for streaming changes from a plugin. Defaults to 'dbz_publication'"},"queryFetchSize":{"index":63,"kind":"parameter","displayName":"Query Fetch Size","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size."},"replicaIdentityAutosetValues":{"index":64,"kind":"parameter","displayName":"Replica Identity Autoset Values","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Applies only when streaming changes using pgoutput.Determines the value for Replica Identity at table level. This option will overwrite the existing value in databaseA comma-separated list of regular expressions that match fully-qualified tables and Replica Identity value to be used in the table. Each expression must match the pattern ':', where the table names could be defined as (SCHEMA_NAME.TABLE_NAME), and the replica identity values are: DEFAULT - Records the old values of the columns of the primary key, if any. This is the default for non-system tables.INDEX index_name - Records the old values of the columns covered by the named index, that must be unique, not partial, not deferrable, and include only columns marked NOT NULL. If this index is dropped, the behavior is the same as NOTHING.FULL - Records the old values of all columns in the row.NOTHING - Records no information about the old row. This is the default for system tables."},"retriableRestartConnectorWaitMs":{"index":65,"kind":"parameter","displayName":"Retriable Restart Connector Wait Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms."},"schemaExcludeList":{"index":66,"kind":"parameter","displayName":"Schema Exclude List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The schemas for which events must not be captured"},"schemaHistoryInternalFileFilename":{"index":67,"kind":"parameter","displayName":"Schema History Internal File Filename","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The path to the file that will be used to record the database schema history"},"schemaIncludeList":{"index":68,"kind":"parameter","displayName":"Schema Include List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The schemas for which events should be captured"},"schemaNameAdjustmentMode":{"index":69,"kind":"parameter","displayName":"Schema Name Adjustment Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)"},"schemaRefreshMode":{"index":70,"kind":"parameter","displayName":"Schema Refresh Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"columns_diff","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the conditions that trigger a refresh of the in-memory schema for a table. 'columns_diff' (the default) is the safest mode, ensuring the in-memory schema stays in-sync with the database table's schema at all times. 'columns_diff_exclude_unchanged_toast' instructs the connector to refresh the in-memory schema cache if there is a discrepancy between it and the schema derived from the incoming message, unless unchanged TOASTable data fully accounts for the discrepancy. This setting can improve connector performance significantly if there are frequently-updated tables that have TOASTed data that are rarely part of these updates. However, it is possible for the in-memory schema to become outdated if TOASTable columns are dropped from the table."},"signalDataCollection":{"index":71,"kind":"parameter","displayName":"Signal Data Collection","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set."},"signalEnabledChannels":{"index":72,"kind":"parameter","displayName":"Signal Enabled Channels","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"source","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of channels names that are enabled. Source channel is enabled by default"},"signalPollIntervalMs":{"index":73,"kind":"parameter","displayName":"Signal Poll Interval Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds."},"skippedOperations":{"index":74,"kind":"parameter","displayName":"Skipped Operations","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"t","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped."},"slotDropOnStop":{"index":75,"kind":"parameter","displayName":"Slot Drop On Stop","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether or not to drop the logical replication slot when the connector finishes orderly. By default the replication is kept so that on restart progress can resume from the last recorded location"},"slotMaxRetries":{"index":76,"kind":"parameter","displayName":"Slot Max Retries","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":6,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"How many times to retry connecting to a replication slot when an attempt fails."},"slotName":{"index":77,"kind":"parameter","displayName":"Slot Name","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"debezium","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Postgres logical decoding slot created for streaming changes from a plugin. Defaults to 'debezium"},"slotRetryDelayMs":{"index":78,"kind":"parameter","displayName":"Slot Retry Delay Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait between retry attempts when the connector fails to connect to a replication slot, given in milliseconds. Defaults to 10 seconds (10,000 ms)."},"slotStreamParams":{"index":79,"kind":"parameter","displayName":"Slot Stream Params","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Any optional parameters used by logical decoding plugin. Semi-colon separated. E.g. 'add-tables=public.table,public.table2;include-lsn=true'"},"snapshotDelayMs":{"index":80,"kind":"parameter","displayName":"Snapshot Delay Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms."},"snapshotFetchSize":{"index":81,"kind":"parameter","displayName":"Snapshot Fetch Size","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while performing a snapshot."},"snapshotIncludeCollectionList":{"index":82,"kind":"parameter","displayName":"Snapshot Include Collection List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector."},"snapshotLockingMode":{"index":83,"kind":"parameter","displayName":"Snapshot Locking Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls how the connector holds locks on tables while performing the schema snapshot. The 'shared' which means the connector will hold a table lock that prevents exclusive table access for just the initial portion of the snapshot while the database schemas and other metadata are being read. The remaining work in a snapshot involves selecting all rows from each table, and this is done using a flashback query that requires no locks. However, in some cases it may be desirable to avoid locks entirely which can be done by specifying 'none'. This mode is only safe to use if no schema changes are happening while the snapshot is taken."},"snapshotLockingModeCustomName":{"index":84,"kind":"parameter","displayName":"Snapshot Locking Mode Custom Name","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.locking.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'SnapshotterLocking' interface and is called to determine how to lock tables during schema snapshot."},"snapshotLockTimeoutMs":{"index":85,"kind":"parameter","displayName":"Snapshot Lock Timeout Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds"},"snapshotMaxThreads":{"index":86,"kind":"parameter","displayName":"Snapshot Max Threads","group":"postgres","label":"consumer,postgres","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of threads used to perform the snapshot. Defaults to 1."},"snapshotMode":{"index":87,"kind":"parameter","displayName":"Snapshot Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"initial","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'always': The connector runs a snapshot every time that it starts. After the snapshot completes, the connector begins to stream changes from the transaction log.; 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the transaction log. 'initial_only': The connector performs a snapshot as it does for the 'initial' option, but after the connector completes the snapshot, it stops, and does not stream changes from the transaction log.; 'never': The connector does not run a snapshot. Upon first startup, the connector immediately begins reading from the beginning of the transaction log. 'exported': This option is deprecated; use 'initial' instead.; 'custom': The connector loads a custom class to specify how the connector performs snapshots. For more information, see Custom snapshotter SPI in the PostgreSQL connector documentation."},"snapshotModeConfigurationBasedSnapshotData":{"index":88,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Data","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not."},"snapshotModeConfigurationBasedSnapshotOnDataError":{"index":89,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Data Error","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotOnSchemaError":{"index":90,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Schema Error","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotSchema":{"index":91,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Schema","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not."},"snapshotModeConfigurationBasedStartStream":{"index":92,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Start Stream","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot."},"snapshotModeCustomName":{"index":93,"kind":"parameter","displayName":"Snapshot Mode Custom Name","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot."},"snapshotQueryMode":{"index":94,"kind":"parameter","displayName":"Snapshot Query Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"select_all","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls query used during the snapshot"},"snapshotQueryModeCustomName":{"index":95,"kind":"parameter","displayName":"Snapshot Query Mode Custom Name","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.query.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'SnapshotterQuery' interface and is called to determine how to build queries during snapshot."},"snapshotSelectStatementOverrides":{"index":96,"kind":"parameter","displayName":"Snapshot Select Statement Overrides","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connectors. Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted."},"snapshotTablesOrderByRowCount":{"index":97,"kind":"parameter","displayName":"Snapshot Tables Order By Row Count","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"disabled","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the order in which tables are processed in the initial snapshot. A descending value will order the tables by row count descending. A ascending value will order the tables by row count ascending. A value of disabled (the default) will disable ordering by row count."},"sourceinfoStructMaker":{"index":98,"kind":"parameter","displayName":"Sourceinfo Struct Maker","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.connector.postgresql.PostgresSourceInfoStructMaker","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct."},"statusUpdateIntervalMs":{"index":99,"kind":"parameter","displayName":"Status Update Interval Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Frequency for sending replication connection status updates to the server, given in milliseconds. Defaults to 10 seconds (10,000 ms)."},"streamingDelayMs":{"index":100,"kind":"parameter","displayName":"Streaming Delay Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms."},"tableExcludeList":{"index":101,"kind":"parameter","displayName":"Table Exclude List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring"},"tableIgnoreBuiltin":{"index":102,"kind":"parameter","displayName":"Table Ignore Builtin","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Flag specifying whether built-in tables should be ignored."},"tableIncludeList":{"index":103,"kind":"parameter","displayName":"Table Include List","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The tables for which changes are to be captured"},"timePrecisionMode":{"index":104,"kind":"parameter","displayName":"Time Precision Mode","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"adaptive","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time, date, and timestamps can be represented with different kinds of precisions, including: 'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column's precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision; 'connect' always represents time, date, and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision."},"tombstonesOnDelete":{"index":105,"kind":"parameter","displayName":"Tombstones On Delete","group":"postgres","label":"consumer,postgres","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted."},"topicNamingStrategy":{"index":106,"kind":"parameter","displayName":"Topic Naming Strategy","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.schema.SchemaTopicNamingStrategy","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc."},"topicPrefix":{"index":107,"kind":"parameter","displayName":"Topic Prefix","group":"postgres","label":"consumer,postgres","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted."},"transactionMetadataFactory":{"index":108,"kind":"parameter","displayName":"Transaction Metadata Factory","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Class to make transaction context & transaction struct/schemas"},"unavailableValuePlaceholder":{"index":109,"kind":"parameter","displayName":"Unavailable Value Placeholder","group":"postgres","label":"consumer,postgres","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium_unavailable_value","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the constant that will be provided by Debezium to indicate that the original value is a toasted value not provided by the database. If starts with 'hex:' prefix it is expected that the rest of the string represents hexadecimal encoded octets."},"xminFetchIntervalMs":{"index":110,"kind":"parameter","displayName":"Xmin Fetch Interval Ms","group":"postgres","label":"consumer,postgres","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.postgres.configuration.PostgresConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how often (in ms) the xmin will be fetched from the replication slot. This xmin value is exposed by the slot which gives a lower bound of where a new replication slot could start from. The lower the value, the more likely this value is to be the current 'true' value, but the bigger the performance cost. The bigger the value, the less likely this value is to be the current 'true' value, but the lower the performance penalty. The default is set to 0 ms, which disables tracking xmin."}}} , -{"component":{"kind":"component","name":"debezium-sqlserver","title":"Debezium SQL Server Connector","description":"Capture changes from an SQL Server database.","deprecated":false,"firstVersion":"3.0.0","label":"database","javaType":"org.apache.camel.component.debezium.DebeziumSqlserverComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-debezium-sqlserver","version":"4.8.1","scheme":"debezium-sqlserver","extendsScheme":"","syntax":"debezium-sqlserver:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelDebeziumSourceMetadata":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_SOURCE_METADATA"},"CamelDebeziumIdentifier":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The identifier of the connector, normally is this format {server-name}.{database-name}.{table-name}.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_IDENTIFIER"},"CamelDebeziumKey":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the event, normally is the table Primary Key.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_KEY"},"CamelDebeziumOperation":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r for read (in the case of a initial sync) or in case of a snapshot event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_OPERATION"},"CamelDebeziumTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the time (using the system clock in the JVM) at which the connector processed the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_TIMESTAMP"},"CamelDebeziumBefore":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, contains the state of the row before the event occurred.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_BEFORE"},"CamelDebeziumDdlSQL":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the ddl sql text of the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_DDL_SQL"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Unique name for the connector. Attempting to register again with the same name will fail."},"additionalProperties":{"index":1,"kind":"parameter","displayName":"Additional Properties","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.Map","prefix":"additionalProperties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro"},"internalKeyConverter":{"index":2,"kind":"parameter","displayName":"Internal Key Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter."},"internalValueConverter":{"index":3,"kind":"parameter","displayName":"Internal Value Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter."},"offsetCommitPolicy":{"index":4,"kind":"parameter","displayName":"Offset Commit Policy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals."},"offsetCommitTimeoutMs":{"index":5,"kind":"parameter","displayName":"Offset Commit Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds."},"offsetFlushIntervalMs":{"index":6,"kind":"parameter","displayName":"Offset Flush Interval Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval at which to try committing offsets. The default is 1 minute."},"offsetStorage":{"index":7,"kind":"parameter","displayName":"Offset Storage","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.storage.FileOffsetBackingStore","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class that is responsible for persistence of connector offsets."},"offsetStorageFileName":{"index":8,"kind":"parameter","displayName":"Offset Storage File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore."},"offsetStoragePartitions":{"index":9,"kind":"parameter","displayName":"Offset Storage Partitions","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'."},"offsetStorageReplicationFactor":{"index":10,"kind":"parameter","displayName":"Offset Storage Replication Factor","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore"},"offsetStorageTopic":{"index":11,"kind":"parameter","displayName":"Offset Storage Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"binaryHandlingMode":{"index":15,"kind":"parameter","displayName":"Binary Handling Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"bytes","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how binary (blob, binary, etc.) columns should be represented in change events, including: 'bytes' represents binary data as byte array (default); 'base64' represents binary data as base64-encoded string; 'base64-url-safe' represents binary data as base64-url-safe-encoded string; 'hex' represents binary data as hex-encoded (base16) string"},"columnExcludeList":{"index":16,"kind":"parameter","displayName":"Column Exclude List","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to exclude from change events"},"columnIncludeList":{"index":17,"kind":"parameter","displayName":"Column Include List","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to include in change events"},"columnPropagateSourceType":{"index":18,"kind":"parameter","displayName":"Column Propagate Source Type","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records."},"converters":{"index":19,"kind":"parameter","displayName":"Converters","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'"},"customMetricTags":{"index":20,"kind":"parameter","displayName":"Custom Metric Tags","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2"},"databaseHostname":{"index":21,"kind":"parameter","displayName":"Database Hostname","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Resolvable hostname or IP address of the database server."},"databaseInstance":{"index":22,"kind":"parameter","displayName":"Database Instance","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The SQL Server instance name"},"databaseNames":{"index":23,"kind":"parameter","displayName":"Database Names","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The names of the databases from which the connector should capture changes"},"databasePassword":{"index":24,"kind":"parameter","displayName":"Database Password","group":"sqlserver","label":"consumer,sqlserver","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Password of the database user to be used when connecting to the database."},"databasePort":{"index":25,"kind":"parameter","displayName":"Database Port","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1433,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Port of the database server."},"databaseQueryTimeoutMs":{"index":26,"kind":"parameter","displayName":"Database Query Timeout Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10m","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for a query to execute, given in milliseconds. Defaults to 600 seconds (600,000 ms); zero means there is no limit."},"databaseUser":{"index":27,"kind":"parameter","displayName":"Database User","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Name of the database user to be used when connecting to the database."},"dataQueryMode":{"index":28,"kind":"parameter","displayName":"Data Query Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"function","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls how the connector queries CDC data. The default is 'function', which means the data is queried by means of calling cdc.fn_cdc_get_all_changes_# function. The value of 'direct' makes the connector to query the change tables directly."},"datatypePropagateSourceType":{"index":29,"kind":"parameter","displayName":"Datatype Propagate Source Type","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching the database-specific data type names that adds the data type's original type and original length as parameters to the corresponding field schemas in the emitted change records."},"decimalHandlingMode":{"index":30,"kind":"parameter","displayName":"Decimal Handling Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"precise","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how DECIMAL and NUMERIC columns should be represented in change events, including: 'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers."},"errorsMaxRetries":{"index":31,"kind":"parameter","displayName":"Errors Max Retries","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries)."},"eventProcessingFailureHandlingMode":{"index":32,"kind":"parameter","displayName":"Event Processing Failure Handling Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped."},"heartbeatActionQuery":{"index":33,"kind":"parameter","displayName":"Heartbeat Action Query","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The query executed with every heartbeat."},"heartbeatIntervalMs":{"index":34,"kind":"parameter","displayName":"Heartbeat Interval Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default."},"heartbeatTopicsPrefix":{"index":35,"kind":"parameter","displayName":"Heartbeat Topics Prefix","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium-heartbeat","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat."},"includeSchemaChanges":{"index":36,"kind":"parameter","displayName":"Include Schema Changes","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s). The default is 'true'. This is independent of how the connector internally records database schema history."},"includeSchemaComments":{"index":37,"kind":"parameter","displayName":"Include Schema Comments","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector parse table and column's comment to metadata object. Note: Enable this option will bring the implications on memory usage. The number and size of ColumnImpl objects is what largely impacts how much memory is consumed by the Debezium connectors, and adding a String to each of them can potentially be quite heavy. The default is 'false'."},"incrementalSnapshotAllowSchemaChanges":{"index":38,"kind":"parameter","displayName":"Incremental Snapshot Allow Schema Changes","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Detect schema change during an incremental snapshot and re-select a current chunk to avoid locking DDLs. Note that changes to a primary key are not supported and can cause incorrect results if performed during an incremental snapshot. Another limitation is that if a schema change affects only columns' default values, then the change won't be detected until the DDL is processed from the binlog stream. This doesn't affect the snapshot events' values, but the schema of snapshot events may have outdated defaults."},"incrementalSnapshotChunkSize":{"index":39,"kind":"parameter","displayName":"Incremental Snapshot Chunk Size","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum size of chunk (number of documents/rows) for incremental snapshotting"},"incrementalSnapshotOptionRecompile":{"index":40,"kind":"parameter","displayName":"Incremental Snapshot Option Recompile","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Add OPTION(RECOMPILE) on each SELECT statement during the incremental snapshot process. This prevents parameter sniffing but can cause CPU pressure on the source database."},"incrementalSnapshotWatermarkingStrategy":{"index":41,"kind":"parameter","displayName":"Incremental Snapshot Watermarking Strategy","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INSERT_INSERT","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;"},"maxBatchSize":{"index":42,"kind":"parameter","displayName":"Max Batch Size","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of each batch of source records. Defaults to 2048."},"maxIterationTransactions":{"index":43,"kind":"parameter","displayName":"Max Iteration Transactions","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This property can be used to reduce the connector memory usage footprint when changes are streamed from multiple tables per database."},"maxQueueSize":{"index":44,"kind":"parameter","displayName":"Max Queue Size","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size."},"maxQueueSizeInBytes":{"index":45,"kind":"parameter","displayName":"Max Queue Size In Bytes","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled"},"messageKeyColumns":{"index":46,"kind":"parameter","displayName":"Message Key Columns","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':', where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector, and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key. Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id"},"notificationEnabledChannels":{"index":47,"kind":"parameter","displayName":"Notification Enabled Channels","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of notification channels names that are enabled."},"notificationSinkTopicName":{"index":48,"kind":"parameter","displayName":"Notification Sink Topic Name","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels"},"pollIntervalMs":{"index":49,"kind":"parameter","displayName":"Poll Interval Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500ms","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms."},"postProcessors":{"index":50,"kind":"parameter","displayName":"Post Processors","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of post processors. The processors are defined using '.type' config option and configured using options ''"},"provideTransactionMetadata":{"index":51,"kind":"parameter","displayName":"Provide Transaction Metadata","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Enables transaction metadata extraction together with event counting"},"retriableRestartConnectorWaitMs":{"index":52,"kind":"parameter","displayName":"Retriable Restart Connector Wait Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms."},"schemaHistoryInternal":{"index":53,"kind":"parameter","displayName":"Schema History Internal","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.storage.kafka.history.KafkaSchemaHistory","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SchemaHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'schema.history.internal.' string."},"schemaHistoryInternalFileFilename":{"index":54,"kind":"parameter","displayName":"Schema History Internal File Filename","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The path to the file that will be used to record the database schema history"},"schemaHistoryInternalSkipUnparseableDdl":{"index":55,"kind":"parameter","displayName":"Schema History Internal Skip Unparseable Ddl","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes."},"schemaHistoryInternalStoreOnlyCapturedDatabasesDdl":{"index":56,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Databases Ddl","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (true) only DDL that manipulates a table from captured schema/database will be stored. If set to false, then Debezium will store all incoming DDL statements."},"schemaHistoryInternalStoreOnlyCapturedTablesDdl":{"index":57,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Tables Ddl","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a captured table will be stored."},"schemaNameAdjustmentMode":{"index":58,"kind":"parameter","displayName":"Schema Name Adjustment Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)"},"signalDataCollection":{"index":59,"kind":"parameter","displayName":"Signal Data Collection","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set."},"signalEnabledChannels":{"index":60,"kind":"parameter","displayName":"Signal Enabled Channels","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"source","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of channels names that are enabled. Source channel is enabled by default"},"signalPollIntervalMs":{"index":61,"kind":"parameter","displayName":"Signal Poll Interval Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds."},"skippedOperations":{"index":62,"kind":"parameter","displayName":"Skipped Operations","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"t","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped."},"snapshotDelayMs":{"index":63,"kind":"parameter","displayName":"Snapshot Delay Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms."},"snapshotFetchSize":{"index":64,"kind":"parameter","displayName":"Snapshot Fetch Size","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while performing a snapshot."},"snapshotIncludeCollectionList":{"index":65,"kind":"parameter","displayName":"Snapshot Include Collection List","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector."},"snapshotIsolationMode":{"index":66,"kind":"parameter","displayName":"Snapshot Isolation Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"repeatable_read","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls which transaction isolation level is used and how long the connector locks the captured tables. The default is 'repeatable_read', which means that repeatable read isolation level is used. In addition, type of acquired lock during schema snapshot depends on snapshot.locking.mode property. Using a value of 'exclusive' ensures that the connector holds the type of lock specified with snapshot.locking.mode property (and thus prevents any reads and updates) for all captured tables during the entire snapshot duration. When 'snapshot' is specified, connector runs the initial snapshot in SNAPSHOT isolation level, which guarantees snapshot consistency. In addition, neither table nor row-level locks are held. When 'read_committed' is specified, connector runs the initial snapshot in READ COMMITTED isolation level. No long-running locks are taken, so that initial snapshot does not prevent other transactions from updating table rows. Snapshot consistency is not guaranteed.In 'read_uncommitted' mode neither table nor row-level locks are acquired, but connector does not guarantee snapshot consistency."},"snapshotLockTimeoutMs":{"index":67,"kind":"parameter","displayName":"Snapshot Lock Timeout Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds"},"snapshotMaxThreads":{"index":68,"kind":"parameter","displayName":"Snapshot Max Threads","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of threads used to perform the snapshot. Defaults to 1."},"snapshotMode":{"index":69,"kind":"parameter","displayName":"Snapshot Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"initial","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the transaction log.; 'initial_only': The connector performs a snapshot as it does for the 'initial' option, but after the connector completes the snapshot, it stops, and does not stream changes from the transaction log.; 'schema_only': If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures only the schema (table structures), but not any table data. After the snapshot completes, the connector begins to stream changes from the transaction log."},"snapshotModeConfigurationBasedSnapshotData":{"index":70,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Data","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not."},"snapshotModeConfigurationBasedSnapshotOnDataError":{"index":71,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Data Error","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotOnSchemaError":{"index":72,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Schema Error","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotSchema":{"index":73,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Schema","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not."},"snapshotModeConfigurationBasedStartStream":{"index":74,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Start Stream","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot."},"snapshotModeCustomName":{"index":75,"kind":"parameter","displayName":"Snapshot Mode Custom Name","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot."},"snapshotSelectStatementOverrides":{"index":76,"kind":"parameter","displayName":"Snapshot Select Statement Overrides","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connectors. Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted."},"snapshotTablesOrderByRowCount":{"index":77,"kind":"parameter","displayName":"Snapshot Tables Order By Row Count","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"disabled","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the order in which tables are processed in the initial snapshot. A descending value will order the tables by row count descending. A ascending value will order the tables by row count ascending. A value of disabled (the default) will disable ordering by row count."},"sourceinfoStructMaker":{"index":78,"kind":"parameter","displayName":"Sourceinfo Struct Maker","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.connector.sqlserver.SqlServerSourceInfoStructMaker","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct."},"streamingDelayMs":{"index":79,"kind":"parameter","displayName":"Streaming Delay Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms."},"tableExcludeList":{"index":80,"kind":"parameter","displayName":"Table Exclude List","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring"},"tableIgnoreBuiltin":{"index":81,"kind":"parameter","displayName":"Table Ignore Builtin","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Flag specifying whether built-in tables should be ignored."},"tableIncludeList":{"index":82,"kind":"parameter","displayName":"Table Include List","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The tables for which changes are to be captured"},"timePrecisionMode":{"index":83,"kind":"parameter","displayName":"Time Precision Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"adaptive","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time, date, and timestamps can be represented with different kinds of precisions, including: 'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column's precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision; 'connect' always represents time, date, and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision."},"tombstonesOnDelete":{"index":84,"kind":"parameter","displayName":"Tombstones On Delete","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted."},"topicNamingStrategy":{"index":85,"kind":"parameter","displayName":"Topic Naming Strategy","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.schema.SchemaTopicNamingStrategy","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc."},"topicPrefix":{"index":86,"kind":"parameter","displayName":"Topic Prefix","group":"sqlserver","label":"consumer,sqlserver","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted."},"transactionMetadataFactory":{"index":87,"kind":"parameter","displayName":"Transaction Metadata Factory","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory","configurationClass":"org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Class to make transaction context & transaction struct/schemas"}}} +{"component":{"kind":"component","name":"debezium-sqlserver","title":"Debezium SQL Server Connector","description":"Capture changes from an SQL Server database.","deprecated":false,"firstVersion":"3.0.0","label":"database","javaType":"org.apache.camel.component.debezium.sqlserver.DebeziumSqlserverComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-debezium-sqlserver","version":"4.8.2","scheme":"debezium-sqlserver","extendsScheme":"","syntax":"debezium-sqlserver:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelDebeziumSourceMetadata":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_SOURCE_METADATA"},"CamelDebeziumIdentifier":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The identifier of the connector, normally is this format {server-name}.{database-name}.{table-name}.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_IDENTIFIER"},"CamelDebeziumKey":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the event, normally is the table Primary Key.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_KEY"},"CamelDebeziumOperation":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r for read (in the case of a initial sync) or in case of a snapshot event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_OPERATION"},"CamelDebeziumTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the time (using the system clock in the JVM) at which the connector processed the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_TIMESTAMP"},"CamelDebeziumBefore":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Struct","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, contains the state of the row before the event occurred.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_BEFORE"},"CamelDebeziumDdlSQL":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If presents, the ddl sql text of the event.","constantName":"org.apache.camel.component.debezium.DebeziumConstants#HEADER_DDL_SQL"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Unique name for the connector. Attempting to register again with the same name will fail."},"additionalProperties":{"index":1,"kind":"parameter","displayName":"Additional Properties","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.Map","prefix":"additionalProperties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro"},"internalKeyConverter":{"index":2,"kind":"parameter","displayName":"Internal Key Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter."},"internalValueConverter":{"index":3,"kind":"parameter","displayName":"Internal Value Converter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.json.JsonConverter","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter."},"offsetCommitPolicy":{"index":4,"kind":"parameter","displayName":"Offset Commit Policy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals."},"offsetCommitTimeoutMs":{"index":5,"kind":"parameter","displayName":"Offset Commit Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds."},"offsetFlushIntervalMs":{"index":6,"kind":"parameter","displayName":"Offset Flush Interval Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval at which to try committing offsets. The default is 1 minute."},"offsetStorage":{"index":7,"kind":"parameter","displayName":"Offset Storage","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.connect.storage.FileOffsetBackingStore","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Java class that is responsible for persistence of connector offsets."},"offsetStorageFileName":{"index":8,"kind":"parameter","displayName":"Offset Storage File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore."},"offsetStoragePartitions":{"index":9,"kind":"parameter","displayName":"Offset Storage Partitions","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'."},"offsetStorageReplicationFactor":{"index":10,"kind":"parameter","displayName":"Offset Storage Replication Factor","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore"},"offsetStorageTopic":{"index":11,"kind":"parameter","displayName":"Offset Storage Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"binaryHandlingMode":{"index":15,"kind":"parameter","displayName":"Binary Handling Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"bytes","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how binary (blob, binary, etc.) columns should be represented in change events, including: 'bytes' represents binary data as byte array (default); 'base64' represents binary data as base64-encoded string; 'base64-url-safe' represents binary data as base64-url-safe-encoded string; 'hex' represents binary data as hex-encoded (base16) string"},"columnExcludeList":{"index":16,"kind":"parameter","displayName":"Column Exclude List","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to exclude from change events"},"columnIncludeList":{"index":17,"kind":"parameter","displayName":"Column Include List","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Regular expressions matching columns to include in change events"},"columnPropagateSourceType":{"index":18,"kind":"parameter","displayName":"Column Propagate Source Type","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records."},"converters":{"index":19,"kind":"parameter","displayName":"Converters","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'"},"customMetricTags":{"index":20,"kind":"parameter","displayName":"Custom Metric Tags","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2"},"databaseHostname":{"index":21,"kind":"parameter","displayName":"Database Hostname","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Resolvable hostname or IP address of the database server."},"databaseInstance":{"index":22,"kind":"parameter","displayName":"Database Instance","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The SQL Server instance name"},"databaseNames":{"index":23,"kind":"parameter","displayName":"Database Names","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The names of the databases from which the connector should capture changes"},"databasePassword":{"index":24,"kind":"parameter","displayName":"Database Password","group":"sqlserver","label":"consumer,sqlserver","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Password of the database user to be used when connecting to the database."},"databasePort":{"index":25,"kind":"parameter","displayName":"Database Port","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1433,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Port of the database server."},"databaseQueryTimeoutMs":{"index":26,"kind":"parameter","displayName":"Database Query Timeout Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10m","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for a query to execute, given in milliseconds. Defaults to 600 seconds (600,000 ms); zero means there is no limit."},"databaseUser":{"index":27,"kind":"parameter","displayName":"Database User","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Name of the database user to be used when connecting to the database."},"dataQueryMode":{"index":28,"kind":"parameter","displayName":"Data Query Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"function","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls how the connector queries CDC data. The default is 'function', which means the data is queried by means of calling cdc.fn_cdc_get_all_changes_# function. The value of 'direct' makes the connector to query the change tables directly."},"datatypePropagateSourceType":{"index":29,"kind":"parameter","displayName":"Datatype Propagate Source Type","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions matching the database-specific data type names that adds the data type's original type and original length as parameters to the corresponding field schemas in the emitted change records."},"decimalHandlingMode":{"index":30,"kind":"parameter","displayName":"Decimal Handling Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"precise","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how DECIMAL and NUMERIC columns should be represented in change events, including: 'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers."},"errorsMaxRetries":{"index":31,"kind":"parameter","displayName":"Errors Max Retries","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries)."},"eventProcessingFailureHandlingMode":{"index":32,"kind":"parameter","displayName":"Event Processing Failure Handling Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped."},"heartbeatActionQuery":{"index":33,"kind":"parameter","displayName":"Heartbeat Action Query","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The query executed with every heartbeat."},"heartbeatIntervalMs":{"index":34,"kind":"parameter","displayName":"Heartbeat Interval Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default."},"heartbeatTopicsPrefix":{"index":35,"kind":"parameter","displayName":"Heartbeat Topics Prefix","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"__debezium-heartbeat","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat."},"includeSchemaChanges":{"index":36,"kind":"parameter","displayName":"Include Schema Changes","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s). The default is 'true'. This is independent of how the connector internally records database schema history."},"includeSchemaComments":{"index":37,"kind":"parameter","displayName":"Include Schema Comments","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether the connector parse table and column's comment to metadata object. Note: Enable this option will bring the implications on memory usage. The number and size of ColumnImpl objects is what largely impacts how much memory is consumed by the Debezium connectors, and adding a String to each of them can potentially be quite heavy. The default is 'false'."},"incrementalSnapshotAllowSchemaChanges":{"index":38,"kind":"parameter","displayName":"Incremental Snapshot Allow Schema Changes","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Detect schema change during an incremental snapshot and re-select a current chunk to avoid locking DDLs. Note that changes to a primary key are not supported and can cause incorrect results if performed during an incremental snapshot. Another limitation is that if a schema change affects only columns' default values, then the change won't be detected until the DDL is processed from the binlog stream. This doesn't affect the snapshot events' values, but the schema of snapshot events may have outdated defaults."},"incrementalSnapshotChunkSize":{"index":39,"kind":"parameter","displayName":"Incremental Snapshot Chunk Size","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum size of chunk (number of documents/rows) for incremental snapshotting"},"incrementalSnapshotOptionRecompile":{"index":40,"kind":"parameter","displayName":"Incremental Snapshot Option Recompile","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Add OPTION(RECOMPILE) on each SELECT statement during the incremental snapshot process. This prevents parameter sniffing but can cause CPU pressure on the source database."},"incrementalSnapshotWatermarkingStrategy":{"index":41,"kind":"parameter","displayName":"Incremental Snapshot Watermarking Strategy","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INSERT_INSERT","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;"},"maxBatchSize":{"index":42,"kind":"parameter","displayName":"Max Batch Size","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of each batch of source records. Defaults to 2048."},"maxIterationTransactions":{"index":43,"kind":"parameter","displayName":"Max Iteration Transactions","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This property can be used to reduce the connector memory usage footprint when changes are streamed from multiple tables per database."},"maxQueueSize":{"index":44,"kind":"parameter","displayName":"Max Queue Size","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size."},"maxQueueSizeInBytes":{"index":45,"kind":"parameter","displayName":"Max Queue Size In Bytes","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled"},"messageKeyColumns":{"index":46,"kind":"parameter","displayName":"Message Key Columns","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':', where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector, and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key. Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id"},"notificationEnabledChannels":{"index":47,"kind":"parameter","displayName":"Notification Enabled Channels","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of notification channels names that are enabled."},"notificationSinkTopicName":{"index":48,"kind":"parameter","displayName":"Notification Sink Topic Name","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels"},"pollIntervalMs":{"index":49,"kind":"parameter","displayName":"Poll Interval Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500ms","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms."},"postProcessors":{"index":50,"kind":"parameter","displayName":"Post Processors","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Optional list of post processors. The processors are defined using '.type' config option and configured using options ''"},"provideTransactionMetadata":{"index":51,"kind":"parameter","displayName":"Provide Transaction Metadata","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Enables transaction metadata extraction together with event counting"},"retriableRestartConnectorWaitMs":{"index":52,"kind":"parameter","displayName":"Retriable Restart Connector Wait Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms."},"schemaHistoryInternal":{"index":53,"kind":"parameter","displayName":"Schema History Internal","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.storage.kafka.history.KafkaSchemaHistory","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SchemaHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'schema.history.internal.' string."},"schemaHistoryInternalFileFilename":{"index":54,"kind":"parameter","displayName":"Schema History Internal File Filename","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The path to the file that will be used to record the database schema history"},"schemaHistoryInternalSkipUnparseableDdl":{"index":55,"kind":"parameter","displayName":"Schema History Internal Skip Unparseable Ddl","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes."},"schemaHistoryInternalStoreOnlyCapturedDatabasesDdl":{"index":56,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Databases Ddl","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (true) only DDL that manipulates a table from captured schema/database will be stored. If set to false, then Debezium will store all incoming DDL statements."},"schemaHistoryInternalStoreOnlyCapturedTablesDdl":{"index":57,"kind":"parameter","displayName":"Schema History Internal Store Only Captured Tables Ddl","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls what DDL will Debezium store in database schema history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a captured table will be stored."},"schemaNameAdjustmentMode":{"index":58,"kind":"parameter","displayName":"Schema Name Adjustment Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)"},"signalDataCollection":{"index":59,"kind":"parameter","displayName":"Signal Data Collection","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set."},"signalEnabledChannels":{"index":60,"kind":"parameter","displayName":"Signal Enabled Channels","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"source","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"List of channels names that are enabled. Source channel is enabled by default"},"signalPollIntervalMs":{"index":61,"kind":"parameter","displayName":"Signal Poll Interval Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5s","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds."},"skippedOperations":{"index":62,"kind":"parameter","displayName":"Skipped Operations","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"t","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped."},"snapshotDelayMs":{"index":63,"kind":"parameter","displayName":"Snapshot Delay Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms."},"snapshotFetchSize":{"index":64,"kind":"parameter","displayName":"Snapshot Fetch Size","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of records that should be loaded into memory while performing a snapshot."},"snapshotIncludeCollectionList":{"index":65,"kind":"parameter","displayName":"Snapshot Include Collection List","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector."},"snapshotIsolationMode":{"index":66,"kind":"parameter","displayName":"Snapshot Isolation Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"repeatable_read","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls which transaction isolation level is used and how long the connector locks the captured tables. The default is 'repeatable_read', which means that repeatable read isolation level is used. In addition, type of acquired lock during schema snapshot depends on snapshot.locking.mode property. Using a value of 'exclusive' ensures that the connector holds the type of lock specified with snapshot.locking.mode property (and thus prevents any reads and updates) for all captured tables during the entire snapshot duration. When 'snapshot' is specified, connector runs the initial snapshot in SNAPSHOT isolation level, which guarantees snapshot consistency. In addition, neither table nor row-level locks are held. When 'read_committed' is specified, connector runs the initial snapshot in READ COMMITTED isolation level. No long-running locks are taken, so that initial snapshot does not prevent other transactions from updating table rows. Snapshot consistency is not guaranteed.In 'read_uncommitted' mode neither table nor row-level locks are acquired, but connector does not guarantee snapshot consistency."},"snapshotLockTimeoutMs":{"index":67,"kind":"parameter","displayName":"Snapshot Lock Timeout Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10s","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds"},"snapshotMaxThreads":{"index":68,"kind":"parameter","displayName":"Snapshot Max Threads","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The maximum number of threads used to perform the snapshot. Defaults to 1."},"snapshotMode":{"index":69,"kind":"parameter","displayName":"Snapshot Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"initial","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the transaction log.; 'initial_only': The connector performs a snapshot as it does for the 'initial' option, but after the connector completes the snapshot, it stops, and does not stream changes from the transaction log.; 'schema_only': If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures only the schema (table structures), but not any table data. After the snapshot completes, the connector begins to stream changes from the transaction log."},"snapshotModeConfigurationBasedSnapshotData":{"index":70,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Data","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not."},"snapshotModeConfigurationBasedSnapshotOnDataError":{"index":71,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Data Error","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotOnSchemaError":{"index":72,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot On Schema Error","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error."},"snapshotModeConfigurationBasedSnapshotSchema":{"index":73,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Snapshot Schema","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not."},"snapshotModeConfigurationBasedStartStream":{"index":74,"kind":"parameter","displayName":"Snapshot Mode Configuration Based Start Stream","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot."},"snapshotModeCustomName":{"index":75,"kind":"parameter","displayName":"Snapshot Mode Custom Name","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot."},"snapshotSelectStatementOverrides":{"index":76,"kind":"parameter","displayName":"Snapshot Select Statement Overrides","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connectors. Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted."},"snapshotTablesOrderByRowCount":{"index":77,"kind":"parameter","displayName":"Snapshot Tables Order By Row Count","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"disabled","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Controls the order in which tables are processed in the initial snapshot. A descending value will order the tables by row count descending. A ascending value will order the tables by row count ascending. A value of disabled (the default) will disable ordering by row count."},"sourceinfoStructMaker":{"index":78,"kind":"parameter","displayName":"Sourceinfo Struct Maker","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.connector.sqlserver.SqlServerSourceInfoStructMaker","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct."},"streamingDelayMs":{"index":79,"kind":"parameter","displayName":"Streaming Delay Ms","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0ms","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms."},"tableExcludeList":{"index":80,"kind":"parameter","displayName":"Table Exclude List","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring"},"tableIgnoreBuiltin":{"index":81,"kind":"parameter","displayName":"Table Ignore Builtin","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Flag specifying whether built-in tables should be ignored."},"tableIncludeList":{"index":82,"kind":"parameter","displayName":"Table Include List","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The tables for which changes are to be captured"},"timePrecisionMode":{"index":83,"kind":"parameter","displayName":"Time Precision Mode","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"adaptive","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Time, date, and timestamps can be represented with different kinds of precisions, including: 'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column's precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision; 'connect' always represents time, date, and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision."},"tombstonesOnDelete":{"index":84,"kind":"parameter","displayName":"Tombstones On Delete","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted."},"topicNamingStrategy":{"index":85,"kind":"parameter","displayName":"Topic Naming Strategy","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.schema.SchemaTopicNamingStrategy","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc."},"topicPrefix":{"index":86,"kind":"parameter","displayName":"Topic Prefix","group":"sqlserver","label":"consumer,sqlserver","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted."},"transactionMetadataFactory":{"index":87,"kind":"parameter","displayName":"Transaction Metadata Factory","group":"sqlserver","label":"consumer,sqlserver","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory","configurationClass":"org.apache.camel.component.debezium.sqlserver.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration","configurationField":"configuration","description":"Class to make transaction context & transaction struct/schemas"}}} , -{"component":{"kind":"component","name":"dhis2","title":"DHIS2","description":"Leverages the DHIS2 Java SDK to integrate Apache Camel with the DHIS2 Web API.","deprecated":false,"firstVersion":"4.0.0","label":"api","javaType":"org.apache.camel.component.dhis2.Dhis2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dhis2","version":"4.8.1","scheme":"dhis2","extendsScheme":"","syntax":"dhis2:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.dhis2.internal.Dhis2ApiName","enum":["POST","RESOURCE_TABLES","GET","DELETE","PUT"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dhis2.Dhis2Configuration","configurationField":"configuration","description":"API operation (e.g., get)"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dhis2.Dhis2Configuration","configurationField":"configuration","description":"Subject of the API operation (e.g., resource)"},"baseApiUrl":{"index":2,"kind":"parameter","displayName":"Base Api Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dhis2.Dhis2Configuration","configurationField":"configuration","description":"DHIS2 server base API URL (e.g., https://play.dhis2.org/2.39.1.1/api)"},"inBody":{"index":3,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"sendEmptyMessageWhenIdle":{"index":4,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":8,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":9,"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."},"client":{"index":10,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.hisp.dhis.integration.sdk.api.Dhis2Client","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dhis2.Dhis2Configuration","configurationField":"configuration","description":"References a user-defined org.hisp.dhis.integration.sdk.api.Dhis2Client. This option is mutually exclusive to the baseApiUrl, username, password, and personalAccessToken options"},"backoffErrorThreshold":{"index":11,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":12,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":13,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":14,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":15,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":16,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":17,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":18,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":19,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":20,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":21,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":22,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":23,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":24,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":25,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dhis2.Dhis2Configuration","configurationField":"configuration","description":"Password of the DHIS2 username"},"personalAccessToken":{"index":26,"kind":"parameter","displayName":"Personal Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dhis2.Dhis2Configuration","configurationField":"configuration","description":"Personal access token to authenticate with DHIS2. This option is mutually exclusive to username and password"},"username":{"index":27,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dhis2.Dhis2Configuration","configurationField":"configuration","description":"Username of the DHIS2 user to operate as"}},"apis":{"delete":{"consumerOnly":false,"producerOnly":false,"description":"","methods":{"resource":{"description":"","signatures":["java.io.InputStream resource(String path, Object resource, java.util.Map queryParams)"]}}},"get":{"consumerOnly":false,"producerOnly":false,"description":"","methods":{"collection":{"description":"","signatures":["java.util.Iterator collection(String path, String arrayName, Boolean paging, String fields, java.util.List filter, org.apache.camel.component.dhis2.api.RootJunctionEnum rootJunction, java.util.Map queryParams)"]},"resource":{"description":"","signatures":["java.io.InputStream resource(String path, String fields, java.util.List filter, org.apache.camel.component.dhis2.api.RootJunctionEnum rootJunction, java.util.Map queryParams)"]}}},"post":{"consumerOnly":false,"producerOnly":false,"description":"","methods":{"resource":{"description":"","signatures":["java.io.InputStream resource(String path, Object resource, java.util.Map queryParams)"]}}},"put":{"consumerOnly":false,"producerOnly":false,"description":"","methods":{"resource":{"description":"","signatures":["java.io.InputStream resource(String path, Object resource, java.util.Map queryParams)"]}}},"resourceTables":{"consumerOnly":false,"producerOnly":false,"description":"","methods":{"analytics":{"description":"","signatures":["void analytics(Boolean skipAggregate, Boolean skipEvents, Integer lastYears, Integer interval, Boolean async)"]}}}},"apiProperties":{"delete":{"methods":{"resource":{"properties":{"path":{"index":0,"kind":"parameter","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"queryParams":{"index":1,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"resource":{"index":2,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true}}}}},"get":{"methods":{"collection":{"properties":{"arrayName":{"index":0,"kind":"parameter","displayName":"Array Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"fields":{"index":1,"kind":"parameter","displayName":"Fields","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"filter":{"index":2,"kind":"parameter","displayName":"Filter","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"paging":{"index":3,"kind":"parameter","displayName":"Paging","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"path":{"index":4,"kind":"parameter","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"queryParams":{"index":5,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"rootJunction":{"index":6,"kind":"parameter","displayName":"Root Junction","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.dhis2.api.RootJunctionEnum","enum":["AND","OR"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":true}}},"resource":{"properties":{"fields":{"index":0,"kind":"parameter","displayName":"Fields","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"filter":{"index":1,"kind":"parameter","displayName":"Filter","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"path":{"index":2,"kind":"parameter","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"queryParams":{"index":3,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"rootJunction":{"index":4,"kind":"parameter","displayName":"Root Junction","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.dhis2.api.RootJunctionEnum","enum":["AND","OR"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":true}}}}},"post":{"methods":{"resource":{"properties":{"path":{"index":0,"kind":"parameter","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"queryParams":{"index":1,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"resource":{"index":2,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true}}}}},"put":{"methods":{"resource":{"properties":{"path":{"index":0,"kind":"parameter","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"queryParams":{"index":1,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"resource":{"index":2,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true}}}}},"resourceTables":{"methods":{"analytics":{"properties":{"async":{"index":0,"kind":"parameter","displayName":"Async","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"interval":{"index":1,"kind":"parameter","displayName":"Interval","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"lastYears":{"index":2,"kind":"parameter","displayName":"Last Years","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"skipAggregate":{"index":3,"kind":"parameter","displayName":"Skip Aggregate","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"skipEvents":{"index":4,"kind":"parameter","displayName":"Skip Events","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true}}}}}}} +{"component":{"kind":"component","name":"dhis2","title":"DHIS2","description":"Leverages the DHIS2 Java SDK to integrate Apache Camel with the DHIS2 Web API.","deprecated":false,"firstVersion":"4.0.0","label":"api","javaType":"org.apache.camel.component.dhis2.Dhis2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dhis2","version":"4.8.2","scheme":"dhis2","extendsScheme":"","syntax":"dhis2:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.dhis2.internal.Dhis2ApiName","enum":["POST","RESOURCE_TABLES","GET","DELETE","PUT"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dhis2.Dhis2Configuration","configurationField":"configuration","description":"API operation (e.g., get)"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dhis2.Dhis2Configuration","configurationField":"configuration","description":"Subject of the API operation (e.g., resource)"},"baseApiUrl":{"index":2,"kind":"parameter","displayName":"Base Api Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dhis2.Dhis2Configuration","configurationField":"configuration","description":"DHIS2 server base API URL (e.g., https://play.dhis2.org/2.39.1.1/api)"},"inBody":{"index":3,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"sendEmptyMessageWhenIdle":{"index":4,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":8,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":9,"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."},"client":{"index":10,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.hisp.dhis.integration.sdk.api.Dhis2Client","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dhis2.Dhis2Configuration","configurationField":"configuration","description":"References a user-defined org.hisp.dhis.integration.sdk.api.Dhis2Client. This option is mutually exclusive to the baseApiUrl, username, password, and personalAccessToken options"},"backoffErrorThreshold":{"index":11,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":12,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":13,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":14,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":15,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":16,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":17,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":18,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":19,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":20,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":21,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":22,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":23,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":24,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":25,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dhis2.Dhis2Configuration","configurationField":"configuration","description":"Password of the DHIS2 username"},"personalAccessToken":{"index":26,"kind":"parameter","displayName":"Personal Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dhis2.Dhis2Configuration","configurationField":"configuration","description":"Personal access token to authenticate with DHIS2. This option is mutually exclusive to username and password"},"username":{"index":27,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dhis2.Dhis2Configuration","configurationField":"configuration","description":"Username of the DHIS2 user to operate as"}},"apis":{"delete":{"consumerOnly":false,"producerOnly":false,"description":"","methods":{"resource":{"description":"","signatures":["java.io.InputStream resource(String path, Object resource, java.util.Map queryParams)"]}}},"get":{"consumerOnly":false,"producerOnly":false,"description":"","methods":{"collection":{"description":"","signatures":["java.util.Iterator collection(String path, String arrayName, Boolean paging, String fields, java.util.List filter, org.apache.camel.component.dhis2.api.RootJunctionEnum rootJunction, java.util.Map queryParams)"]},"resource":{"description":"","signatures":["java.io.InputStream resource(String path, String fields, java.util.List filter, org.apache.camel.component.dhis2.api.RootJunctionEnum rootJunction, java.util.Map queryParams)"]}}},"post":{"consumerOnly":false,"producerOnly":false,"description":"","methods":{"resource":{"description":"","signatures":["java.io.InputStream resource(String path, Object resource, java.util.Map queryParams)"]}}},"put":{"consumerOnly":false,"producerOnly":false,"description":"","methods":{"resource":{"description":"","signatures":["java.io.InputStream resource(String path, Object resource, java.util.Map queryParams)"]}}},"resourceTables":{"consumerOnly":false,"producerOnly":false,"description":"","methods":{"analytics":{"description":"","signatures":["void analytics(Boolean skipAggregate, Boolean skipEvents, Integer lastYears, Integer interval, Boolean async)"]}}}},"apiProperties":{"delete":{"methods":{"resource":{"properties":{"path":{"index":0,"kind":"parameter","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"queryParams":{"index":1,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"resource":{"index":2,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true}}}}},"get":{"methods":{"collection":{"properties":{"arrayName":{"index":0,"kind":"parameter","displayName":"Array Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"fields":{"index":1,"kind":"parameter","displayName":"Fields","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"filter":{"index":2,"kind":"parameter","displayName":"Filter","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"paging":{"index":3,"kind":"parameter","displayName":"Paging","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"path":{"index":4,"kind":"parameter","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"queryParams":{"index":5,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"rootJunction":{"index":6,"kind":"parameter","displayName":"Root Junction","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.dhis2.api.RootJunctionEnum","enum":["AND","OR"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":true}}},"resource":{"properties":{"fields":{"index":0,"kind":"parameter","displayName":"Fields","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"filter":{"index":1,"kind":"parameter","displayName":"Filter","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"path":{"index":2,"kind":"parameter","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"queryParams":{"index":3,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"rootJunction":{"index":4,"kind":"parameter","displayName":"Root Junction","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.dhis2.api.RootJunctionEnum","enum":["AND","OR"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":true}}}}},"post":{"methods":{"resource":{"properties":{"path":{"index":0,"kind":"parameter","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"queryParams":{"index":1,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"resource":{"index":2,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true}}}}},"put":{"methods":{"resource":{"properties":{"path":{"index":0,"kind":"parameter","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"queryParams":{"index":1,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"resource":{"index":2,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true}}}}},"resourceTables":{"methods":{"analytics":{"properties":{"async":{"index":0,"kind":"parameter","displayName":"Async","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"interval":{"index":1,"kind":"parameter","displayName":"Interval","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"lastYears":{"index":2,"kind":"parameter","displayName":"Last Years","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"skipAggregate":{"index":3,"kind":"parameter","displayName":"Skip Aggregate","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true},"skipEvents":{"index":4,"kind":"parameter","displayName":"Skip Events","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":true}}}}}}} , -{"component":{"kind":"component","name":"digitalocean","title":"DigitalOcean","description":"Manage Droplets and resources within the DigitalOcean cloud.","deprecated":false,"firstVersion":"2.19.0","label":"cloud,management","javaType":"org.apache.camel.component.digitalocean.DigitalOceanComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-digitalocean","version":"4.8.1","scheme":"digitalocean","extendsScheme":"","syntax":"digitalocean:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelDigitalOceanOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.digitalocean.constants.DigitalOceanOperations","enum":["create","update","delete","list","ownList","get","listBackups","listActions","listNeighbors","listSnapshots","listKernels","listAllNeighbors","enableBackups","disableBackups","reboot","powerCycle","shutdown","powerOn","powerOff","restore","resetPassword","resize","rebuild","rename","changeKernel","enableIpv6","enablePrivateNetworking","takeSnapshot","transfer","convert","attach","detach","assign","unassign","tag","untag"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#OPERATION"},"CamelDigitalOceanId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#ID"},"CamelDigitalOceanType":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.digitalocean.constants.DigitalOceanImageTypes","enum":["distribution","application"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#TYPE"},"CamelDigitalOceanName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#NAME"},"CamelDigitalOceanNames":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The names of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#NAMES"},"CamelDigitalOceanRegion":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The code name of the region aka DigitalOcean data centers","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#REGION"},"CamelDigitalOceanDescription":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The description","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DESCRIPTION"},"CamelDigitalOceanDropletSize":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_SIZE"},"CamelDigitalOceanDropletImage":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The image of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_IMAGE"},"CamelDigitalOceanDropletSSHKeys":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The keys of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_KEYS"},"CamelDigitalOceanDropletEnableBackups":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag to enable backups","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_ENABLE_BACKUPS"},"CamelDigitalOceanDropletEnableIpv6":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag to enable ipv6","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_ENABLE_IPV6"},"CamelDigitalOceanDropletEnablePrivateNetworking":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag to enable private networking","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_ENABLE_PRIVATE_NETWORKING"},"CamelDigitalOceanDropletUserData":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user data of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_USER_DATA"},"CamelDigitalOceanDropletVolumes":{"index":14,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The volumes' identifier of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_VOLUMES"},"CamelDigitalOceanDropletTags":{"index":15,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tags of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_TAGS"},"CamelDigitalOceanDropletId":{"index":16,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The droplet identifier","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_ID"},"CamelDigitalOceanImageId":{"index":17,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the DigitalOcean public image or your private image","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#IMAGE_ID"},"CamelDigitalOceanKernelId":{"index":18,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The kernel id to be changed for droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#KERNEL_ID"},"CamelDigitalOceanVolumeName":{"index":19,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the volume","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#VOLUME_NAME"},"CamelDigitalOceanVolumeSizeGigabytes":{"index":20,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer or Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size value in GB","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#VOLUME_SIZE_GIGABYTES"},"CamelDigitalOceanFloatingIPAddress":{"index":21,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The floating IP address","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#FLOATING_IP_ADDRESS"},"CamelDigitalOceanKeyFingerprint":{"index":22,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSH key fingerprint","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#KEY_FINGERPRINT"},"CamelDigitalOceanKeyPublicKey":{"index":23,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The public key","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#KEY_PUBLIC_KEY"}},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.digitalocean.constants.DigitalOceanOperations","enum":["create","update","delete","list","ownList","get","listBackups","listActions","listNeighbors","listSnapshots","listKernels","listAllNeighbors","enableBackups","disableBackups","reboot","powerCycle","shutdown","powerOn","powerOff","restore","resetPassword","resize","rebuild","rename","changeKernel","enableIpv6","enablePrivateNetworking","takeSnapshot","transfer","convert","attach","detach","assign","unassign","tag","untag"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"The operation to perform to the given resource."},"page":{"index":1,"kind":"parameter","displayName":"Page","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Use for pagination. Force the page number."},"perPage":{"index":2,"kind":"parameter","displayName":"Per Page","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"25","configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Use for pagination. Set the number of item per request. The maximum number of results per page is 200."},"resource":{"index":3,"kind":"parameter","displayName":"Resource","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.digitalocean.constants.DigitalOceanResources","enum":["account","actions","blockStorages","droplets","mages","snapshots","keys","regions","sizes","floatingIPs","tags"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"The DigitalOcean resource type on which perform the operation."},"lazyStartProducer":{"index":4,"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."},"digitalOceanClient":{"index":5,"kind":"parameter","displayName":"Digital Ocean Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.myjeeva.digitalocean.impl.DigitalOceanClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"To use a existing configured DigitalOceanClient as client"},"httpProxyHost":{"index":6,"kind":"parameter","displayName":"Http Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Set a proxy host if needed"},"httpProxyPassword":{"index":7,"kind":"parameter","displayName":"Http Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Set a proxy password if needed"},"httpProxyPort":{"index":8,"kind":"parameter","displayName":"Http Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Set a proxy port if needed"},"httpProxyUser":{"index":9,"kind":"parameter","displayName":"Http Proxy User","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Set a proxy host if needed"},"oAuthToken":{"index":10,"kind":"parameter","displayName":"OAuth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"DigitalOcean OAuth Token"}}} +{"component":{"kind":"component","name":"digitalocean","title":"DigitalOcean","description":"Manage Droplets and resources within the DigitalOcean cloud.","deprecated":false,"firstVersion":"2.19.0","label":"cloud,management","javaType":"org.apache.camel.component.digitalocean.DigitalOceanComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-digitalocean","version":"4.8.2","scheme":"digitalocean","extendsScheme":"","syntax":"digitalocean:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelDigitalOceanOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.digitalocean.constants.DigitalOceanOperations","enum":["create","update","delete","list","ownList","get","listBackups","listActions","listNeighbors","listSnapshots","listKernels","listAllNeighbors","enableBackups","disableBackups","reboot","powerCycle","shutdown","powerOn","powerOff","restore","resetPassword","resize","rebuild","rename","changeKernel","enableIpv6","enablePrivateNetworking","takeSnapshot","transfer","convert","attach","detach","assign","unassign","tag","untag"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#OPERATION"},"CamelDigitalOceanId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#ID"},"CamelDigitalOceanType":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.digitalocean.constants.DigitalOceanImageTypes","enum":["distribution","application"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#TYPE"},"CamelDigitalOceanName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#NAME"},"CamelDigitalOceanNames":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The names of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#NAMES"},"CamelDigitalOceanRegion":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The code name of the region aka DigitalOcean data centers","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#REGION"},"CamelDigitalOceanDescription":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The description","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DESCRIPTION"},"CamelDigitalOceanDropletSize":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_SIZE"},"CamelDigitalOceanDropletImage":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The image of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_IMAGE"},"CamelDigitalOceanDropletSSHKeys":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The keys of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_KEYS"},"CamelDigitalOceanDropletEnableBackups":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag to enable backups","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_ENABLE_BACKUPS"},"CamelDigitalOceanDropletEnableIpv6":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag to enable ipv6","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_ENABLE_IPV6"},"CamelDigitalOceanDropletEnablePrivateNetworking":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag to enable private networking","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_ENABLE_PRIVATE_NETWORKING"},"CamelDigitalOceanDropletUserData":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user data of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_USER_DATA"},"CamelDigitalOceanDropletVolumes":{"index":14,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The volumes' identifier of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_VOLUMES"},"CamelDigitalOceanDropletTags":{"index":15,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tags of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_TAGS"},"CamelDigitalOceanDropletId":{"index":16,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The droplet identifier","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_ID"},"CamelDigitalOceanImageId":{"index":17,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the DigitalOcean public image or your private image","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#IMAGE_ID"},"CamelDigitalOceanKernelId":{"index":18,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The kernel id to be changed for droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#KERNEL_ID"},"CamelDigitalOceanVolumeName":{"index":19,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the volume","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#VOLUME_NAME"},"CamelDigitalOceanVolumeSizeGigabytes":{"index":20,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer or Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size value in GB","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#VOLUME_SIZE_GIGABYTES"},"CamelDigitalOceanFloatingIPAddress":{"index":21,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The floating IP address","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#FLOATING_IP_ADDRESS"},"CamelDigitalOceanKeyFingerprint":{"index":22,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSH key fingerprint","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#KEY_FINGERPRINT"},"CamelDigitalOceanKeyPublicKey":{"index":23,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The public key","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#KEY_PUBLIC_KEY"}},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.digitalocean.constants.DigitalOceanOperations","enum":["create","update","delete","list","ownList","get","listBackups","listActions","listNeighbors","listSnapshots","listKernels","listAllNeighbors","enableBackups","disableBackups","reboot","powerCycle","shutdown","powerOn","powerOff","restore","resetPassword","resize","rebuild","rename","changeKernel","enableIpv6","enablePrivateNetworking","takeSnapshot","transfer","convert","attach","detach","assign","unassign","tag","untag"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"The operation to perform to the given resource."},"page":{"index":1,"kind":"parameter","displayName":"Page","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Use for pagination. Force the page number."},"perPage":{"index":2,"kind":"parameter","displayName":"Per Page","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"25","configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Use for pagination. Set the number of item per request. The maximum number of results per page is 200."},"resource":{"index":3,"kind":"parameter","displayName":"Resource","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.digitalocean.constants.DigitalOceanResources","enum":["account","actions","blockStorages","droplets","mages","snapshots","keys","regions","sizes","floatingIPs","tags"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"The DigitalOcean resource type on which perform the operation."},"lazyStartProducer":{"index":4,"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."},"digitalOceanClient":{"index":5,"kind":"parameter","displayName":"Digital Ocean Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.myjeeva.digitalocean.impl.DigitalOceanClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"To use a existing configured DigitalOceanClient as client"},"httpProxyHost":{"index":6,"kind":"parameter","displayName":"Http Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Set a proxy host if needed"},"httpProxyPassword":{"index":7,"kind":"parameter","displayName":"Http Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Set a proxy password if needed"},"httpProxyPort":{"index":8,"kind":"parameter","displayName":"Http Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Set a proxy port if needed"},"httpProxyUser":{"index":9,"kind":"parameter","displayName":"Http Proxy User","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Set a proxy host if needed"},"oAuthToken":{"index":10,"kind":"parameter","displayName":"OAuth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"DigitalOcean OAuth Token"}}} , -{"component":{"kind":"component","name":"direct","title":"Direct","description":"Call another endpoint from the same Camel Context synchronously.","deprecated":false,"firstVersion":"1.0.0","label":"core,messaging","javaType":"org.apache.camel.component.direct.DirectComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-direct","version":"4.8.1","scheme":"direct","extendsScheme":"","syntax":"direct:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of direct endpoint"},"bridgeErrorHandler":{"index":1,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":2,"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":{"index":3,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"block":{"index":4,"kind":"parameter","displayName":"Block","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active."},"failIfNoConsumers":{"index":5,"kind":"parameter","displayName":"Fail If No Consumers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the producer should fail by throwing an exception, when sending to a DIRECT endpoint with no active consumers."},"timeout":{"index":6,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"description":"The timeout value to use if block is enabled."},"lazyStartProducer":{"index":7,"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."},"synchronous":{"index":8,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether synchronous processing is forced. If enabled, then the producer thread will be forced to wait until the message has been completed before the same thread will continue processing. If disabled, the default, then the producer thread may be freed and can do other work while the message is continued processed by other threads (reactive)."}}} +{"component":{"kind":"component","name":"direct","title":"Direct","description":"Call another endpoint from the same Camel Context synchronously.","deprecated":false,"firstVersion":"1.0.0","label":"core,messaging","javaType":"org.apache.camel.component.direct.DirectComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-direct","version":"4.8.2","scheme":"direct","extendsScheme":"","syntax":"direct:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of direct endpoint"},"bridgeErrorHandler":{"index":1,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":2,"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":{"index":3,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"block":{"index":4,"kind":"parameter","displayName":"Block","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active."},"failIfNoConsumers":{"index":5,"kind":"parameter","displayName":"Fail If No Consumers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the producer should fail by throwing an exception, when sending to a DIRECT endpoint with no active consumers."},"timeout":{"index":6,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"description":"The timeout value to use if block is enabled."},"lazyStartProducer":{"index":7,"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."},"synchronous":{"index":8,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether synchronous processing is forced. If enabled, then the producer thread will be forced to wait until the message has been completed before the same thread will continue processing. If disabled, the default, then the producer thread may be freed and can do other work while the message is continued processed by other threads (reactive)."}}} , -{"component":{"kind":"component","name":"disruptor","title":"Disruptor","description":"Provides asynchronous SEDA behavior using LMAX Disruptor.","deprecated":false,"firstVersion":"2.12.0","label":"messaging","javaType":"org.apache.camel.component.disruptor.DisruptorComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-disruptor","version":"4.8.1","scheme":"disruptor","extendsScheme":"","alternativeSchemes":"disruptor,disruptor-vm","syntax":"disruptor:name","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of queue"},"size":{"index":1,"kind":"parameter","displayName":"Size","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"description":"The maximum capacity of the Disruptors ringbuffer Will be effectively increased to the nearest power of two. Notice: Mind if you use this option, then it's the first endpoint being created with the queue name that determines the size. To make sure all endpoints use the same size, then configure the size option on all of them, or the first endpoint being created."},"concurrentConsumers":{"index":2,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Number of concurrent threads processing exchanges."},"multipleConsumers":{"index":3,"kind":"parameter","displayName":"Multiple Consumers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether multiple consumers are allowed. If enabled, you can use Disruptor for Publish-Subscribe messaging. That is, you can send a message to the queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint."},"waitStrategy":{"index":4,"kind":"parameter","displayName":"Wait Strategy","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.disruptor.DisruptorWaitStrategy","enum":["Blocking","Sleeping","BusySpin","Yielding"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Blocking","description":"Defines the strategy used by consumer threads to wait on new exchanges to be published. The options allowed are:Blocking, Sleeping, BusySpin and Yielding."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"blockWhenFull":{"index":8,"kind":"parameter","displayName":"Block When Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a thread that sends messages to a full Disruptor will block until the ringbuffer's capacity is no longer exhausted. By default, the calling thread will block and wait until the message can be accepted. By disabling this option, an exception will be thrown stating that the queue is full."},"producerType":{"index":9,"kind":"parameter","displayName":"Producer Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.disruptor.DisruptorProducerType","enum":["Single","Multi"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Multi","description":"Defines the producers allowed on the Disruptor. The options allowed are: Multi to allow multiple producers and Single to enable certain optimizations only allowed when one concurrent producer (on one thread or otherwise synchronized) is active."},"timeout":{"index":10,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Timeout (in milliseconds) before a producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value."},"waitForTaskToComplete":{"index":11,"kind":"parameter","displayName":"Wait For Task To Complete","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.WaitForTaskToComplete","enum":["Never","IfReplyExpected","Always"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"IfReplyExpected","description":"Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based."},"lazyStartProducer":{"index":12,"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."}}} +{"component":{"kind":"component","name":"disruptor","title":"Disruptor","description":"Provides asynchronous SEDA behavior using LMAX Disruptor.","deprecated":false,"firstVersion":"2.12.0","label":"messaging","javaType":"org.apache.camel.component.disruptor.DisruptorComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-disruptor","version":"4.8.2","scheme":"disruptor","extendsScheme":"","alternativeSchemes":"disruptor,disruptor-vm","syntax":"disruptor:name","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of queue"},"size":{"index":1,"kind":"parameter","displayName":"Size","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"description":"The maximum capacity of the Disruptors ringbuffer Will be effectively increased to the nearest power of two. Notice: Mind if you use this option, then it's the first endpoint being created with the queue name that determines the size. To make sure all endpoints use the same size, then configure the size option on all of them, or the first endpoint being created."},"concurrentConsumers":{"index":2,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Number of concurrent threads processing exchanges."},"multipleConsumers":{"index":3,"kind":"parameter","displayName":"Multiple Consumers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether multiple consumers are allowed. If enabled, you can use Disruptor for Publish-Subscribe messaging. That is, you can send a message to the queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint."},"waitStrategy":{"index":4,"kind":"parameter","displayName":"Wait Strategy","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.disruptor.DisruptorWaitStrategy","enum":["Blocking","Sleeping","BusySpin","Yielding"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Blocking","description":"Defines the strategy used by consumer threads to wait on new exchanges to be published. The options allowed are:Blocking, Sleeping, BusySpin and Yielding."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"blockWhenFull":{"index":8,"kind":"parameter","displayName":"Block When Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a thread that sends messages to a full Disruptor will block until the ringbuffer's capacity is no longer exhausted. By default, the calling thread will block and wait until the message can be accepted. By disabling this option, an exception will be thrown stating that the queue is full."},"producerType":{"index":9,"kind":"parameter","displayName":"Producer Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.disruptor.DisruptorProducerType","enum":["Single","Multi"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Multi","description":"Defines the producers allowed on the Disruptor. The options allowed are: Multi to allow multiple producers and Single to enable certain optimizations only allowed when one concurrent producer (on one thread or otherwise synchronized) is active."},"timeout":{"index":10,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Timeout (in milliseconds) before a producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value."},"waitForTaskToComplete":{"index":11,"kind":"parameter","displayName":"Wait For Task To Complete","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.WaitForTaskToComplete","enum":["Never","IfReplyExpected","Always"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"IfReplyExpected","description":"Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based."},"lazyStartProducer":{"index":12,"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."}}} , -{"component":{"kind":"component","name":"disruptor-vm","title":"Disruptor VM","description":"Provides asynchronous SEDA behavior using LMAX Disruptor.","deprecated":false,"firstVersion":"2.12.0","label":"messaging","javaType":"org.apache.camel.component.disruptor.vm.DisruptorVmComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-disruptor","version":"4.8.1","scheme":"disruptor-vm","extendsScheme":"","alternativeSchemes":"disruptor,disruptor-vm","syntax":"disruptor-vm:name","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of queue"},"size":{"index":1,"kind":"parameter","displayName":"Size","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"description":"The maximum capacity of the Disruptors ringbuffer Will be effectively increased to the nearest power of two. Notice: Mind if you use this option, then it's the first endpoint being created with the queue name that determines the size. To make sure all endpoints use the same size, then configure the size option on all of them, or the first endpoint being created."},"concurrentConsumers":{"index":2,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Number of concurrent threads processing exchanges."},"multipleConsumers":{"index":3,"kind":"parameter","displayName":"Multiple Consumers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether multiple consumers are allowed. If enabled, you can use Disruptor for Publish-Subscribe messaging. That is, you can send a message to the queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint."},"waitStrategy":{"index":4,"kind":"parameter","displayName":"Wait Strategy","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.disruptor.DisruptorWaitStrategy","enum":["Blocking","Sleeping","BusySpin","Yielding"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Blocking","description":"Defines the strategy used by consumer threads to wait on new exchanges to be published. The options allowed are:Blocking, Sleeping, BusySpin and Yielding."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"blockWhenFull":{"index":8,"kind":"parameter","displayName":"Block When Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a thread that sends messages to a full Disruptor will block until the ringbuffer's capacity is no longer exhausted. By default, the calling thread will block and wait until the message can be accepted. By disabling this option, an exception will be thrown stating that the queue is full."},"producerType":{"index":9,"kind":"parameter","displayName":"Producer Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.disruptor.DisruptorProducerType","enum":["Single","Multi"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Multi","description":"Defines the producers allowed on the Disruptor. The options allowed are: Multi to allow multiple producers and Single to enable certain optimizations only allowed when one concurrent producer (on one thread or otherwise synchronized) is active."},"timeout":{"index":10,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Timeout (in milliseconds) before a producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value."},"waitForTaskToComplete":{"index":11,"kind":"parameter","displayName":"Wait For Task To Complete","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.WaitForTaskToComplete","enum":["Never","IfReplyExpected","Always"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"IfReplyExpected","description":"Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based."},"lazyStartProducer":{"index":12,"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."}}} +{"component":{"kind":"component","name":"disruptor-vm","title":"Disruptor VM","description":"Provides asynchronous SEDA behavior using LMAX Disruptor.","deprecated":false,"firstVersion":"2.12.0","label":"messaging","javaType":"org.apache.camel.component.disruptor.vm.DisruptorVmComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-disruptor","version":"4.8.2","scheme":"disruptor-vm","extendsScheme":"","alternativeSchemes":"disruptor,disruptor-vm","syntax":"disruptor-vm:name","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of queue"},"size":{"index":1,"kind":"parameter","displayName":"Size","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"description":"The maximum capacity of the Disruptors ringbuffer Will be effectively increased to the nearest power of two. Notice: Mind if you use this option, then it's the first endpoint being created with the queue name that determines the size. To make sure all endpoints use the same size, then configure the size option on all of them, or the first endpoint being created."},"concurrentConsumers":{"index":2,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Number of concurrent threads processing exchanges."},"multipleConsumers":{"index":3,"kind":"parameter","displayName":"Multiple Consumers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether multiple consumers are allowed. If enabled, you can use Disruptor for Publish-Subscribe messaging. That is, you can send a message to the queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint."},"waitStrategy":{"index":4,"kind":"parameter","displayName":"Wait Strategy","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.disruptor.DisruptorWaitStrategy","enum":["Blocking","Sleeping","BusySpin","Yielding"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Blocking","description":"Defines the strategy used by consumer threads to wait on new exchanges to be published. The options allowed are:Blocking, Sleeping, BusySpin and Yielding."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"blockWhenFull":{"index":8,"kind":"parameter","displayName":"Block When Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a thread that sends messages to a full Disruptor will block until the ringbuffer's capacity is no longer exhausted. By default, the calling thread will block and wait until the message can be accepted. By disabling this option, an exception will be thrown stating that the queue is full."},"producerType":{"index":9,"kind":"parameter","displayName":"Producer Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.disruptor.DisruptorProducerType","enum":["Single","Multi"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Multi","description":"Defines the producers allowed on the Disruptor. The options allowed are: Multi to allow multiple producers and Single to enable certain optimizations only allowed when one concurrent producer (on one thread or otherwise synchronized) is active."},"timeout":{"index":10,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Timeout (in milliseconds) before a producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value."},"waitForTaskToComplete":{"index":11,"kind":"parameter","displayName":"Wait For Task To Complete","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.WaitForTaskToComplete","enum":["Never","IfReplyExpected","Always"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"IfReplyExpected","description":"Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based."},"lazyStartProducer":{"index":12,"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."}}} , -{"component":{"kind":"component","name":"djl","title":"Deep Java Library","description":"Infer Deep Learning models from message exchanges data using Deep Java Library (DJL).","deprecated":false,"firstVersion":"3.3.0","label":"ai","javaType":"org.apache.camel.component.djl.DJLComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-djl","version":"4.8.1","scheme":"djl","extendsScheme":"","syntax":"djl:application","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelDjlInput":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The input data used for prediction","constantName":"org.apache.camel.component.djl.DJLConstants#INPUT"},"CamelDjlFileType":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The file type of the message body data. It is used when the body is converted to bytes.","constantName":"org.apache.camel.component.djl.DJLConstants#FILE_TYPE"}},"properties":{"application":{"index":0,"kind":"path","displayName":"Application","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Application name"},"artifactId":{"index":1,"kind":"parameter","displayName":"Artifact Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Model Artifact"},"model":{"index":2,"kind":"parameter","displayName":"Model","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Model"},"showProgress":{"index":3,"kind":"parameter","displayName":"Show Progress","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show progress while loading zoo models. This parameter takes effect only with zoo models"},"translator":{"index":4,"kind":"parameter","displayName":"Translator","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Translator"},"lazyStartProducer":{"index":5,"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."}}} +{"component":{"kind":"component","name":"djl","title":"Deep Java Library","description":"Infer Deep Learning models from message exchanges data using Deep Java Library (DJL).","deprecated":false,"firstVersion":"3.3.0","label":"ai","javaType":"org.apache.camel.component.djl.DJLComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-djl","version":"4.8.2","scheme":"djl","extendsScheme":"","syntax":"djl:application","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelDjlInput":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The input data used for prediction","constantName":"org.apache.camel.component.djl.DJLConstants#INPUT"},"CamelDjlFileType":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The file type of the message body data. It is used when the body is converted to bytes.","constantName":"org.apache.camel.component.djl.DJLConstants#FILE_TYPE"}},"properties":{"application":{"index":0,"kind":"path","displayName":"Application","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Application name"},"artifactId":{"index":1,"kind":"parameter","displayName":"Artifact Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Model Artifact"},"model":{"index":2,"kind":"parameter","displayName":"Model","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Model"},"showProgress":{"index":3,"kind":"parameter","displayName":"Show Progress","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show progress while loading zoo models. This parameter takes effect only with zoo models"},"translator":{"index":4,"kind":"parameter","displayName":"Translator","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Translator"},"lazyStartProducer":{"index":5,"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."}}} , -{"component":{"kind":"component","name":"dns","title":"DNS","description":"Perform DNS queries using DNSJava.","deprecated":false,"firstVersion":"2.7.0","label":"networking","javaType":"org.apache.camel.component.dns.DnsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dns","version":"4.8.1","scheme":"dns","extendsScheme":"","syntax":"dns:dnsType","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"dns.class":{"index":0,"kind":"header","displayName":"","group":"lookup dig","label":"lookup dig","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The DNS class of the lookup. Should match the values of org.xbill.dns.DClass. Optional.","constantName":"org.apache.camel.component.dns.DnsConstants#DNS_CLASS"},"dns.name":{"index":1,"kind":"header","displayName":"","group":"lookup","label":"lookup","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name to lookup","constantName":"org.apache.camel.component.dns.DnsConstants#DNS_NAME"},"dns.domain":{"index":2,"kind":"header","displayName":"","group":"ip","label":"ip","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The domain name.","constantName":"org.apache.camel.component.dns.DnsConstants#DNS_DOMAIN"},"dns.server":{"index":3,"kind":"header","displayName":"","group":"dig","label":"dig","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The server in particular for the query. If none is given, the default one specified by the OS will be used. Optional.","constantName":"org.apache.camel.component.dns.DnsConstants#DNS_SERVER"},"dns.type":{"index":4,"kind":"header","displayName":"","group":"lookup dig","label":"lookup dig","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the lookup. Should match the values of org.xbill.dns.Type. Optional.","constantName":"org.apache.camel.component.dns.DnsConstants#DNS_TYPE"},"term":{"index":5,"kind":"header","displayName":"","group":"wikipedia","label":"wikipedia","required":true,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The term","constantName":"org.apache.camel.component.dns.DnsConstants#TERM"}},"properties":{"dnsType":{"index":0,"kind":"path","displayName":"Dns Type","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.dns.DnsType","enum":["dig","ip","lookup","wikipedia"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the lookup."},"lazyStartProducer":{"index":1,"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."}}} +{"component":{"kind":"component","name":"dns","title":"DNS","description":"Perform DNS queries using DNSJava.","deprecated":false,"firstVersion":"2.7.0","label":"networking","javaType":"org.apache.camel.component.dns.DnsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dns","version":"4.8.2","scheme":"dns","extendsScheme":"","syntax":"dns:dnsType","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"dns.class":{"index":0,"kind":"header","displayName":"","group":"lookup dig","label":"lookup dig","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The DNS class of the lookup. Should match the values of org.xbill.dns.DClass. Optional.","constantName":"org.apache.camel.component.dns.DnsConstants#DNS_CLASS"},"dns.name":{"index":1,"kind":"header","displayName":"","group":"lookup","label":"lookup","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name to lookup","constantName":"org.apache.camel.component.dns.DnsConstants#DNS_NAME"},"dns.domain":{"index":2,"kind":"header","displayName":"","group":"ip","label":"ip","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The domain name.","constantName":"org.apache.camel.component.dns.DnsConstants#DNS_DOMAIN"},"dns.server":{"index":3,"kind":"header","displayName":"","group":"dig","label":"dig","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The server in particular for the query. If none is given, the default one specified by the OS will be used. Optional.","constantName":"org.apache.camel.component.dns.DnsConstants#DNS_SERVER"},"dns.type":{"index":4,"kind":"header","displayName":"","group":"lookup dig","label":"lookup dig","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the lookup. Should match the values of org.xbill.dns.Type. Optional.","constantName":"org.apache.camel.component.dns.DnsConstants#DNS_TYPE"},"term":{"index":5,"kind":"header","displayName":"","group":"wikipedia","label":"wikipedia","required":true,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The term","constantName":"org.apache.camel.component.dns.DnsConstants#TERM"}},"properties":{"dnsType":{"index":0,"kind":"path","displayName":"Dns Type","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.dns.DnsType","enum":["dig","ip","lookup","wikipedia"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the lookup."},"lazyStartProducer":{"index":1,"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."}}} , -{"component":{"kind":"component","name":"docker","title":"Docker","description":"Manage Docker containers.","deprecated":false,"firstVersion":"2.15.0","label":"cloud,container","javaType":"org.apache.camel.component.docker.DockerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-docker","version":"4.8.1","scheme":"docker","extendsScheme":"","syntax":"docker:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelDockerRequestTimeout":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request timeout for response (in seconds)","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_API_REQUEST_TIMEOUT"},"CamelDockerCertPath":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The location containing the SSL certificate chain","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CERT_PATH"},"CamelDockerHost":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The docker host","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_HOST"},"CamelDockerPort":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The docker port","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_PORT"},"CamelDockerMaxPerRouteConnections":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum route connections","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_MAX_PER_ROUTE_CONNECTIONS"},"CamelDockerMaxTotalConnections":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum total connections","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_MAX_TOTAL_CONNECTIONS"},"CamelDockerSecure":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Use HTTPS communication","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_SECURE"},"CamelDockerTlsVerify":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Check TLS","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TLSVERIFY"},"CamelDockerSocketEnabled":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"true","description":"Socket connection mode","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_SOCKET_ENABLED"},"CamelDockerCmdExecFactory":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The fully qualified class name of the DockerCmdExecFactory implementation to use","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CMD_EXEC_FACTORY"},"CamelDockerFilter":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With label filter","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_FILTER"},"CamelDockerShowAll":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With show all flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_SHOW_ALL"},"CamelDockerContainerId":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the container","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CONTAINER_ID"},"CamelDockerImageId":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Image ID","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_IMAGE_ID"},"CamelDockerEmail":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The email address associated with the user","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_EMAIL"},"CamelDockerPassword":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password to authenticate with","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_PASSWORD"},"CamelDockerServerAddress":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The server address for docker registry","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_SERVER_ADDRESS"},"CamelDockerUsername":{"index":17,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user name to authenticate with","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_USERNAME"},"CamelDockerRegistry":{"index":18,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The registry","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_REGISTRY"},"CamelDockerRepository":{"index":19,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The repository","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_REPOSITORY"},"CamelDockerTag":{"index":20,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TAG"},"CamelDockerName":{"index":21,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The image name","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_NAME"},"CamelDockerTerm":{"index":22,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The term to search","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TERM"},"CamelDockerForce":{"index":23,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With force flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_FORCE"},"CamelDockerNoPrune":{"index":24,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With no prune flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_NO_PRUNE"},"CamelDockerInitialRange":{"index":25,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The initial range","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_INITIAL_RANGE"},"CamelDockerBefore":{"index":26,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With before","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_BEFORE"},"CamelDockerLimit":{"index":27,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With limit","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_LIMIT"},"CamelDockerShowSize":{"index":28,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With show size flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_SHOW_SIZE"},"CamelDockerSince":{"index":29,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With since","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_SINCE"},"CamelDockerRemoveVolumes":{"index":30,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With remove volumes flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_REMOVE_VOLUMES"},"CamelDockerFollowStream":{"index":31,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With follow stream flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_FOLLOW_STREAM"},"CamelDockerLogs":{"index":32,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With logs flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_LOGS"},"CamelDockerStdErr":{"index":33,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With stdErr flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_STD_ERR"},"CamelDockerStdOut":{"index":34,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With stdOut flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_STD_OUT"},"CamelDockerTimestamps":{"index":35,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With timestamps flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TIMESTAMPS"},"CamelDockerTail":{"index":36,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With Tail","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TAIL"},"CamelDockerTailAll":{"index":37,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With tail all flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TAIL_ALL"},"CamelDockerHostPath":{"index":38,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The host path","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_HOST_PATH"},"CamelDockerResource":{"index":39,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resource","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_RESOURCE"},"CamelDockerContainerIdDiff":{"index":40,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With container id for diff container request","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CONTAINER_ID_DIFF"},"CamelDockerTimeout":{"index":41,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With timeout","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TIMEOUT"},"CamelDockerSignal":{"index":42,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With signal","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_SIGNAL"},"CamelDockerPsArgs":{"index":43,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With ps args","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_PS_ARGS"},"CamelDockerNoCache":{"index":44,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With no cache flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_NO_CACHE"},"CamelDockerQuiet":{"index":45,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With quiet flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_QUIET"},"CamelDockerRemove":{"index":46,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With remove flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_REMOVE"},"CamelDockerAttachStdErr":{"index":47,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With attach StdErr flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_ATTACH_STD_ERR"},"CamelDockerAttachStdIn":{"index":48,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With attach StdIn flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_ATTACH_STD_IN"},"CamelDockerAttachStdOut":{"index":49,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With attach StdOut flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_ATTACH_STD_OUT"},"CamelDockerAuthor":{"index":50,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The author","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_AUTHOR"},"CamelDockerCmd":{"index":51,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or String[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With cmd","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CMD"},"CamelDockerDisableNetwork":{"index":52,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With disable network flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_DISABLE_NETWORK"},"CamelDockerEnv":{"index":53,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or String[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With env","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_ENV"},"CamelDockerExposedPorts":{"index":54,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"ExposedPorts or ExposedPorts[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The exposed ports","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_EXPOSED_PORTS"},"CamelDockerHostname":{"index":55,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The hostname","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_HOSTNAME"},"CamelDockerMessage":{"index":56,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_MESSAGE"},"CamelDockerMemory":{"index":57,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With memory","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_MEMORY"},"CamelDockerMemorySwap":{"index":58,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long or Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With memory swap","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_MEMORY_SWAP"},"CamelDockerOpenStdIn":{"index":59,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With open StdIn flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_OPEN_STD_IN"},"CamelDockerPause":{"index":60,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With pause flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_PAUSE"},"CamelDockerPortSpecs":{"index":61,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or String[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With port specs","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_PORT_SPECS"},"CamelDockerStdInOnce":{"index":62,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With StdIn in once flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_STD_IN_ONCE"},"CamelDockerTty":{"index":63,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With TTY flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TTY"},"CamelDockerUser":{"index":64,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With user","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_USER"},"CamelDockerVolumes":{"index":65,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Volume or Volume[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With volumes","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_VOLUMES"},"CamelDockerWorkingDir":{"index":66,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With working directory","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_WORKING_DIR"},"CamelDockerCpuShares":{"index":67,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With CPU shares","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CPU_SHARES"},"CamelDockerDns":{"index":68,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or String[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With dns","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_DNS"},"CamelDockerEntryPoint":{"index":69,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or String[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With entrypoint","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_ENTRYPOINT"},"CamelDockerHostConfig":{"index":70,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"com.github.dockerjava.api.model.HostConfig","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With host config","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_HOST_CONFIG"},"CamelDockerImage":{"index":71,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The docker image","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_IMAGE"},"CamelDockerMemoryLimit":{"index":72,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With memory limit","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_MEMORY_LIMIT"},"CamelDockerStdInOpen":{"index":73,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With StdIn in open flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_STD_IN_OPEN"},"CamelDockerVolumesFrom":{"index":74,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"VolumesFrom or VolumesFrom[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With volumes from","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_VOLUMES_FROM"},"CamelDockerDomainName":{"index":75,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With domain name","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_DOMAIN_NAME"},"CamelDockerBinds":{"index":76,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Bind or Bind[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With binds","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_BINDS"},"CamelDockerCapAdd":{"index":77,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Capability or Capability[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With cap add","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CAP_ADD"},"CamelDockerCapDrop":{"index":78,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Capability or Capability[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With cap drop","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CAP_DROP"},"CamelDockerNetwork":{"index":79,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The network name","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_NETWORK"},"CamelDockerDetach":{"index":80,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With detach flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_DETACH"},"CamelDockerExecId":{"index":81,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Exec ID","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_EXEC_ID"}},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.docker.DockerOperation","enum":["events","stats","auth","info","ping","version","imagebuild","imagecreate","imageinspect","imagelist","imagepull","imagepush","imageremove","imagesearch","imagetag","containerattach","containercommit","containercopyfile","containercreate","containerdiff","inspectcontainer","containerkill","containerlist","containerlog","containerpause","containerrestart","containerremove","containerstart","containerstop","containertop","containerunpause","containerwait","execcreate","execstart","networkconnect","networkcreate","networkremove"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Which operation to use"},"email":{"index":1,"kind":"parameter","displayName":"Email","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Email address associated with the user"},"host":{"index":2,"kind":"parameter","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Docker host"},"port":{"index":3,"kind":"parameter","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2375","configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Docker port"},"requestTimeout":{"index":4,"kind":"parameter","displayName":"Request Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Request timeout for response (in seconds)"},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."},"cmdExecFactory":{"index":9,"kind":"parameter","displayName":"Cmd Exec Factory","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"com.github.dockerjava.netty.NettyDockerCmdExecFactory","configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"The fully qualified class name of the DockerCmdExecFactory implementation to use"},"followRedirectFilter":{"index":10,"kind":"parameter","displayName":"Follow Redirect Filter","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Whether to follow redirect filter"},"loggingFilter":{"index":11,"kind":"parameter","displayName":"Logging Filter","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Whether to use logging filter"},"maxPerRouteConnections":{"index":12,"kind":"parameter","displayName":"Max Per Route Connections","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Maximum route connections"},"maxTotalConnections":{"index":13,"kind":"parameter","displayName":"Max Total Connections","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Maximum total connections"},"parameters":{"index":14,"kind":"parameter","displayName":"Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Additional configuration parameters as key/value pairs"},"serverAddress":{"index":15,"kind":"parameter","displayName":"Server Address","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https://index.docker.io/v1/","configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Server address for docker registry."},"socket":{"index":16,"kind":"parameter","displayName":"Socket","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Socket connection mode"},"certPath":{"index":17,"kind":"parameter","displayName":"Cert Path","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Location containing the SSL certificate chain"},"password":{"index":18,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Password to authenticate with"},"secure":{"index":19,"kind":"parameter","displayName":"Secure","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Use HTTPS communication"},"tlsVerify":{"index":20,"kind":"parameter","displayName":"Tls Verify","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Check TLS"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"User name to authenticate with"}}} +{"component":{"kind":"component","name":"docker","title":"Docker","description":"Manage Docker containers.","deprecated":false,"firstVersion":"2.15.0","label":"cloud,container","javaType":"org.apache.camel.component.docker.DockerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-docker","version":"4.8.2","scheme":"docker","extendsScheme":"","syntax":"docker:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelDockerRequestTimeout":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request timeout for response (in seconds)","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_API_REQUEST_TIMEOUT"},"CamelDockerCertPath":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The location containing the SSL certificate chain","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CERT_PATH"},"CamelDockerHost":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The docker host","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_HOST"},"CamelDockerPort":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The docker port","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_PORT"},"CamelDockerMaxPerRouteConnections":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum route connections","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_MAX_PER_ROUTE_CONNECTIONS"},"CamelDockerMaxTotalConnections":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum total connections","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_MAX_TOTAL_CONNECTIONS"},"CamelDockerSecure":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Use HTTPS communication","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_SECURE"},"CamelDockerTlsVerify":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Check TLS","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TLSVERIFY"},"CamelDockerSocketEnabled":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"true","description":"Socket connection mode","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_SOCKET_ENABLED"},"CamelDockerCmdExecFactory":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The fully qualified class name of the DockerCmdExecFactory implementation to use","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CMD_EXEC_FACTORY"},"CamelDockerFilter":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With label filter","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_FILTER"},"CamelDockerShowAll":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With show all flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_SHOW_ALL"},"CamelDockerContainerId":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the container","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CONTAINER_ID"},"CamelDockerImageId":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Image ID","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_IMAGE_ID"},"CamelDockerEmail":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The email address associated with the user","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_EMAIL"},"CamelDockerPassword":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password to authenticate with","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_PASSWORD"},"CamelDockerServerAddress":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The server address for docker registry","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_SERVER_ADDRESS"},"CamelDockerUsername":{"index":17,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user name to authenticate with","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_USERNAME"},"CamelDockerRegistry":{"index":18,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The registry","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_REGISTRY"},"CamelDockerRepository":{"index":19,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The repository","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_REPOSITORY"},"CamelDockerTag":{"index":20,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TAG"},"CamelDockerName":{"index":21,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The image name","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_NAME"},"CamelDockerTerm":{"index":22,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The term to search","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TERM"},"CamelDockerForce":{"index":23,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With force flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_FORCE"},"CamelDockerNoPrune":{"index":24,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With no prune flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_NO_PRUNE"},"CamelDockerInitialRange":{"index":25,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The initial range","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_INITIAL_RANGE"},"CamelDockerBefore":{"index":26,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With before","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_BEFORE"},"CamelDockerLimit":{"index":27,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With limit","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_LIMIT"},"CamelDockerShowSize":{"index":28,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With show size flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_SHOW_SIZE"},"CamelDockerSince":{"index":29,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With since","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_SINCE"},"CamelDockerRemoveVolumes":{"index":30,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With remove volumes flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_REMOVE_VOLUMES"},"CamelDockerFollowStream":{"index":31,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With follow stream flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_FOLLOW_STREAM"},"CamelDockerLogs":{"index":32,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With logs flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_LOGS"},"CamelDockerStdErr":{"index":33,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With stdErr flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_STD_ERR"},"CamelDockerStdOut":{"index":34,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With stdOut flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_STD_OUT"},"CamelDockerTimestamps":{"index":35,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With timestamps flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TIMESTAMPS"},"CamelDockerTail":{"index":36,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With Tail","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TAIL"},"CamelDockerTailAll":{"index":37,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With tail all flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TAIL_ALL"},"CamelDockerHostPath":{"index":38,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The host path","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_HOST_PATH"},"CamelDockerResource":{"index":39,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resource","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_RESOURCE"},"CamelDockerContainerIdDiff":{"index":40,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With container id for diff container request","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CONTAINER_ID_DIFF"},"CamelDockerTimeout":{"index":41,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With timeout","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TIMEOUT"},"CamelDockerSignal":{"index":42,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With signal","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_SIGNAL"},"CamelDockerPsArgs":{"index":43,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With ps args","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_PS_ARGS"},"CamelDockerNoCache":{"index":44,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With no cache flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_NO_CACHE"},"CamelDockerQuiet":{"index":45,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With quiet flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_QUIET"},"CamelDockerRemove":{"index":46,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With remove flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_REMOVE"},"CamelDockerAttachStdErr":{"index":47,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With attach StdErr flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_ATTACH_STD_ERR"},"CamelDockerAttachStdIn":{"index":48,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With attach StdIn flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_ATTACH_STD_IN"},"CamelDockerAttachStdOut":{"index":49,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With attach StdOut flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_ATTACH_STD_OUT"},"CamelDockerAuthor":{"index":50,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The author","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_AUTHOR"},"CamelDockerCmd":{"index":51,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or String[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With cmd","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CMD"},"CamelDockerDisableNetwork":{"index":52,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With disable network flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_DISABLE_NETWORK"},"CamelDockerEnv":{"index":53,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or String[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With env","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_ENV"},"CamelDockerExposedPorts":{"index":54,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"ExposedPorts or ExposedPorts[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The exposed ports","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_EXPOSED_PORTS"},"CamelDockerHostname":{"index":55,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The hostname","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_HOSTNAME"},"CamelDockerMessage":{"index":56,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_MESSAGE"},"CamelDockerMemory":{"index":57,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With memory","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_MEMORY"},"CamelDockerMemorySwap":{"index":58,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long or Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With memory swap","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_MEMORY_SWAP"},"CamelDockerOpenStdIn":{"index":59,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With open StdIn flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_OPEN_STD_IN"},"CamelDockerPause":{"index":60,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With pause flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_PAUSE"},"CamelDockerPortSpecs":{"index":61,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or String[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With port specs","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_PORT_SPECS"},"CamelDockerStdInOnce":{"index":62,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With StdIn in once flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_STD_IN_ONCE"},"CamelDockerTty":{"index":63,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With TTY flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_TTY"},"CamelDockerUser":{"index":64,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With user","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_USER"},"CamelDockerVolumes":{"index":65,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Volume or Volume[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With volumes","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_VOLUMES"},"CamelDockerWorkingDir":{"index":66,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With working directory","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_WORKING_DIR"},"CamelDockerCpuShares":{"index":67,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With CPU shares","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CPU_SHARES"},"CamelDockerDns":{"index":68,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or String[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With dns","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_DNS"},"CamelDockerEntryPoint":{"index":69,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or String[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With entrypoint","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_ENTRYPOINT"},"CamelDockerHostConfig":{"index":70,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"com.github.dockerjava.api.model.HostConfig","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With host config","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_HOST_CONFIG"},"CamelDockerImage":{"index":71,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The docker image","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_IMAGE"},"CamelDockerMemoryLimit":{"index":72,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With memory limit","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_MEMORY_LIMIT"},"CamelDockerStdInOpen":{"index":73,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With StdIn in open flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_STD_IN_OPEN"},"CamelDockerVolumesFrom":{"index":74,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"VolumesFrom or VolumesFrom[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With volumes from","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_VOLUMES_FROM"},"CamelDockerDomainName":{"index":75,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With domain name","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_DOMAIN_NAME"},"CamelDockerBinds":{"index":76,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Bind or Bind[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With binds","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_BINDS"},"CamelDockerCapAdd":{"index":77,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Capability or Capability[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With cap add","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CAP_ADD"},"CamelDockerCapDrop":{"index":78,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Capability or Capability[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With cap drop","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_CAP_DROP"},"CamelDockerNetwork":{"index":79,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The network name","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_NETWORK"},"CamelDockerDetach":{"index":80,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"With detach flag","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_DETACH"},"CamelDockerExecId":{"index":81,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Exec ID","constantName":"org.apache.camel.component.docker.DockerConstants#DOCKER_EXEC_ID"}},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.docker.DockerOperation","enum":["events","stats","auth","info","ping","version","imagebuild","imagecreate","imageinspect","imagelist","imagepull","imagepush","imageremove","imagesearch","imagetag","containerattach","containercommit","containercopyfile","containercreate","containerdiff","inspectcontainer","containerkill","containerlist","containerlog","containerpause","containerrestart","containerremove","containerstart","containerstop","containertop","containerunpause","containerwait","execcreate","execstart","networkconnect","networkcreate","networkremove"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Which operation to use"},"email":{"index":1,"kind":"parameter","displayName":"Email","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Email address associated with the user"},"host":{"index":2,"kind":"parameter","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Docker host"},"port":{"index":3,"kind":"parameter","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2375","configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Docker port"},"requestTimeout":{"index":4,"kind":"parameter","displayName":"Request Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Request timeout for response (in seconds)"},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."},"cmdExecFactory":{"index":9,"kind":"parameter","displayName":"Cmd Exec Factory","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"com.github.dockerjava.netty.NettyDockerCmdExecFactory","configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"The fully qualified class name of the DockerCmdExecFactory implementation to use"},"followRedirectFilter":{"index":10,"kind":"parameter","displayName":"Follow Redirect Filter","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Whether to follow redirect filter"},"loggingFilter":{"index":11,"kind":"parameter","displayName":"Logging Filter","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Whether to use logging filter"},"maxPerRouteConnections":{"index":12,"kind":"parameter","displayName":"Max Per Route Connections","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Maximum route connections"},"maxTotalConnections":{"index":13,"kind":"parameter","displayName":"Max Total Connections","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Maximum total connections"},"parameters":{"index":14,"kind":"parameter","displayName":"Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Additional configuration parameters as key/value pairs"},"serverAddress":{"index":15,"kind":"parameter","displayName":"Server Address","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https://index.docker.io/v1/","configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Server address for docker registry."},"socket":{"index":16,"kind":"parameter","displayName":"Socket","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Socket connection mode"},"certPath":{"index":17,"kind":"parameter","displayName":"Cert Path","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Location containing the SSL certificate chain"},"password":{"index":18,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Password to authenticate with"},"secure":{"index":19,"kind":"parameter","displayName":"Secure","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Use HTTPS communication"},"tlsVerify":{"index":20,"kind":"parameter","displayName":"Tls Verify","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"Check TLS"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.docker.DockerConfiguration","configurationField":"configuration","description":"User name to authenticate with"}}} , -{"component":{"kind":"component","name":"drill","title":"Drill","description":"Perform queries against an Apache Drill cluster.","deprecated":false,"firstVersion":"2.19.0","label":"database,bigdata","javaType":"org.apache.camel.component.drill.DrillComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-drill","version":"4.8.1","scheme":"drill","extendsScheme":"","syntax":"drill:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelDrillQuery":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The drill query","constantName":"org.apache.camel.component.drill.DrillConstants#DRILL_QUERY"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Host name or IP address"},"clusterId":{"index":1,"kind":"parameter","displayName":"Cluster Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Cluster ID https://drill.apache.org/docs/using-the-jdbc-driver/#determining-the-cluster-id"},"directory":{"index":2,"kind":"parameter","displayName":"Directory","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Drill directory"},"mode":{"index":3,"kind":"parameter","displayName":"Mode","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.drill.DrillConnectionMode","enum":["ZK","DRILLBIT"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ZK","description":"Connection mode: zk: Zookeeper drillbit: Drillbit direct connection https://drill.apache.org/docs/using-the-jdbc-driver/"},"port":{"index":4,"kind":"parameter","displayName":"Port","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"2181","description":"Port number"},"lazyStartProducer":{"index":5,"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."}}} +{"component":{"kind":"component","name":"drill","title":"Drill","description":"Perform queries against an Apache Drill cluster.","deprecated":false,"firstVersion":"2.19.0","label":"database,bigdata","javaType":"org.apache.camel.component.drill.DrillComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-drill","version":"4.8.2","scheme":"drill","extendsScheme":"","syntax":"drill:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelDrillQuery":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The drill query","constantName":"org.apache.camel.component.drill.DrillConstants#DRILL_QUERY"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Host name or IP address"},"clusterId":{"index":1,"kind":"parameter","displayName":"Cluster Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Cluster ID https://drill.apache.org/docs/using-the-jdbc-driver/#determining-the-cluster-id"},"directory":{"index":2,"kind":"parameter","displayName":"Directory","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Drill directory"},"mode":{"index":3,"kind":"parameter","displayName":"Mode","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.drill.DrillConnectionMode","enum":["ZK","DRILLBIT"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ZK","description":"Connection mode: zk: Zookeeper drillbit: Drillbit direct connection https://drill.apache.org/docs/using-the-jdbc-driver/"},"port":{"index":4,"kind":"parameter","displayName":"Port","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"2181","description":"Port number"},"lazyStartProducer":{"index":5,"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."}}} , -{"component":{"kind":"component","name":"dropbox","title":"Dropbox","description":"Upload, download and manage files, folders, groups, collaborations, etc on Dropbox.","deprecated":false,"firstVersion":"2.14.0","label":"cloud,file,api","javaType":"org.apache.camel.component.dropbox.DropboxComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dropbox","version":"4.8.1","scheme":"dropbox","extendsScheme":"","syntax":"dropbox:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelDropboxRemotePath":{"index":0,"kind":"header","displayName":"","group":"all","label":"all","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote path","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_REMOTE_PATH"},"CamelDropboxNewRemotePath":{"index":1,"kind":"header","displayName":"","group":"move","label":"move","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The new remote path","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_NEW_REMOTE_PATH"},"CamelDropboxLocalPath":{"index":2,"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local path","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_LOCAL_PATH"},"CamelDropboxUploadMode":{"index":3,"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The upload mode","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_UPLOAD_MODE"},"CamelDropboxQuery":{"index":4,"kind":"header","displayName":"","group":"search","label":"search","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_QUERY"},"CamelDropboxPutFileName":{"index":5,"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the file to upload","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_PUT_FILE_NAME"},"DOWNLOADED_FILE":{"index":6,"kind":"header","displayName":"","group":"get","label":"get","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of single file download, path of the remote file downloaded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#DOWNLOADED_FILE"},"DOWNLOADED_FILES":{"index":7,"kind":"header","displayName":"","group":"get","label":"get","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of multiple files download, path of the remote files downloaded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#DOWNLOADED_FILES"},"UPLOADED_FILE":{"index":8,"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of single file upload, path of the remote path uploaded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#UPLOADED_FILE"},"UPLOADED_FILES":{"index":9,"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of multiple files upload, string with the remote paths uploaded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#UPLOADED_FILES"},"FOUND_FILES":{"index":10,"kind":"header","displayName":"","group":"search","label":"search","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of file path founded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#FOUND_FILES"},"DELETED_PATH":{"index":11,"kind":"header","displayName":"","group":"del","label":"del","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the path deleted on dropbox","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#DELETED_PATH"},"MOVED_PATH":{"index":12,"kind":"header","displayName":"","group":"move","label":"move","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the path moved on dropbox","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#MOVED_PATH"}},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.dropbox.util.DropboxOperation","enum":["put","del","search","get","move"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The specific action (typically is a CRUD action) to perform on Dropbox remote folder."},"clientIdentifier":{"index":1,"kind":"parameter","displayName":"Client Identifier","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"Name of the app registered to make API requests"},"query":{"index":2,"kind":"parameter","displayName":"Query","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"A space-separated list of sub-strings to search for. A file matches only if it contains all the sub-strings. If this option is not set, all files will be matched."},"remotePath":{"index":3,"kind":"parameter","displayName":"Remote Path","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"Original file or folder to move"},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"localPath":{"index":7,"kind":"parameter","displayName":"Local Path","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"Optional folder or file to upload on Dropbox from the local filesystem. If this option has not been configured then the message body is used as the content to upload."},"newRemotePath":{"index":8,"kind":"parameter","displayName":"New Remote Path","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"Destination file or folder"},"uploadMode":{"index":9,"kind":"parameter","displayName":"Upload Mode","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.dropbox.util.DropboxUploadMode","enum":["add","force"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"Which mode to upload. in case of add the new file will be renamed if a file with the same name already exists on dropbox. in case of force if a file with the same name already exists on dropbox, this will be overwritten."},"lazyStartProducer":{"index":10,"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."},"client":{"index":11,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.dropbox.core.v2.DbxClientV2","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"To use an existing DbxClient instance as Dropbox client."},"accessToken":{"index":12,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The access token to make API requests for a specific Dropbox user"},"apiKey":{"index":13,"kind":"parameter","displayName":"Api Key","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The apiKey to make API requests for a specific Dropbox user"},"apiSecret":{"index":14,"kind":"parameter","displayName":"Api Secret","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The apiSecret to make API requests for a specific Dropbox user"},"expireIn":{"index":15,"kind":"parameter","displayName":"Expire In","group":"security","label":"security","required":true,"type":"integer","javaType":"java.lang.Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The expire time to access token for a specific Dropbox user"},"refreshToken":{"index":16,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The refresh token to refresh the access token for a specific Dropbox user"}}} +{"component":{"kind":"component","name":"dropbox","title":"Dropbox","description":"Upload, download and manage files, folders, groups, collaborations, etc on Dropbox.","deprecated":false,"firstVersion":"2.14.0","label":"cloud,file,api","javaType":"org.apache.camel.component.dropbox.DropboxComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dropbox","version":"4.8.2","scheme":"dropbox","extendsScheme":"","syntax":"dropbox:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelDropboxRemotePath":{"index":0,"kind":"header","displayName":"","group":"all","label":"all","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote path","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_REMOTE_PATH"},"CamelDropboxNewRemotePath":{"index":1,"kind":"header","displayName":"","group":"move","label":"move","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The new remote path","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_NEW_REMOTE_PATH"},"CamelDropboxLocalPath":{"index":2,"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local path","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_LOCAL_PATH"},"CamelDropboxUploadMode":{"index":3,"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The upload mode","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_UPLOAD_MODE"},"CamelDropboxQuery":{"index":4,"kind":"header","displayName":"","group":"search","label":"search","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_QUERY"},"CamelDropboxPutFileName":{"index":5,"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the file to upload","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_PUT_FILE_NAME"},"DOWNLOADED_FILE":{"index":6,"kind":"header","displayName":"","group":"get","label":"get","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of single file download, path of the remote file downloaded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#DOWNLOADED_FILE"},"DOWNLOADED_FILES":{"index":7,"kind":"header","displayName":"","group":"get","label":"get","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of multiple files download, path of the remote files downloaded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#DOWNLOADED_FILES"},"UPLOADED_FILE":{"index":8,"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of single file upload, path of the remote path uploaded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#UPLOADED_FILE"},"UPLOADED_FILES":{"index":9,"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of multiple files upload, string with the remote paths uploaded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#UPLOADED_FILES"},"FOUND_FILES":{"index":10,"kind":"header","displayName":"","group":"search","label":"search","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of file path founded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#FOUND_FILES"},"DELETED_PATH":{"index":11,"kind":"header","displayName":"","group":"del","label":"del","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the path deleted on dropbox","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#DELETED_PATH"},"MOVED_PATH":{"index":12,"kind":"header","displayName":"","group":"move","label":"move","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the path moved on dropbox","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#MOVED_PATH"}},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.dropbox.util.DropboxOperation","enum":["put","del","search","get","move"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The specific action (typically is a CRUD action) to perform on Dropbox remote folder."},"clientIdentifier":{"index":1,"kind":"parameter","displayName":"Client Identifier","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"Name of the app registered to make API requests"},"query":{"index":2,"kind":"parameter","displayName":"Query","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"A space-separated list of sub-strings to search for. A file matches only if it contains all the sub-strings. If this option is not set, all files will be matched."},"remotePath":{"index":3,"kind":"parameter","displayName":"Remote Path","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"Original file or folder to move"},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"localPath":{"index":7,"kind":"parameter","displayName":"Local Path","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"Optional folder or file to upload on Dropbox from the local filesystem. If this option has not been configured then the message body is used as the content to upload."},"newRemotePath":{"index":8,"kind":"parameter","displayName":"New Remote Path","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"Destination file or folder"},"uploadMode":{"index":9,"kind":"parameter","displayName":"Upload Mode","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.dropbox.util.DropboxUploadMode","enum":["add","force"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"Which mode to upload. in case of add the new file will be renamed if a file with the same name already exists on dropbox. in case of force if a file with the same name already exists on dropbox, this will be overwritten."},"lazyStartProducer":{"index":10,"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."},"client":{"index":11,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.dropbox.core.v2.DbxClientV2","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"To use an existing DbxClient instance as Dropbox client."},"accessToken":{"index":12,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The access token to make API requests for a specific Dropbox user"},"apiKey":{"index":13,"kind":"parameter","displayName":"Api Key","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The apiKey to make API requests for a specific Dropbox user"},"apiSecret":{"index":14,"kind":"parameter","displayName":"Api Secret","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The apiSecret to make API requests for a specific Dropbox user"},"expireIn":{"index":15,"kind":"parameter","displayName":"Expire In","group":"security","label":"security","required":true,"type":"integer","javaType":"java.lang.Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The expire time to access token for a specific Dropbox user"},"refreshToken":{"index":16,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The refresh token to refresh the access token for a specific Dropbox user"}}} , -{"component":{"kind":"component","name":"dynamic-router","title":"Dynamic Router","description":"The Dynamic Router component routes exchanges to recipients, and the recipients (and their rules) may change at runtime.","deprecated":false,"firstVersion":"3.15.0","label":"messaging,core","javaType":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dynamic-router","version":"4.8.1","scheme":"dynamic-router","extendsScheme":"","syntax":"dynamic-router:channel","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"channel":{"index":0,"kind":"path","displayName":"Channel","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Channel for the Dynamic Router. For example, if the Dynamic Router URI is dynamic-router://test, then the channel is test. Channels are a way of keeping routing participants, their rules, and exchanges logically separate from the participants, rules, and exchanges on other channels. This can be seen as analogous to VLANs in networking."},"aggregationStrategy":{"index":1,"kind":"parameter","displayName":"Aggregation Strategy","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Refers to an AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast. By default, Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy."},"aggregationStrategyBean":{"index":2,"kind":"parameter","displayName":"Aggregation Strategy Bean","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.AggregationStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Refers to an AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast. By default, Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy."},"aggregationStrategyMethodAllowNull":{"index":3,"kind":"parameter","displayName":"Aggregation Strategy Method Allow Null","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"If this option is false then the aggregate method is not used if there was no data to enrich. If this option is true then null values is used as the oldExchange (when no data to enrich), when using POJOs as the AggregationStrategy"},"aggregationStrategyMethodName":{"index":4,"kind":"parameter","displayName":"Aggregation Strategy Method Name","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"You can use a POJO as the AggregationStrategy. This refers to the name of the method that aggregates the exchanges."},"cacheSize":{"index":5,"kind":"parameter","displayName":"Cache Size","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"When caching producer endpoints, this is the size of the cache. Default is 100."},"executorService":{"index":6,"kind":"parameter","displayName":"Executor Service","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Refers to a custom Thread Pool to be used for parallel processing. Notice that, if you set this option, then parallel processing is automatically implied, and you do not have to enable that option in addition to this one."},"executorServiceBean":{"index":7,"kind":"parameter","displayName":"Executor Service Bean","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.concurrent.ExecutorService","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Refers to a custom Thread Pool to be used for parallel processing. Notice that, if you set this option, then parallel processing is automatically implied, and you do not have to enable that option in addition to this one."},"ignoreInvalidEndpoints":{"index":8,"kind":"parameter","displayName":"Ignore Invalid Endpoints","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Ignore the invalid endpoint exception when attempting to create a producer with an invalid endpoint."},"onPrepare":{"index":9,"kind":"parameter","displayName":"On Prepare","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Uses the Processor when preparing the org.apache.camel.Exchange to be sent. This can be used to deep-clone messages that should be sent, or to provide any custom logic that is needed before the exchange is sent. This is the name of a bean in the registry."},"onPrepareProcessor":{"index":10,"kind":"parameter","displayName":"On Prepare Processor","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.Processor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Uses the Processor when preparing the org.apache.camel.Exchange to be sent. This can be used to deep-clone messages that should be sent, or to provide any custom logic that is needed before the exchange is sent. This is a Processor instance."},"parallelAggregate":{"index":11,"kind":"parameter","displayName":"Parallel Aggregate","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"If enabled then the aggregate method on AggregationStrategy can be called concurrently. Notice that this would require the implementation of AggregationStrategy to be implemented as thread-safe. By default, this is false, meaning that Camel synchronizes the call to the aggregate method. Though, in some use-cases, this can be used to archive higher performance when the AggregationStrategy is implemented as thread-safe."},"parallelProcessing":{"index":12,"kind":"parameter","displayName":"Parallel Processing","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"If enabled, then sending via multicast occurs concurrently. Note that the caller thread will still wait until all messages have been fully processed before it continues. It is only the sending and processing of the replies from the multicast recipients that happens concurrently. When parallel processing is enabled, then the Camel routing engine will continue processing using the last used thread from the parallel thread pool. However, if you want to use the original thread that called the multicast, then make sure to enable the synchronous option as well."},"recipientMode":{"index":13,"kind":"parameter","displayName":"Recipient Mode","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","enum":["firstMatch","allMatch"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"firstMatch","configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Recipient mode: firstMatch or allMatch"},"shareUnitOfWork":{"index":14,"kind":"parameter","displayName":"Share Unit Of Work","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Shares the org.apache.camel.spi.UnitOfWork with the parent and each of the sub messages. Multicast will, by default, not share a unit of work between the parent exchange and each multicasted exchange. This means each sub exchange has its own individual unit of work."},"stopOnException":{"index":15,"kind":"parameter","displayName":"Stop On Exception","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Will stop further processing if an exception or failure occurred during processing of an org.apache.camel.Exchange and the caused exception will be thrown. Will also stop if processing the exchange failed (has a fault message), or an exception was thrown and handled by the error handler (such as using onException). In all situations, the multicast will stop further processing. This is the same behavior as in the pipeline that is used by the routing engine. The default behavior is to not stop, but to continue processing until the end."},"streaming":{"index":16,"kind":"parameter","displayName":"Streaming","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"If enabled, then Camel will process replies out-of-order (e.g., in the order they come back). If disabled, Camel will process replies in the same order as defined by the multicast."},"synchronous":{"index":17,"kind":"parameter","displayName":"Synchronous","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used. When enabled then the same thread is used to continue routing after the multicast is complete, even if parallel processing is enabled."},"timeout":{"index":18,"kind":"parameter","displayName":"Timeout","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Sets a total timeout specified in milliseconds, when using parallel processing. If the Multicast has not been able to send and process all replies within the given timeframe, then the timeout triggers and the Multicast breaks out and continues. Notice that, if you provide a TimeoutAwareAggregationStrategy, then the timeout method is invoked before breaking out. If the timeout is reached with running tasks still remaining, certain tasks (for which it is difficult for Camel to shut down in a graceful manner) may continue to run. So use this option with a bit of care."},"warnDroppedMessage":{"index":19,"kind":"parameter","displayName":"Warn Dropped Message","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Flag to log a warning if no predicates match for an exchange."},"lazyStartProducer":{"index":20,"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."}}} +{"component":{"kind":"component","name":"dynamic-router","title":"Dynamic Router","description":"The Dynamic Router component routes exchanges to recipients, and the recipients (and their rules) may change at runtime.","deprecated":false,"firstVersion":"3.15.0","label":"messaging,core","javaType":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dynamic-router","version":"4.8.2","scheme":"dynamic-router","extendsScheme":"","syntax":"dynamic-router:channel","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"channel":{"index":0,"kind":"path","displayName":"Channel","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Channel for the Dynamic Router. For example, if the Dynamic Router URI is dynamic-router://test, then the channel is test. Channels are a way of keeping routing participants, their rules, and exchanges logically separate from the participants, rules, and exchanges on other channels. This can be seen as analogous to VLANs in networking."},"aggregationStrategy":{"index":1,"kind":"parameter","displayName":"Aggregation Strategy","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Refers to an AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast. By default, Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy."},"aggregationStrategyBean":{"index":2,"kind":"parameter","displayName":"Aggregation Strategy Bean","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.AggregationStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Refers to an AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast. By default, Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy."},"aggregationStrategyMethodAllowNull":{"index":3,"kind":"parameter","displayName":"Aggregation Strategy Method Allow Null","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"If this option is false then the aggregate method is not used if there was no data to enrich. If this option is true then null values is used as the oldExchange (when no data to enrich), when using POJOs as the AggregationStrategy"},"aggregationStrategyMethodName":{"index":4,"kind":"parameter","displayName":"Aggregation Strategy Method Name","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"You can use a POJO as the AggregationStrategy. This refers to the name of the method that aggregates the exchanges."},"cacheSize":{"index":5,"kind":"parameter","displayName":"Cache Size","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"When caching producer endpoints, this is the size of the cache. Default is 100."},"executorService":{"index":6,"kind":"parameter","displayName":"Executor Service","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Refers to a custom Thread Pool to be used for parallel processing. Notice that, if you set this option, then parallel processing is automatically implied, and you do not have to enable that option in addition to this one."},"executorServiceBean":{"index":7,"kind":"parameter","displayName":"Executor Service Bean","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.concurrent.ExecutorService","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Refers to a custom Thread Pool to be used for parallel processing. Notice that, if you set this option, then parallel processing is automatically implied, and you do not have to enable that option in addition to this one."},"ignoreInvalidEndpoints":{"index":8,"kind":"parameter","displayName":"Ignore Invalid Endpoints","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Ignore the invalid endpoint exception when attempting to create a producer with an invalid endpoint."},"onPrepare":{"index":9,"kind":"parameter","displayName":"On Prepare","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Uses the Processor when preparing the org.apache.camel.Exchange to be sent. This can be used to deep-clone messages that should be sent, or to provide any custom logic that is needed before the exchange is sent. This is the name of a bean in the registry."},"onPrepareProcessor":{"index":10,"kind":"parameter","displayName":"On Prepare Processor","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.Processor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Uses the Processor when preparing the org.apache.camel.Exchange to be sent. This can be used to deep-clone messages that should be sent, or to provide any custom logic that is needed before the exchange is sent. This is a Processor instance."},"parallelAggregate":{"index":11,"kind":"parameter","displayName":"Parallel Aggregate","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"If enabled then the aggregate method on AggregationStrategy can be called concurrently. Notice that this would require the implementation of AggregationStrategy to be implemented as thread-safe. By default, this is false, meaning that Camel synchronizes the call to the aggregate method. Though, in some use-cases, this can be used to archive higher performance when the AggregationStrategy is implemented as thread-safe."},"parallelProcessing":{"index":12,"kind":"parameter","displayName":"Parallel Processing","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"If enabled, then sending via multicast occurs concurrently. Note that the caller thread will still wait until all messages have been fully processed before it continues. It is only the sending and processing of the replies from the multicast recipients that happens concurrently. When parallel processing is enabled, then the Camel routing engine will continue processing using the last used thread from the parallel thread pool. However, if you want to use the original thread that called the multicast, then make sure to enable the synchronous option as well."},"recipientMode":{"index":13,"kind":"parameter","displayName":"Recipient Mode","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","enum":["firstMatch","allMatch"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"firstMatch","configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Recipient mode: firstMatch or allMatch"},"shareUnitOfWork":{"index":14,"kind":"parameter","displayName":"Share Unit Of Work","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Shares the org.apache.camel.spi.UnitOfWork with the parent and each of the sub messages. Multicast will, by default, not share a unit of work between the parent exchange and each multicasted exchange. This means each sub exchange has its own individual unit of work."},"stopOnException":{"index":15,"kind":"parameter","displayName":"Stop On Exception","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Will stop further processing if an exception or failure occurred during processing of an org.apache.camel.Exchange and the caused exception will be thrown. Will also stop if processing the exchange failed (has a fault message), or an exception was thrown and handled by the error handler (such as using onException). In all situations, the multicast will stop further processing. This is the same behavior as in the pipeline that is used by the routing engine. The default behavior is to not stop, but to continue processing until the end."},"streaming":{"index":16,"kind":"parameter","displayName":"Streaming","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"If enabled, then Camel will process replies out-of-order (e.g., in the order they come back). If disabled, Camel will process replies in the same order as defined by the multicast."},"synchronous":{"index":17,"kind":"parameter","displayName":"Synchronous","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used. When enabled then the same thread is used to continue routing after the multicast is complete, even if parallel processing is enabled."},"timeout":{"index":18,"kind":"parameter","displayName":"Timeout","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Sets a total timeout specified in milliseconds, when using parallel processing. If the Multicast has not been able to send and process all replies within the given timeframe, then the timeout triggers and the Multicast breaks out and continues. Notice that, if you provide a TimeoutAwareAggregationStrategy, then the timeout method is invoked before breaking out. If the timeout is reached with running tasks still remaining, certain tasks (for which it is difficult for Camel to shut down in a graceful manner) may continue to run. So use this option with a bit of care."},"warnDroppedMessage":{"index":19,"kind":"parameter","displayName":"Warn Dropped Message","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.dynamicrouter.routing.DynamicRouterConfiguration","configurationField":"configuration","description":"Flag to log a warning if no predicates match for an exchange."},"lazyStartProducer":{"index":20,"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."}}} , -{"component":{"kind":"component","name":"dynamic-router-control","title":"Dynamic Router Control","description":"The Dynamic Router control endpoint for operations that allow routing participants to subscribe or unsubscribe to participate in dynamic message routing.","deprecated":false,"firstVersion":"4.4.0","label":"messaging","javaType":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dynamic-router","version":"4.8.1","scheme":"dynamic-router-control","extendsScheme":"","syntax":"dynamic-router-control:controlAction","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelDynamicRouterControlAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The control action header.","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_ACTION_HEADER"},"CamelDynamicRouterSubscribeChannel":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Dynamic Router channel that the subscriber is subscribing on.","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_SUBSCRIBE_CHANNEL"},"CamelDynamicRouterSubscriptionId":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The subscription ID.","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_SUBSCRIPTION_ID"},"CamelDynamicRouterDestinationUri":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The URI on which the routing participant wants to receive matching exchanges.","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_DESTINATION_URI"},"CamelDynamicRouterPriority":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The priority of this subscription","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_PRIORITY"},"CamelDynamicRouterPredicate":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The predicate to evaluate exchanges for this subscription","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_PREDICATE"},"CamelDynamicRouterPredicateBean":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the bean in the registry that identifies the subscription predicate.","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_PREDICATE_BEAN"},"CamelDynamicRouterExpressionLanguage":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The language for the predicate when supplied as a string.","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_EXPRESSION_LANGUAGE"}},"properties":{"controlAction":{"index":0,"kind":"path","displayName":"Control Action","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["subscribe","unsubscribe","update","list","statistics"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Control action"},"lazyStartProducer":{"index":1,"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."},"destinationUri":{"index":2,"kind":"parameter","displayName":"Destination Uri","group":"control","label":"control","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConfiguration","configurationField":"configuration","description":"The destination URI for exchanges that match."},"expressionLanguage":{"index":3,"kind":"parameter","displayName":"Expression Language","group":"control","label":"control","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"simple","configurationClass":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConfiguration","configurationField":"configuration","description":"The subscription predicate language."},"predicate":{"index":4,"kind":"parameter","displayName":"Predicate","group":"control","label":"control","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConfiguration","configurationField":"configuration","description":"The subscription predicate."},"predicateBean":{"index":5,"kind":"parameter","displayName":"Predicate Bean","group":"control","label":"control","required":false,"type":"object","javaType":"org.apache.camel.Predicate","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConfiguration","configurationField":"configuration","description":"A Predicate instance in the registry."},"priority":{"index":6,"kind":"parameter","displayName":"Priority","group":"control","label":"control","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConfiguration","configurationField":"configuration","description":"The subscription priority."},"subscribeChannel":{"index":7,"kind":"parameter","displayName":"Subscribe Channel","group":"control","label":"control","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConfiguration","configurationField":"configuration","description":"The channel to subscribe to"},"subscriptionId":{"index":8,"kind":"parameter","displayName":"Subscription Id","group":"control","label":"control","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConfiguration","configurationField":"configuration","description":"The subscription ID; if unspecified, one will be assigned and returned."}}} +{"component":{"kind":"component","name":"dynamic-router-control","title":"Dynamic Router Control","description":"The Dynamic Router control endpoint for operations that allow routing participants to subscribe or unsubscribe to participate in dynamic message routing.","deprecated":false,"firstVersion":"4.4.0","label":"messaging","javaType":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dynamic-router","version":"4.8.2","scheme":"dynamic-router-control","extendsScheme":"","syntax":"dynamic-router-control:controlAction","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelDynamicRouterControlAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The control action header.","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_ACTION_HEADER"},"CamelDynamicRouterSubscribeChannel":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Dynamic Router channel that the subscriber is subscribing on.","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_SUBSCRIBE_CHANNEL"},"CamelDynamicRouterSubscriptionId":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The subscription ID.","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_SUBSCRIPTION_ID"},"CamelDynamicRouterDestinationUri":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The URI on which the routing participant wants to receive matching exchanges.","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_DESTINATION_URI"},"CamelDynamicRouterPriority":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The priority of this subscription","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_PRIORITY"},"CamelDynamicRouterPredicate":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The predicate to evaluate exchanges for this subscription","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_PREDICATE"},"CamelDynamicRouterPredicateBean":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the bean in the registry that identifies the subscription predicate.","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_PREDICATE_BEAN"},"CamelDynamicRouterExpressionLanguage":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The language for the predicate when supplied as a string.","constantName":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConstants#CONTROL_EXPRESSION_LANGUAGE"}},"properties":{"controlAction":{"index":0,"kind":"path","displayName":"Control Action","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["subscribe","unsubscribe","update","list","statistics"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Control action"},"lazyStartProducer":{"index":1,"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."},"destinationUri":{"index":2,"kind":"parameter","displayName":"Destination Uri","group":"control","label":"control","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConfiguration","configurationField":"configuration","description":"The destination URI for exchanges that match."},"expressionLanguage":{"index":3,"kind":"parameter","displayName":"Expression Language","group":"control","label":"control","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"simple","configurationClass":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConfiguration","configurationField":"configuration","description":"The subscription predicate language."},"predicate":{"index":4,"kind":"parameter","displayName":"Predicate","group":"control","label":"control","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConfiguration","configurationField":"configuration","description":"The subscription predicate."},"predicateBean":{"index":5,"kind":"parameter","displayName":"Predicate Bean","group":"control","label":"control","required":false,"type":"object","javaType":"org.apache.camel.Predicate","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConfiguration","configurationField":"configuration","description":"A Predicate instance in the registry."},"priority":{"index":6,"kind":"parameter","displayName":"Priority","group":"control","label":"control","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConfiguration","configurationField":"configuration","description":"The subscription priority."},"subscribeChannel":{"index":7,"kind":"parameter","displayName":"Subscribe Channel","group":"control","label":"control","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConfiguration","configurationField":"configuration","description":"The channel to subscribe to"},"subscriptionId":{"index":8,"kind":"parameter","displayName":"Subscription Id","group":"control","label":"control","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dynamicrouter.control.DynamicRouterControlConfiguration","configurationField":"configuration","description":"The subscription ID; if unspecified, one will be assigned and returned."}}} , -{"component":{"kind":"component","name":"ehcache","title":"Ehcache","description":"Perform caching operations using Ehcache.","deprecated":false,"firstVersion":"2.18.0","label":"cache,clustering","javaType":"org.apache.camel.component.ehcache.EhcacheComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ehcache","version":"4.8.1","scheme":"ehcache","extendsScheme":"","syntax":"ehcache:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelEhcacheAction":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to be performed on the cache, valid options are: CLEAR PUT PUT_ALL PUT_IF_ABSENT GET GET_ALL REMOVE REMOVE_ALL REPLACE","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#ACTION"},"CamelEhcacheActionHasResult":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set to true if the action has a result","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#ACTION_HAS_RESULT"},"CamelEhcacheActionSucceeded":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set to true if the action was successful","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#ACTION_SUCCEEDED"},"CamelEhcacheKey":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cache key used for an action","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#KEY"},"CamelEhcacheKeys":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A list of keys, used in PUT_ALL GET_ALL REMOVE_ALL","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#KEYS"},"CamelEhcacheValue":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value to put in the cache or the result of an operation","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#VALUE"},"CamelEhcacheOldValue":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value associated to a key for actions like PUT_IF_ABSENT or the Object used for comparison for actions like REPLACE","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#OLD_VALUE"},"CamelEhcacheEventType":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"EventType","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event received","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#EVENT_TYPE"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the cache name"},"cacheManager":{"index":1,"kind":"parameter","displayName":"Cache Manager","group":"common","label":"","required":false,"type":"object","javaType":"org.ehcache.CacheManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"The cache manager"},"cacheManagerConfiguration":{"index":2,"kind":"parameter","displayName":"Cache Manager Configuration","group":"common","label":"","required":false,"type":"object","javaType":"org.ehcache.config.Configuration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"The cache manager configuration"},"configurationUri":{"index":3,"kind":"parameter","displayName":"Configuration Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"URI pointing to the Ehcache XML configuration file's location"},"createCacheIfNotExist":{"index":4,"kind":"parameter","displayName":"Create Cache If Not Exist","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"Configure if a cache need to be created if it does exist or can't be pre-configured."},"eventFiring":{"index":5,"kind":"parameter","displayName":"Event Firing","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.ehcache.event.EventFiring","enum":["ASYNCHRONOUS","SYNCHRONOUS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ASYNCHRONOUS","configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"Set the delivery mode (synchronous, asynchronous)"},"eventOrdering":{"index":6,"kind":"parameter","displayName":"Event Ordering","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.ehcache.event.EventOrdering","enum":["UNORDERED","ORDERED"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ORDERED","configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"Set the delivery mode (ordered, unordered)"},"eventTypes":{"index":7,"kind":"parameter","displayName":"Event Types","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["EVICTED","EXPIRED","REMOVED","CREATED","UPDATED"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"Set the type of events to listen for (EVICTED,EXPIRED,REMOVED,CREATED,UPDATED). You can specify multiple entries separated by comma."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"action":{"index":11,"kind":"parameter","displayName":"Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence."},"key":{"index":12,"kind":"parameter","displayName":"Key","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"To configure the default action key. If a key is set in the message header, then the key from the header takes precedence."},"lazyStartProducer":{"index":13,"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."},"configuration":{"index":14,"kind":"parameter","displayName":"Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.ehcache.config.CacheConfiguration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"The default cache configuration to be used to create caches."},"configurations":{"index":15,"kind":"parameter","displayName":"Configurations","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"A map of cache configuration to be used to create caches."},"keyType":{"index":16,"kind":"parameter","displayName":"Key Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"The cache key type, default java.lang.Object"},"valueType":{"index":17,"kind":"parameter","displayName":"Value Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"The cache value type, default java.lang.Object"}}} +{"component":{"kind":"component","name":"ehcache","title":"Ehcache","description":"Perform caching operations using Ehcache.","deprecated":false,"firstVersion":"2.18.0","label":"cache,clustering","javaType":"org.apache.camel.component.ehcache.EhcacheComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ehcache","version":"4.8.2","scheme":"ehcache","extendsScheme":"","syntax":"ehcache:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelEhcacheAction":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to be performed on the cache, valid options are: CLEAR PUT PUT_ALL PUT_IF_ABSENT GET GET_ALL REMOVE REMOVE_ALL REPLACE","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#ACTION"},"CamelEhcacheActionHasResult":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set to true if the action has a result","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#ACTION_HAS_RESULT"},"CamelEhcacheActionSucceeded":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set to true if the action was successful","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#ACTION_SUCCEEDED"},"CamelEhcacheKey":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cache key used for an action","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#KEY"},"CamelEhcacheKeys":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A list of keys, used in PUT_ALL GET_ALL REMOVE_ALL","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#KEYS"},"CamelEhcacheValue":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value to put in the cache or the result of an operation","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#VALUE"},"CamelEhcacheOldValue":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value associated to a key for actions like PUT_IF_ABSENT or the Object used for comparison for actions like REPLACE","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#OLD_VALUE"},"CamelEhcacheEventType":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"EventType","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event received","constantName":"org.apache.camel.component.ehcache.EhcacheConstants#EVENT_TYPE"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the cache name"},"cacheManager":{"index":1,"kind":"parameter","displayName":"Cache Manager","group":"common","label":"","required":false,"type":"object","javaType":"org.ehcache.CacheManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"The cache manager"},"cacheManagerConfiguration":{"index":2,"kind":"parameter","displayName":"Cache Manager Configuration","group":"common","label":"","required":false,"type":"object","javaType":"org.ehcache.config.Configuration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"The cache manager configuration"},"configurationUri":{"index":3,"kind":"parameter","displayName":"Configuration Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"URI pointing to the Ehcache XML configuration file's location"},"createCacheIfNotExist":{"index":4,"kind":"parameter","displayName":"Create Cache If Not Exist","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"Configure if a cache need to be created if it does exist or can't be pre-configured."},"eventFiring":{"index":5,"kind":"parameter","displayName":"Event Firing","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.ehcache.event.EventFiring","enum":["ASYNCHRONOUS","SYNCHRONOUS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ASYNCHRONOUS","configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"Set the delivery mode (synchronous, asynchronous)"},"eventOrdering":{"index":6,"kind":"parameter","displayName":"Event Ordering","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.ehcache.event.EventOrdering","enum":["UNORDERED","ORDERED"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ORDERED","configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"Set the delivery mode (ordered, unordered)"},"eventTypes":{"index":7,"kind":"parameter","displayName":"Event Types","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["EVICTED","EXPIRED","REMOVED","CREATED","UPDATED"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"Set the type of events to listen for (EVICTED,EXPIRED,REMOVED,CREATED,UPDATED). You can specify multiple entries separated by comma."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"action":{"index":11,"kind":"parameter","displayName":"Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence."},"key":{"index":12,"kind":"parameter","displayName":"Key","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"To configure the default action key. If a key is set in the message header, then the key from the header takes precedence."},"lazyStartProducer":{"index":13,"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."},"configuration":{"index":14,"kind":"parameter","displayName":"Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.ehcache.config.CacheConfiguration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"The default cache configuration to be used to create caches."},"configurations":{"index":15,"kind":"parameter","displayName":"Configurations","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"A map of cache configuration to be used to create caches."},"keyType":{"index":16,"kind":"parameter","displayName":"Key Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"The cache key type, default java.lang.Object"},"valueType":{"index":17,"kind":"parameter","displayName":"Value Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ehcache.EhcacheConfiguration","configurationField":"configuration","description":"The cache value type, default java.lang.Object"}}} , -{"component":{"kind":"component","name":"elasticsearch","title":"Elasticsearch","description":"Send requests to ElasticSearch via Java Client API.","deprecated":false,"firstVersion":"3.19.0","label":"search,monitoring","javaType":"org.apache.camel.component.es.ElasticsearchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-elasticsearch","version":"4.8.1","scheme":"elasticsearch","extendsScheme":"","syntax":"elasticsearch:clusterName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"operation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.es.ElasticsearchOperation","enum":["Index","Update","Bulk","GetById","MultiGet","MultiSearch","Delete","DeleteIndex","Search","Exists","Ping"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_OPERATION"},"indexId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the indexed document.","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_INDEX_ID"},"indexName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the index to act against","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_INDEX_NAME"},"documentClass":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"ObjectNode","description":"The full qualified name of the class of the document to unmarshall","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_DOCUMENT_CLASS"},"waitForActiveShards":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index creation waits for the write consistency number of shards to be available","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_WAIT_FOR_ACTIVE_SHARDS"},"scrollKeepAliveMs":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The starting index of the response.","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_SCROLL_KEEP_ALIVE_MS"},"useScroll":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set to true to enable scroll usage","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_SCROLL"},"size":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the response.","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_SIZE"},"from":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The starting index of the response.","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_FROM"},"enableDocumentOnlyMode":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Indicates whether the body of the message contains only documents.","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_DOCUMENT_MODE"}},"properties":{"clusterName":{"index":0,"kind":"path","displayName":"Cluster Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Name of the cluster"},"connectionTimeout":{"index":1,"kind":"parameter","displayName":"Connection Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The time in ms to wait before connection will time out."},"disconnect":{"index":2,"kind":"parameter","displayName":"Disconnect","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Disconnect after it finish calling the producer"},"enableDocumentOnlyMode":{"index":3,"kind":"parameter","displayName":"Enable Document Only Mode","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Indicates whether the body of the message contains only documents. By default, it is set to false to be able to do the same requests as what the Document API supports (see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs.html for more details). To ease the migration of routes based on the legacy component camel-elasticsearch-rest, you should consider enabling the mode, especially if your routes do update operations."},"from":{"index":4,"kind":"parameter","displayName":"From","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Starting index of the response."},"hostAddresses":{"index":5,"kind":"parameter","displayName":"Host Addresses","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Comma separated list with ip:port formatted remote transport addresses to use."},"indexName":{"index":6,"kind":"parameter","displayName":"Index Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The name of the index to act against"},"maxRetryTimeout":{"index":7,"kind":"parameter","displayName":"Max Retry Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The time in ms before retry"},"operation":{"index":8,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.es.ElasticsearchOperation","enum":["Index","Update","Bulk","GetById","MultiGet","MultiSearch","Delete","DeleteIndex","Search","Exists","Ping"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"What operation to perform"},"scrollKeepAliveMs":{"index":9,"kind":"parameter","displayName":"Scroll Keep Alive Ms","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Time in ms during which elasticsearch will keep search context alive"},"size":{"index":10,"kind":"parameter","displayName":"Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Size of the response."},"socketTimeout":{"index":11,"kind":"parameter","displayName":"Socket Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The timeout in ms to wait before the socket will time out."},"useScroll":{"index":12,"kind":"parameter","displayName":"Use Scroll","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Enable scroll usage"},"waitForActiveShards":{"index":13,"kind":"parameter","displayName":"Wait For Active Shards","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Index creation waits for the write consistency number of shards to be available"},"lazyStartProducer":{"index":14,"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."},"documentClass":{"index":15,"kind":"parameter","displayName":"Document Class","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ObjectNode","configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The class to use when deserializing the documents."},"enableSniffer":{"index":16,"kind":"parameter","displayName":"Enable Sniffer","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Enable automatically discover nodes from a running Elasticsearch cluster. If this option is used in conjunction with Spring Boot, then it's managed by the Spring Boot configuration (see: Disable Sniffer in Spring Boot)."},"sniffAfterFailureDelay":{"index":17,"kind":"parameter","displayName":"Sniff After Failure Delay","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The delay of a sniff execution scheduled after a failure (in milliseconds)"},"snifferInterval":{"index":18,"kind":"parameter","displayName":"Sniffer Interval","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":300000,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions"},"certificatePath":{"index":19,"kind":"parameter","displayName":"Certificate Path","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The certificate that can be used to access the ES Cluster. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"enableSSL":{"index":20,"kind":"parameter","displayName":"Enable SSL","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Enable SSL"}}} +{"component":{"kind":"component","name":"elasticsearch","title":"Elasticsearch","description":"Send requests to ElasticSearch via Java Client API.","deprecated":false,"firstVersion":"3.19.0","label":"search,monitoring","javaType":"org.apache.camel.component.es.ElasticsearchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-elasticsearch","version":"4.8.2","scheme":"elasticsearch","extendsScheme":"","syntax":"elasticsearch:clusterName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"operation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.es.ElasticsearchOperation","enum":["Index","Update","Bulk","GetById","MultiGet","MultiSearch","Delete","DeleteIndex","Search","Exists","Ping"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_OPERATION"},"indexId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the indexed document.","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_INDEX_ID"},"indexName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the index to act against","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_INDEX_NAME"},"documentClass":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"ObjectNode","description":"The full qualified name of the class of the document to unmarshall","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_DOCUMENT_CLASS"},"waitForActiveShards":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index creation waits for the write consistency number of shards to be available","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_WAIT_FOR_ACTIVE_SHARDS"},"scrollKeepAliveMs":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The starting index of the response.","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_SCROLL_KEEP_ALIVE_MS"},"useScroll":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set to true to enable scroll usage","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_SCROLL"},"size":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the response.","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_SIZE"},"from":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The starting index of the response.","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_FROM"},"enableDocumentOnlyMode":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Indicates whether the body of the message contains only documents.","constantName":"org.apache.camel.component.es.ElasticsearchConstants#PARAM_DOCUMENT_MODE"}},"properties":{"clusterName":{"index":0,"kind":"path","displayName":"Cluster Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Name of the cluster"},"connectionTimeout":{"index":1,"kind":"parameter","displayName":"Connection Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The time in ms to wait before connection will time out."},"disconnect":{"index":2,"kind":"parameter","displayName":"Disconnect","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Disconnect after it finish calling the producer"},"enableDocumentOnlyMode":{"index":3,"kind":"parameter","displayName":"Enable Document Only Mode","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Indicates whether the body of the message contains only documents. By default, it is set to false to be able to do the same requests as what the Document API supports (see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs.html for more details). To ease the migration of routes based on the legacy component camel-elasticsearch-rest, you should consider enabling the mode, especially if your routes do update operations."},"from":{"index":4,"kind":"parameter","displayName":"From","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Starting index of the response."},"hostAddresses":{"index":5,"kind":"parameter","displayName":"Host Addresses","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Comma separated list with ip:port formatted remote transport addresses to use."},"indexName":{"index":6,"kind":"parameter","displayName":"Index Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The name of the index to act against"},"maxRetryTimeout":{"index":7,"kind":"parameter","displayName":"Max Retry Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The time in ms before retry"},"operation":{"index":8,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.es.ElasticsearchOperation","enum":["Index","Update","Bulk","GetById","MultiGet","MultiSearch","Delete","DeleteIndex","Search","Exists","Ping"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"What operation to perform"},"scrollKeepAliveMs":{"index":9,"kind":"parameter","displayName":"Scroll Keep Alive Ms","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Time in ms during which elasticsearch will keep search context alive"},"size":{"index":10,"kind":"parameter","displayName":"Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Size of the response."},"socketTimeout":{"index":11,"kind":"parameter","displayName":"Socket Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The timeout in ms to wait before the socket will time out."},"useScroll":{"index":12,"kind":"parameter","displayName":"Use Scroll","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Enable scroll usage"},"waitForActiveShards":{"index":13,"kind":"parameter","displayName":"Wait For Active Shards","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Index creation waits for the write consistency number of shards to be available"},"lazyStartProducer":{"index":14,"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."},"documentClass":{"index":15,"kind":"parameter","displayName":"Document Class","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ObjectNode","configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The class to use when deserializing the documents."},"enableSniffer":{"index":16,"kind":"parameter","displayName":"Enable Sniffer","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Enable automatically discover nodes from a running Elasticsearch cluster. If this option is used in conjunction with Spring Boot, then it's managed by the Spring Boot configuration (see: Disable Sniffer in Spring Boot)."},"sniffAfterFailureDelay":{"index":17,"kind":"parameter","displayName":"Sniff After Failure Delay","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The delay of a sniff execution scheduled after a failure (in milliseconds)"},"snifferInterval":{"index":18,"kind":"parameter","displayName":"Sniffer Interval","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":300000,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions"},"certificatePath":{"index":19,"kind":"parameter","displayName":"Certificate Path","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"The certificate that can be used to access the ES Cluster. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"enableSSL":{"index":20,"kind":"parameter","displayName":"Enable SSL","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.es.ElasticsearchConfiguration","configurationField":"configuration","description":"Enable SSL"}}} , -{"component":{"kind":"component","name":"elasticsearch-rest-client","title":"Elasticsearch Low level Rest Client","description":"Perform queries and other operations on Elasticsearch or OpenSearch (uses low-level client).","deprecated":false,"firstVersion":"4.3.0","label":"search","javaType":"org.apache.camel.component.elasticsearch.rest.client.ElasticsearchRestClientComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-elasticsearch-rest-client","version":"4.8.1","scheme":"elasticsearch-rest-client","extendsScheme":"","syntax":"elasticsearch-rest-client:clusterName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"ID":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the object to index or retrieve or delete","constantName":"org.apache.camel.component.elasticsearch.rest.client.ElasticSearchRestClientConstant#ID"},"SEARCH_QUERY":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JSON Query to perform for search","constantName":"org.apache.camel.component.elasticsearch.rest.client.ElasticSearchRestClientConstant#SEARCH_QUERY"},"INDEX_SETTINGS":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Advanced - The JSON Index Settings and/or Mappings Query to perform to create an index","constantName":"org.apache.camel.component.elasticsearch.rest.client.ElasticSearchRestClientConstant#INDEX_SETTINGS"},"INDEX_NAME":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Index name","constantName":"org.apache.camel.component.elasticsearch.rest.client.ElasticSearchRestClientConstant#INDEX_NAME"}},"properties":{"clusterName":{"index":0,"kind":"path","displayName":"Cluster Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cluster Name"},"connectionTimeout":{"index":1,"kind":"parameter","displayName":"Connection Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"description":"Connection timeout"},"hostAddressesList":{"index":2,"kind":"parameter","displayName":"Host Addresses List","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"List of host Addresses, multiple hosts can be separated by comma."},"indexName":{"index":3,"kind":"parameter","displayName":"Index Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Index Name"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.elasticsearch.rest.client.ElasticsearchRestClientOperation","enum":["INDEX_OR_UPDATE","GET_BY_ID","DELETE","CREATE_INDEX","DELETE_INDEX","SEARCH"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation"},"socketTimeout":{"index":5,"kind":"parameter","displayName":"Socket Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"description":"Socket timeout"},"lazyStartProducer":{"index":6,"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."},"enableSniffer":{"index":7,"kind":"parameter","displayName":"Enable Sniffer","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enabling Sniffer"},"restClient":{"index":8,"kind":"parameter","displayName":"Rest Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.elasticsearch.client.RestClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"description":"Rest Client of type org.elasticsearch.client.RestClient. This is only for advanced usage"},"sniffAfterFailureDelay":{"index":9,"kind":"parameter","displayName":"Sniff After Failure Delay","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"description":"Sniffer after failure delay (in millis)"},"snifferInterval":{"index":10,"kind":"parameter","displayName":"Sniffer Interval","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"description":"Sniffer interval (in millis)"},"certificatePath":{"index":11,"kind":"parameter","displayName":"Certificate Path","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Certificate Path"},"password":{"index":12,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Password"},"user":{"index":13,"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Username"}}} +{"component":{"kind":"component","name":"elasticsearch-rest-client","title":"Elasticsearch Low level Rest Client","description":"Perform queries and other operations on Elasticsearch or OpenSearch (uses low-level client).","deprecated":false,"firstVersion":"4.3.0","label":"search","javaType":"org.apache.camel.component.elasticsearch.rest.client.ElasticsearchRestClientComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-elasticsearch-rest-client","version":"4.8.2","scheme":"elasticsearch-rest-client","extendsScheme":"","syntax":"elasticsearch-rest-client:clusterName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"ID":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the object to index or retrieve or delete","constantName":"org.apache.camel.component.elasticsearch.rest.client.ElasticSearchRestClientConstant#ID"},"SEARCH_QUERY":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JSON Query to perform for search","constantName":"org.apache.camel.component.elasticsearch.rest.client.ElasticSearchRestClientConstant#SEARCH_QUERY"},"INDEX_SETTINGS":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Advanced - The JSON Index Settings and/or Mappings Query to perform to create an index","constantName":"org.apache.camel.component.elasticsearch.rest.client.ElasticSearchRestClientConstant#INDEX_SETTINGS"},"INDEX_NAME":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Index name","constantName":"org.apache.camel.component.elasticsearch.rest.client.ElasticSearchRestClientConstant#INDEX_NAME"}},"properties":{"clusterName":{"index":0,"kind":"path","displayName":"Cluster Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cluster Name"},"connectionTimeout":{"index":1,"kind":"parameter","displayName":"Connection Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"description":"Connection timeout"},"hostAddressesList":{"index":2,"kind":"parameter","displayName":"Host Addresses List","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"List of host Addresses, multiple hosts can be separated by comma."},"indexName":{"index":3,"kind":"parameter","displayName":"Index Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Index Name"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.elasticsearch.rest.client.ElasticsearchRestClientOperation","enum":["INDEX_OR_UPDATE","GET_BY_ID","DELETE","CREATE_INDEX","DELETE_INDEX","SEARCH"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation"},"socketTimeout":{"index":5,"kind":"parameter","displayName":"Socket Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"description":"Socket timeout"},"lazyStartProducer":{"index":6,"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."},"enableSniffer":{"index":7,"kind":"parameter","displayName":"Enable Sniffer","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enabling Sniffer"},"restClient":{"index":8,"kind":"parameter","displayName":"Rest Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.elasticsearch.client.RestClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"description":"Rest Client of type org.elasticsearch.client.RestClient. This is only for advanced usage"},"sniffAfterFailureDelay":{"index":9,"kind":"parameter","displayName":"Sniff After Failure Delay","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"description":"Sniffer after failure delay (in millis)"},"snifferInterval":{"index":10,"kind":"parameter","displayName":"Sniffer Interval","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"description":"Sniffer interval (in millis)"},"certificatePath":{"index":11,"kind":"parameter","displayName":"Certificate Path","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Certificate Path"},"password":{"index":12,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Password"},"user":{"index":13,"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Username"}}} , -{"component":{"kind":"component","name":"etcd3","title":"Etcd v3","description":"Get, set, delete or watch keys in etcd key-value store.","deprecated":false,"firstVersion":"3.19.0","label":"clustering,database","javaType":"org.apache.camel.component.etcd3.Etcd3Component","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-etcd3","version":"4.8.1","scheme":"etcd3","extendsScheme":"","syntax":"etcd3:path","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelEtcdAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to perform. Supported values: set get delete","constantName":"org.apache.camel.component.etcd3.Etcd3Constants#ETCD_ACTION"},"CamelEtcdPath":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The target path","constantName":"org.apache.camel.component.etcd3.Etcd3Constants#ETCD_PATH"},"CamelEtcdIsPrefix":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To apply an action on all the key-value pairs whose key that starts with the target path.","constantName":"org.apache.camel.component.etcd3.Etcd3Constants#ETCD_IS_PREFIX"},"CamelEtcdKeyCharset":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The charset to use for the keys.","constantName":"org.apache.camel.component.etcd3.Etcd3Constants#ETCD_KEY_CHARSET"},"CamelEtcdValueCharset":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The charset to use for the values.","constantName":"org.apache.camel.component.etcd3.Etcd3Constants#ETCD_VALUE_CHARSET"}},"properties":{"path":{"index":0,"kind":"path","displayName":"Path","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The path the endpoint refers to"},"endpoints":{"index":1,"kind":"parameter","displayName":"Endpoints","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"http://localhost:2379","configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure etcd server endpoints using the IPNameResolver. Multiple endpoints can be separated by comma."},"keyCharset":{"index":2,"kind":"parameter","displayName":"Key Charset","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"UTF-8","configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the charset to use for the keys."},"namespace":{"index":3,"kind":"parameter","displayName":"Namespace","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the namespace of keys used. / will be treated as no namespace."},"prefix":{"index":4,"kind":"parameter","displayName":"Prefix","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"To apply an action on all the key-value pairs whose key that starts with the target path."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"fromIndex":{"index":8,"kind":"parameter","displayName":"From Index","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"The index to watch from"},"valueCharset":{"index":9,"kind":"parameter","displayName":"Value Charset","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"UTF-8","configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the charset to use for the values."},"lazyStartProducer":{"index":10,"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."},"authHeaders":{"index":11,"kind":"parameter","displayName":"Auth Headers","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"authHeaders.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the headers to be added to auth request headers."},"authority":{"index":12,"kind":"parameter","displayName":"Authority","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the authority used to authenticate connections to servers."},"connectionTimeout":{"index":13,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the connection timeout."},"headers":{"index":14,"kind":"parameter","displayName":"Headers","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"headers.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the headers to be added to http request headers."},"keepAliveTime":{"index":15,"kind":"parameter","displayName":"Keep Alive Time","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30 seconds","configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the interval for gRPC keepalives. The current minimum allowed by gRPC is 10 seconds."},"keepAliveTimeout":{"index":16,"kind":"parameter","displayName":"Keep Alive Timeout","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10 seconds","configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the timeout for gRPC keepalives."},"loadBalancerPolicy":{"index":17,"kind":"parameter","displayName":"Load Balancer Policy","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure etcd load balancer policy."},"maxInboundMessageSize":{"index":18,"kind":"parameter","displayName":"Max Inbound Message Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the maximum message size allowed for a single gRPC frame."},"retryDelay":{"index":19,"kind":"parameter","displayName":"Retry Delay","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the delay between retries in milliseconds."},"retryMaxDelay":{"index":20,"kind":"parameter","displayName":"Retry Max Delay","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":2500,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the max backing off delay between retries in milliseconds."},"retryMaxDuration":{"index":21,"kind":"parameter","displayName":"Retry Max Duration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the retries max duration."},"servicePath":{"index":22,"kind":"parameter","displayName":"Service Path","group":"cloud","label":"cloud","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"/services/","configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"The path to look for service discovery."},"password":{"index":23,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure etcd auth password."},"sslContext":{"index":24,"kind":"parameter","displayName":"Ssl Context","group":"security","label":"advanced,security","required":false,"type":"object","javaType":"io.netty.handler.ssl.SslContext","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure SSL/TLS context to use instead of the system default."},"userName":{"index":25,"kind":"parameter","displayName":"User Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure etcd auth user."}}} +{"component":{"kind":"component","name":"etcd3","title":"Etcd v3","description":"Get, set, delete or watch keys in etcd key-value store.","deprecated":false,"firstVersion":"3.19.0","label":"clustering,database","javaType":"org.apache.camel.component.etcd3.Etcd3Component","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-etcd3","version":"4.8.2","scheme":"etcd3","extendsScheme":"","syntax":"etcd3:path","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelEtcdAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to perform. Supported values: set get delete","constantName":"org.apache.camel.component.etcd3.Etcd3Constants#ETCD_ACTION"},"CamelEtcdPath":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The target path","constantName":"org.apache.camel.component.etcd3.Etcd3Constants#ETCD_PATH"},"CamelEtcdIsPrefix":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To apply an action on all the key-value pairs whose key that starts with the target path.","constantName":"org.apache.camel.component.etcd3.Etcd3Constants#ETCD_IS_PREFIX"},"CamelEtcdKeyCharset":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The charset to use for the keys.","constantName":"org.apache.camel.component.etcd3.Etcd3Constants#ETCD_KEY_CHARSET"},"CamelEtcdValueCharset":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The charset to use for the values.","constantName":"org.apache.camel.component.etcd3.Etcd3Constants#ETCD_VALUE_CHARSET"}},"properties":{"path":{"index":0,"kind":"path","displayName":"Path","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The path the endpoint refers to"},"endpoints":{"index":1,"kind":"parameter","displayName":"Endpoints","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"http://localhost:2379","configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure etcd server endpoints using the IPNameResolver. Multiple endpoints can be separated by comma."},"keyCharset":{"index":2,"kind":"parameter","displayName":"Key Charset","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"UTF-8","configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the charset to use for the keys."},"namespace":{"index":3,"kind":"parameter","displayName":"Namespace","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the namespace of keys used. / will be treated as no namespace."},"prefix":{"index":4,"kind":"parameter","displayName":"Prefix","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"To apply an action on all the key-value pairs whose key that starts with the target path."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"fromIndex":{"index":8,"kind":"parameter","displayName":"From Index","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"The index to watch from"},"valueCharset":{"index":9,"kind":"parameter","displayName":"Value Charset","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"UTF-8","configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the charset to use for the values."},"lazyStartProducer":{"index":10,"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."},"authHeaders":{"index":11,"kind":"parameter","displayName":"Auth Headers","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"authHeaders.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the headers to be added to auth request headers."},"authority":{"index":12,"kind":"parameter","displayName":"Authority","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the authority used to authenticate connections to servers."},"connectionTimeout":{"index":13,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the connection timeout."},"headers":{"index":14,"kind":"parameter","displayName":"Headers","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"headers.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the headers to be added to http request headers."},"keepAliveTime":{"index":15,"kind":"parameter","displayName":"Keep Alive Time","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30 seconds","configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the interval for gRPC keepalives. The current minimum allowed by gRPC is 10 seconds."},"keepAliveTimeout":{"index":16,"kind":"parameter","displayName":"Keep Alive Timeout","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10 seconds","configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the timeout for gRPC keepalives."},"loadBalancerPolicy":{"index":17,"kind":"parameter","displayName":"Load Balancer Policy","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure etcd load balancer policy."},"maxInboundMessageSize":{"index":18,"kind":"parameter","displayName":"Max Inbound Message Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the maximum message size allowed for a single gRPC frame."},"retryDelay":{"index":19,"kind":"parameter","displayName":"Retry Delay","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the delay between retries in milliseconds."},"retryMaxDelay":{"index":20,"kind":"parameter","displayName":"Retry Max Delay","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":2500,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the max backing off delay between retries in milliseconds."},"retryMaxDuration":{"index":21,"kind":"parameter","displayName":"Retry Max Duration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure the retries max duration."},"servicePath":{"index":22,"kind":"parameter","displayName":"Service Path","group":"cloud","label":"cloud","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"/services/","configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"The path to look for service discovery."},"password":{"index":23,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure etcd auth password."},"sslContext":{"index":24,"kind":"parameter","displayName":"Ssl Context","group":"security","label":"advanced,security","required":false,"type":"object","javaType":"io.netty.handler.ssl.SslContext","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure SSL/TLS context to use instead of the system default."},"userName":{"index":25,"kind":"parameter","displayName":"User Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.etcd3.Etcd3Configuration","configurationField":"configuration","description":"Configure etcd auth user."}}} , -{"component":{"kind":"component","name":"exec","title":"Exec","description":"Execute commands on the underlying operating system.","deprecated":false,"firstVersion":"2.3.0","label":"core","javaType":"org.apache.camel.component.exec.ExecComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-exec","version":"4.8.1","scheme":"exec","extendsScheme":"","syntax":"exec:executable","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelExecCommandExecutable":{"index":0,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the system command that will be executed. Overrides executable in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_EXECUTABLE"},"CamelExecCommandArgs":{"index":1,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"java.util.List or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Command-line argument(s) to pass to the executed process. The argument(s) is/are used literally - no quoting is applied. Overrides any existing args in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_ARGS"},"CamelExecCommandOutFile":{"index":2,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of a file, created by the executable, that should be considered as its output. Overrides any existing outFile in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_OUT_FILE"},"CamelExecCommandWorkingDir":{"index":3,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The directory in which the command should be executed. Overrides any existing workingDir in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_WORKING_DIR"},"CamelExecCommandTimeout":{"index":4,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timeout, in milliseconds, after which the executable should be terminated. Overrides any existing timeout in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_TIMEOUT"},"CamelExecExitValues":{"index":5,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The exit values for successful execution of the process. Overrides any existing exitValues in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_EXIT_VALUES"},"CamelExecStderr":{"index":6,"kind":"header","displayName":"","group":"out","label":"out","required":false,"javaType":"java.io.InputStream","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of this header points to the standard error stream (stderr) of the executable. If no stderr is written, the value is null.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_STDERR"},"CamelExecExitValue":{"index":7,"kind":"header","displayName":"","group":"out","label":"out","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of this header is the _exit value_ of the executable. Non-zero exit values typically indicate abnormal termination. Note that the exit value is OS-dependent.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_EXIT_VALUE"},"CamelExecUseStderrOnEmptyStdout":{"index":8,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates that when stdout is empty, this component will populate the Camel Message Body with stderr. This behavior is disabled (false) by default.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_USE_STDERR_ON_EMPTY_STDOUT"},"CamelExecCommandLogLevel":{"index":9,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Logging level to be used for commands during execution. The default value is DEBUG. Possible values are TRACE, DEBUG, INFO, WARN, ERROR or OFF (Values of LoggingLevel enum)","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_LOG_LEVEL"}},"properties":{"executable":{"index":0,"kind":"path","displayName":"Executable","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the executable to be executed. The executable must not be empty or null."},"args":{"index":1,"kind":"parameter","displayName":"Args","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The arguments may be one or many whitespace-separated tokens."},"binding":{"index":2,"kind":"parameter","displayName":"Binding","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.exec.ExecBinding","deprecated":false,"autowired":false,"secret":false,"description":"A reference to a org.apache.commons.exec.ExecBinding in the Registry."},"commandExecutor":{"index":3,"kind":"parameter","displayName":"Command Executor","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.exec.ExecCommandExecutor","deprecated":false,"autowired":false,"secret":false,"description":"A reference to a org.apache.commons.exec.ExecCommandExecutor in the Registry that customizes the command execution. The default command executor utilizes the commons-exec library, which adds a shutdown hook for every executed command."},"commandLogLevel":{"index":4,"kind":"parameter","displayName":"Command Log Level","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Logging level to be used for commands during execution. The default value is DEBUG. Possible values are TRACE, DEBUG, INFO, WARN, ERROR or OFF. (Values of ExecCommandLogLevelType enum)"},"exitValues":{"index":5,"kind":"parameter","displayName":"Exit Values","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The exit values of successful executions. If the process exits with another value, an exception is raised. Comma-separated list of exit values. And empty list (the default) sets no expected exit values and disables the check."},"outFile":{"index":6,"kind":"parameter","displayName":"Out File","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of a file, created by the executable, that should be considered as its output. If no outFile is set, the standard output (stdout) of the executable will be used instead."},"timeout":{"index":7,"kind":"parameter","displayName":"Timeout","group":"producer","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"The timeout, in milliseconds, after which the executable should be terminated. If execution has not completed within the timeout, the component will send a termination request."},"useStderrOnEmptyStdout":{"index":8,"kind":"parameter","displayName":"Use Stderr On Empty Stdout","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"A boolean indicating that when stdout is empty, this component will populate the Camel Message Body with stderr. This behavior is disabled (false) by default."},"workingDir":{"index":9,"kind":"parameter","displayName":"Working Dir","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The directory in which the command should be executed. If null, the working directory of the current process will be used."},"lazyStartProducer":{"index":10,"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."}}} +{"component":{"kind":"component","name":"exec","title":"Exec","description":"Execute commands on the underlying operating system.","deprecated":false,"firstVersion":"2.3.0","label":"core","javaType":"org.apache.camel.component.exec.ExecComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-exec","version":"4.8.2","scheme":"exec","extendsScheme":"","syntax":"exec:executable","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelExecCommandExecutable":{"index":0,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the system command that will be executed. Overrides executable in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_EXECUTABLE"},"CamelExecCommandArgs":{"index":1,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"java.util.List or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Command-line argument(s) to pass to the executed process. The argument(s) is/are used literally - no quoting is applied. Overrides any existing args in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_ARGS"},"CamelExecCommandOutFile":{"index":2,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of a file, created by the executable, that should be considered as its output. Overrides any existing outFile in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_OUT_FILE"},"CamelExecCommandWorkingDir":{"index":3,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The directory in which the command should be executed. Overrides any existing workingDir in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_WORKING_DIR"},"CamelExecCommandTimeout":{"index":4,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timeout, in milliseconds, after which the executable should be terminated. Overrides any existing timeout in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_TIMEOUT"},"CamelExecExitValues":{"index":5,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The exit values for successful execution of the process. Overrides any existing exitValues in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_EXIT_VALUES"},"CamelExecStderr":{"index":6,"kind":"header","displayName":"","group":"out","label":"out","required":false,"javaType":"java.io.InputStream","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of this header points to the standard error stream (stderr) of the executable. If no stderr is written, the value is null.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_STDERR"},"CamelExecExitValue":{"index":7,"kind":"header","displayName":"","group":"out","label":"out","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of this header is the _exit value_ of the executable. Non-zero exit values typically indicate abnormal termination. Note that the exit value is OS-dependent.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_EXIT_VALUE"},"CamelExecUseStderrOnEmptyStdout":{"index":8,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates that when stdout is empty, this component will populate the Camel Message Body with stderr. This behavior is disabled (false) by default.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_USE_STDERR_ON_EMPTY_STDOUT"},"CamelExecCommandLogLevel":{"index":9,"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Logging level to be used for commands during execution. The default value is DEBUG. Possible values are TRACE, DEBUG, INFO, WARN, ERROR or OFF (Values of LoggingLevel enum)","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_LOG_LEVEL"}},"properties":{"executable":{"index":0,"kind":"path","displayName":"Executable","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the executable to be executed. The executable must not be empty or null."},"args":{"index":1,"kind":"parameter","displayName":"Args","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The arguments may be one or many whitespace-separated tokens."},"binding":{"index":2,"kind":"parameter","displayName":"Binding","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.exec.ExecBinding","deprecated":false,"autowired":false,"secret":false,"description":"A reference to a org.apache.commons.exec.ExecBinding in the Registry."},"commandExecutor":{"index":3,"kind":"parameter","displayName":"Command Executor","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.exec.ExecCommandExecutor","deprecated":false,"autowired":false,"secret":false,"description":"A reference to a org.apache.commons.exec.ExecCommandExecutor in the Registry that customizes the command execution. The default command executor utilizes the commons-exec library, which adds a shutdown hook for every executed command."},"commandLogLevel":{"index":4,"kind":"parameter","displayName":"Command Log Level","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Logging level to be used for commands during execution. The default value is DEBUG. Possible values are TRACE, DEBUG, INFO, WARN, ERROR or OFF. (Values of ExecCommandLogLevelType enum)"},"exitValues":{"index":5,"kind":"parameter","displayName":"Exit Values","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The exit values of successful executions. If the process exits with another value, an exception is raised. Comma-separated list of exit values. And empty list (the default) sets no expected exit values and disables the check."},"outFile":{"index":6,"kind":"parameter","displayName":"Out File","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of a file, created by the executable, that should be considered as its output. If no outFile is set, the standard output (stdout) of the executable will be used instead."},"timeout":{"index":7,"kind":"parameter","displayName":"Timeout","group":"producer","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"The timeout, in milliseconds, after which the executable should be terminated. If execution has not completed within the timeout, the component will send a termination request."},"useStderrOnEmptyStdout":{"index":8,"kind":"parameter","displayName":"Use Stderr On Empty Stdout","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"A boolean indicating that when stdout is empty, this component will populate the Camel Message Body with stderr. This behavior is disabled (false) by default."},"workingDir":{"index":9,"kind":"parameter","displayName":"Working Dir","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The directory in which the command should be executed. If null, the working directory of the current process will be used."},"lazyStartProducer":{"index":10,"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."}}} , -{"component":{"kind":"component","name":"fhir","title":"FHIR","description":"Exchange information in the healthcare domain using the FHIR (Fast Healthcare Interoperability Resources) standard.","deprecated":false,"firstVersion":"2.23.0","label":"api","javaType":"org.apache.camel.component.fhir.FhirComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-fhir","version":"4.8.1","scheme":"fhir","extendsScheme":"","syntax":"fhir:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.fhir.internal.FhirApiName","enum":["CAPABILITIES","CREATE","DELETE","HISTORY","LOAD_PAGE","META","OPERATION","PATCH","READ","SEARCH","TRANSACTION","UPDATE","VALIDATE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"encoding":{"index":2,"kind":"parameter","displayName":"Encoding","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["JSON","XML"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Encoding to use for all request"},"fhirVersion":{"index":3,"kind":"parameter","displayName":"Fhir Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["DSTU2","DSTU2_HL7ORG","DSTU2_1","DSTU3","R4","R4B","R5"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"R4","configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"The FHIR Version to use"},"inBody":{"index":4,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"log":{"index":5,"kind":"parameter","displayName":"Log","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Will log every requests and responses"},"prettyPrint":{"index":6,"kind":"parameter","displayName":"Pretty Print","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Pretty print all request"},"serverUrl":{"index":7,"kind":"parameter","displayName":"Server Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"The FHIR server base URL"},"sendEmptyMessageWhenIdle":{"index":8,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":12,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":13,"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."},"client":{"index":14,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"ca.uhn.fhir.rest.client.api.IGenericClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"To use the custom client"},"clientFactory":{"index":15,"kind":"parameter","displayName":"Client Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"ca.uhn.fhir.rest.client.api.IRestfulClientFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"To use the custom client factory"},"compress":{"index":16,"kind":"parameter","displayName":"Compress","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Compresses outgoing (POST/PUT) contents to the GZIP format"},"connectionTimeout":{"index":17,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"How long to try and establish the initial TCP connection (in ms)"},"deferModelScanning":{"index":18,"kind":"parameter","displayName":"Defer Model Scanning","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"When this option is set, model classes will not be scanned for children until the child list for the given type is actually accessed."},"fhirContext":{"index":19,"kind":"parameter","displayName":"Fhir Context","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"ca.uhn.fhir.context.FhirContext","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly."},"forceConformanceCheck":{"index":20,"kind":"parameter","displayName":"Force Conformance Check","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Force conformance check"},"sessionCookie":{"index":21,"kind":"parameter","displayName":"Session Cookie","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"HTTP session cookie to add to every request"},"socketTimeout":{"index":22,"kind":"parameter","displayName":"Socket Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"How long to block for individual read/write operations (in ms)"},"summary":{"index":23,"kind":"parameter","displayName":"Summary","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["COUNT","TEXT","DATA","TRUE","FALSE"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Request that the server modify the response using the _summary param"},"validationMode":{"index":24,"kind":"parameter","displayName":"Validation Mode","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["NEVER","ONCE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ONCE","configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"When should Camel validate the FHIR Server's conformance statement"},"proxyHost":{"index":25,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"The proxy host"},"proxyPassword":{"index":26,"kind":"parameter","displayName":"Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"The proxy password"},"proxyPort":{"index":27,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"The proxy port"},"proxyUser":{"index":28,"kind":"parameter","displayName":"Proxy User","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"The proxy username"},"backoffErrorThreshold":{"index":29,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":30,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":31,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":32,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":33,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":34,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":35,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":36,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":37,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":38,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":39,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":40,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":41,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":42,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":43,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"OAuth access token"},"password":{"index":44,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Password to use for basic authentication"},"username":{"index":45,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Username to use for basic authentication"}},"apis":{"capabilities":{"consumerOnly":false,"producerOnly":false,"description":"API to Fetch the capability statement for the server","methods":{"ofType":{"description":"Retrieve the conformance statement using the given model type","signatures":["org.hl7.fhir.instance.model.api.IBaseConformance ofType(Class type, java.util.Map extraParameters)"]}}},"create":{"consumerOnly":false,"producerOnly":false,"description":"API for the create operation, which creates a new resource instance on the server","methods":{"resource":{"description":"Creates a IBaseResource on the server","signatures":["ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)"]}}},"delete":{"consumerOnly":false,"producerOnly":false,"description":"API for the delete operation, which performs a logical delete on a server resource","methods":{"resource":{"description":"Deletes the given resource","signatures":["ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map extraParameters)"]},"resourceById":{"description":"Deletes the resource by resource type e","signatures":["ca.uhn.fhir.rest.api.MethodOutcome resourceById(String type, String stringId, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome resourceById(org.hl7.fhir.instance.model.api.IIdType id, java.util.Map extraParameters)"]},"resourceConditionalByUrl":{"description":"Specifies deleting should be performed as a conditional delete against a given search URL","signatures":["ca.uhn.fhir.rest.api.MethodOutcome resourceConditionalByUrl(String url, java.util.Map extraParameters)"]}}},"history":{"consumerOnly":false,"producerOnly":false,"description":"API for the history method","methods":{"onInstance":{"description":"Perform the operation across all versions of a specific resource (by ID and type) on the server","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle onInstance(org.hl7.fhir.instance.model.api.IIdType id, Class returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType iCutoff, java.util.Map extraParameters)"]},"onServer":{"description":"Perform the operation across all versions of all resources of all types on the server","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle onServer(Class returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType iCutoff, java.util.Map extraParameters)"]},"onType":{"description":"Perform the operation across all versions of all resources of the given type on the server","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle onType(Class resourceType, Class returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType iCutoff, java.util.Map extraParameters)"]}}},"load-page":{"consumerOnly":false,"producerOnly":false,"description":"API that Loads the previous/next bundle of resources from a paged set, using the link specified in the link type=next tag within the atom bundle","methods":{"byUrl":{"description":"Load a page of results using the given URL and bundle type and return a DSTU1 Atom bundle","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle byUrl(String url, Class returnType, java.util.Map extraParameters)"]},"next":{"description":"Load the next page of results using the link with relation next in the bundle","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle next(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map extraParameters)"]},"previous":{"description":"Load the previous page of results using the link with relation prev in the bundle","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle previous(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map extraParameters)"]}}},"meta":{"consumerOnly":false,"producerOnly":false,"description":"API for the meta operations, which can be used to get, add and remove tags and other Meta elements from a resource or across the server","methods":{"add":{"description":"Add the elements in the given metadata to the already existing set (do not remove any)","signatures":["org.hl7.fhir.instance.model.api.IBaseMetaType add(org.hl7.fhir.instance.model.api.IBaseMetaType meta, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map extraParameters)"]},"delete":{"description":"Delete the elements in the given metadata from the given id","signatures":["org.hl7.fhir.instance.model.api.IBaseMetaType delete(org.hl7.fhir.instance.model.api.IBaseMetaType meta, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map extraParameters)"]},"getFromResource":{"description":"Fetch the current metadata from a specific resource","signatures":["org.hl7.fhir.instance.model.api.IBaseMetaType getFromResource(Class metaType, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map extraParameters)"]},"getFromServer":{"description":"Fetch the current metadata from the whole Server","signatures":["org.hl7.fhir.instance.model.api.IBaseMetaType getFromServer(Class metaType, java.util.Map extraParameters)"]},"getFromType":{"description":"Fetch the current metadata from a specific type","signatures":["org.hl7.fhir.instance.model.api.IBaseMetaType getFromType(Class metaType, String resourceType, java.util.Map extraParameters)"]}}},"operation":{"consumerOnly":false,"producerOnly":false,"description":"API for extended FHIR operations","methods":{"onInstance":{"description":"Perform the operation across all versions of a specific resource (by ID and type) on the server","signatures":["org.hl7.fhir.instance.model.api.IBaseResource onInstance(org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class outputParameterType, boolean useHttpGet, Class returnType, java.util.Map extraParameters)"]},"onInstanceVersion":{"description":"This operation operates on a specific version of a resource","signatures":["org.hl7.fhir.instance.model.api.IBaseResource onInstanceVersion(org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class outputParameterType, boolean useHttpGet, Class returnType, java.util.Map extraParameters)"]},"onServer":{"description":"Perform the operation across all versions of all resources of all types on the server","signatures":["org.hl7.fhir.instance.model.api.IBaseResource onServer(String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class outputParameterType, boolean useHttpGet, Class returnType, java.util.Map extraParameters)"]},"onType":{"description":"Perform the operation across all versions of all resources of the given type on the server","signatures":["org.hl7.fhir.instance.model.api.IBaseResource onType(Class resourceType, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class outputParameterType, boolean useHttpGet, Class returnType, java.util.Map extraParameters)"]},"processMessage":{"description":"This operation is called $process-message as defined by the FHIR specification","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle processMessage(String respondToUri, org.hl7.fhir.instance.model.api.IBaseBundle msgBundle, boolean asynchronous, Class responseClass, java.util.Map extraParameters)"]}}},"patch":{"consumerOnly":false,"producerOnly":false,"description":"API for the patch operation, which performs a logical patch on a server resource","methods":{"patchById":{"description":"Applies the patch to the given resource ID","signatures":["ca.uhn.fhir.rest.api.MethodOutcome patchById(String patchBody, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome patchById(String patchBody, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)"]},"patchByUrl":{"description":"Specifies that the update should be performed as a conditional create against a given search URL","signatures":["ca.uhn.fhir.rest.api.MethodOutcome patchByUrl(String patchBody, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)"]}}},"read":{"consumerOnly":false,"producerOnly":false,"description":"API method for read operations","methods":{"resourceById":{"description":"Reads a IBaseResource on the server by id","signatures":["org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class resource, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class resource, String stringId, String version, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class resource, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, String stringId, String ifVersionMatches, String version, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)"]},"resourceByUrl":{"description":"Reads a IBaseResource on the server by url","signatures":["org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(Class resource, String url, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(Class resource, org.hl7.fhir.instance.model.api.IIdType iUrl, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(String resourceClass, String url, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(String resourceClass, org.hl7.fhir.instance.model.api.IIdType iUrl, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)"]}}},"search":{"consumerOnly":false,"producerOnly":false,"description":"API to search for resources matching a given set of criteria","methods":{"searchByUrl":{"description":"Perform a search directly by URL","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle searchByUrl(String url, java.util.Map extraParameters)"]}}},"transaction":{"consumerOnly":false,"producerOnly":false,"description":"API for sending a transaction (collection of resources) to the server to be executed as a single unit","methods":{"withBundle":{"description":"Use the given raw text (should be a Bundle resource) as the transaction input","signatures":["String withBundle(String stringBundle, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseBundle withBundle(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map extraParameters)"]},"withResources":{"description":"Use a list of resources as the transaction input","signatures":["java.util.List withResources(java.util.List resources, java.util.Map extraParameters)"]}}},"update":{"consumerOnly":false,"producerOnly":false,"description":"API for the update operation, which performs a logical delete on a server resource","methods":{"resource":{"description":"Updates a IBaseResource on the server by id","signatures":["ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)"]},"resourceBySearchUrl":{"description":"Updates a IBaseResource on the server by search url","signatures":["ca.uhn.fhir.rest.api.MethodOutcome resourceBySearchUrl(String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome resourceBySearchUrl(org.hl7.fhir.instance.model.api.IBaseResource resource, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)"]}}},"validate":{"consumerOnly":false,"producerOnly":false,"description":"API for validating resources","methods":{"resource":{"description":"Validates the resource","signatures":["ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map extraParameters)"]}}}},"apiProperties":{"capabilities":{"methods":{"ofType":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"type":{"index":1,"kind":"parameter","displayName":"Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The model type","optional":false}}}}},"create":{"methods":{"resource":{"properties":{"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"preferReturn":{"index":3,"kind":"parameter","displayName":"Prefer Return","group":"common","label":"","required":false,"type":"object","javaType":"ca.uhn.fhir.rest.api.PreferReturnEnum","enum":["REPRESENTATION","MINIMAL","OPERATION_OUTCOME"],"deprecated":false,"autowired":false,"secret":false,"description":"Add a Prefer header to the request, which requests that the server include or suppress the resource body as a part of the result. If a resource is returned by the server it will be parsed an accessible to the client via MethodOutcome#getResource() , may be null","optional":true},"resource":{"index":4,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseResource","deprecated":false,"autowired":false,"secret":false,"description":"The resource to create","optional":false},"resourceAsString":{"index":5,"kind":"parameter","displayName":"Resource As String","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource to create","optional":false},"url":{"index":7,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&identifier=13.2.4.11.4%7C847366, may be null","optional":true}}}}},"delete":{"methods":{"resource":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"resource":{"index":1,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseResource","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseResource to delete","optional":false}}},"resourceById":{"properties":{"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":2,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The IIdType referencing the resource","optional":false},"stringId":{"index":3,"kind":"parameter","displayName":"String Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"It's id","optional":false},"type":{"index":4,"kind":"parameter","displayName":"Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource type e.g Patient","optional":false}}},"resourceConditionalByUrl":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"url":{"index":1,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&identifier=13.2.4.11.4%7C847366","optional":false}}}}},"history":{"methods":{"onInstance":{"properties":{"count":{"index":0,"kind":"parameter","displayName":"Count","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only up to theCount number of resources, may be NULL","optional":true},"cutoff":{"index":1,"kind":"parameter","displayName":"Cutoff","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL","optional":true},"extraParameters":{"index":2,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"iCutoff":{"index":3,"kind":"parameter","displayName":"ICutoff","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IPrimitiveType","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL","optional":true},"id":{"index":4,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The IIdType which must be populated with both a resource type and a resource ID at","optional":false},"returnType":{"index":5,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"Request that the method return a Bundle resource (such as ca.uhn.fhir.model.dstu2.resource.Bundle). Use this method if you are accessing a DSTU2 server.","optional":false}}},"onServer":{"properties":{"count":{"index":0,"kind":"parameter","displayName":"Count","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only up to theCount number of resources, may be NULL","optional":true},"cutoff":{"index":1,"kind":"parameter","displayName":"Cutoff","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL","optional":true},"extraParameters":{"index":2,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"iCutoff":{"index":3,"kind":"parameter","displayName":"ICutoff","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IPrimitiveType","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL","optional":true},"returnType":{"index":4,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"Request that the method return a Bundle resource (such as ca.uhn.fhir.model.dstu2.resource.Bundle). Use this method if you are accessing a DSTU2 server.","optional":false}}},"onType":{"properties":{"count":{"index":0,"kind":"parameter","displayName":"Count","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only up to theCount number of resources, may be NULL","optional":true},"cutoff":{"index":1,"kind":"parameter","displayName":"Cutoff","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL","optional":true},"extraParameters":{"index":2,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"iCutoff":{"index":3,"kind":"parameter","displayName":"ICutoff","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IPrimitiveType","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL","optional":true},"resourceType":{"index":4,"kind":"parameter","displayName":"Resource Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The resource type to search for","optional":false},"returnType":{"index":5,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"Request that the method return a Bundle resource (such as ca.uhn.fhir.model.dstu2.resource.Bundle). Use this method if you are accessing a DSTU2 server.","optional":false}}}}},"load-page":{"methods":{"byUrl":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"returnType":{"index":1,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The return type","optional":false},"url":{"index":2,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The search url","optional":false}}},"next":{"properties":{"bundle":{"index":0,"kind":"parameter","displayName":"Bundle","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseBundle","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseBundle","optional":false},"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true}}},"previous":{"properties":{"bundle":{"index":0,"kind":"parameter","displayName":"Bundle","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseBundle","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseBundle","optional":false},"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true}}}}},"meta":{"methods":{"add":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The id","optional":false},"meta":{"index":2,"kind":"parameter","displayName":"Meta","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseMetaType","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseMetaType class","optional":false}}},"delete":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The id","optional":false},"meta":{"index":2,"kind":"parameter","displayName":"Meta","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseMetaType","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseMetaType class","optional":false}}},"getFromResource":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The id","optional":false},"metaType":{"index":2,"kind":"parameter","displayName":"Meta Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseMetaType class","optional":false}}},"getFromServer":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"metaType":{"index":1,"kind":"parameter","displayName":"Meta Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The type of the meta datatype for the given FHIR model version (should be MetaDt.class or MetaType.class)","optional":false}}},"getFromType":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"metaType":{"index":1,"kind":"parameter","displayName":"Meta Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseMetaType class","optional":false},"resourceType":{"index":2,"kind":"parameter","displayName":"Resource Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource type e.g Patient","optional":false}}}}},"operation":{"methods":{"onInstance":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"Resource (version will be stripped)","optional":false},"name":{"index":2,"kind":"parameter","displayName":"Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Operation name","optional":false},"outputParameterType":{"index":3,"kind":"parameter","displayName":"Output Parameter Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using), may be NULL","optional":true},"parameters":{"index":4,"kind":"parameter","displayName":"Parameters","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseParameters","deprecated":false,"autowired":false,"secret":false,"description":"The parameters to use as input. May also be null if the operation does not require any input parameters.","optional":true},"returnType":{"index":5,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"If this operation returns a single resource body as its return type instead of a Parameters resource, use this method to specify that resource type. This is useful for certain operations (e.g. Patient/NNN/$everything) which return a bundle instead of a Parameters resource, may be NULL","optional":true},"useHttpGet":{"index":6,"kind":"parameter","displayName":"Use Http Get","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Use HTTP GET verb","optional":false}}},"onInstanceVersion":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"Resource version","optional":false},"name":{"index":2,"kind":"parameter","displayName":"Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Operation name","optional":false},"outputParameterType":{"index":3,"kind":"parameter","displayName":"Output Parameter Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using), may be NULL","optional":true},"parameters":{"index":4,"kind":"parameter","displayName":"Parameters","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseParameters","deprecated":false,"autowired":false,"secret":false,"description":"The parameters to use as input. May also be null if the operation does not require any input parameters.","optional":true},"returnType":{"index":5,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"If this operation returns a single resource body as its return type instead of a Parameters resource, use this method to specify that resource type. This is useful for certain operations (e.g. Patient/NNN/$everything) which return a bundle instead of a Parameters resource, may be NULL","optional":true},"useHttpGet":{"index":6,"kind":"parameter","displayName":"Use Http Get","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Use HTTP GET verb","optional":false}}},"onServer":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"name":{"index":1,"kind":"parameter","displayName":"Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Operation name","optional":false},"outputParameterType":{"index":2,"kind":"parameter","displayName":"Output Parameter Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using), may be NULL","optional":true},"parameters":{"index":3,"kind":"parameter","displayName":"Parameters","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseParameters","deprecated":false,"autowired":false,"secret":false,"description":"The parameters to use as input. May also be null if the operation does not require any input parameters.","optional":true},"returnType":{"index":4,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"If this operation returns a single resource body as its return type instead of a Parameters resource, use this method to specify that resource type. This is useful for certain operations (e.g. Patient/NNN/$everything) which return a bundle instead of a Parameters resource, may be NULL","optional":true},"useHttpGet":{"index":5,"kind":"parameter","displayName":"Use Http Get","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Use HTTP GET verb","optional":false}}},"onType":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"name":{"index":1,"kind":"parameter","displayName":"Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Operation name","optional":false},"outputParameterType":{"index":2,"kind":"parameter","displayName":"Output Parameter Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using), may be NULL","optional":true},"parameters":{"index":3,"kind":"parameter","displayName":"Parameters","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseParameters","deprecated":false,"autowired":false,"secret":false,"description":"The parameters to use as input. May also be null if the operation does not require any input parameters.","optional":true},"resourceType":{"index":4,"kind":"parameter","displayName":"Resource Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The resource type to operate on","optional":false},"returnType":{"index":5,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"If this operation returns a single resource body as its return type instead of a Parameters resource, use this method to specify that resource type. This is useful for certain operations (e.g. Patient/NNN/$everything) which return a bundle instead of a Parameters resource, may be NULL","optional":true},"useHttpGet":{"index":6,"kind":"parameter","displayName":"Use Http Get","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Use HTTP GET verb","optional":false}}},"processMessage":{"properties":{"asynchronous":{"index":0,"kind":"parameter","displayName":"Asynchronous","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Whether to process the message asynchronously or synchronously, defaults to synchronous.","optional":false},"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"msgBundle":{"index":2,"kind":"parameter","displayName":"Msg Bundle","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseBundle","deprecated":false,"autowired":false,"secret":false,"description":"Set the Message Bundle to POST to the messaging server","optional":false},"respondToUri":{"index":3,"kind":"parameter","displayName":"Respond To Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An optional query parameter indicating that responses from the receiving server should be sent to this URI, may be NULL","optional":true},"responseClass":{"index":4,"kind":"parameter","displayName":"Response Class","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The response class","optional":false}}}}},"patch":{"methods":{"patchById":{"properties":{"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":2,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The resource ID to patch","optional":false},"patchBody":{"index":4,"kind":"parameter","displayName":"Patch Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The body of the patch document serialized in either XML or JSON which conforms to http://jsonpatch.com/ or http://tools.ietf.org/html/rfc5261","optional":false},"preferReturn":{"index":6,"kind":"parameter","displayName":"Prefer Return","group":"common","label":"","required":false,"type":"object","javaType":"ca.uhn.fhir.rest.api.PreferReturnEnum","enum":["REPRESENTATION","MINIMAL","OPERATION_OUTCOME"],"deprecated":false,"autowired":false,"secret":false,"description":"Add a Prefer header to the request, which requests that the server include or suppress the resource body as a part of the result. If a resource is returned by the server it will be parsed an accessible to the client via MethodOutcome#getResource()","optional":true},"stringId":{"index":7,"kind":"parameter","displayName":"String Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource ID to patch","optional":false}}},"patchByUrl":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"patchBody":{"index":1,"kind":"parameter","displayName":"Patch Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The body of the patch document serialized in either XML or JSON which conforms to http://jsonpatch.com/ or http://tools.ietf.org/html/rfc5261","optional":false},"preferReturn":{"index":2,"kind":"parameter","displayName":"Prefer Return","group":"common","label":"","required":false,"type":"object","javaType":"ca.uhn.fhir.rest.api.PreferReturnEnum","enum":["REPRESENTATION","MINIMAL","OPERATION_OUTCOME"],"deprecated":false,"autowired":false,"secret":false,"description":"Add a Prefer header to the request, which requests that the server include or suppress the resource body as a part of the result. If a resource is returned by the server it will be parsed an accessible to the client via MethodOutcome#getResource()","optional":true},"url":{"index":3,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&identifier=13.2.4.11.4%7C847366","optional":false}}}}},"read":{"methods":{"resourceById":{"properties":{"extraParameters":{"index":5,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":6,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The IIdType referencing the resource","optional":false},"ifVersionMatches":{"index":12,"kind":"parameter","displayName":"If Version Matches","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"A version to match against the newest version on the server","optional":true},"longId":{"index":13,"kind":"parameter","displayName":"Long Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The resource ID","optional":false},"resource":{"index":14,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The resource to read (e.g. Patient)","optional":false},"resourceClass":{"index":15,"kind":"parameter","displayName":"Resource Class","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource to read (e.g. Patient)","optional":false},"returnNull":{"index":21,"kind":"parameter","displayName":"Return Null","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Return null if version matches","optional":true},"returnResource":{"index":27,"kind":"parameter","displayName":"Return Resource","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseResource","deprecated":false,"autowired":false,"secret":false,"description":"Return the resource if version matches","optional":true},"stringId":{"index":28,"kind":"parameter","displayName":"String Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource ID","optional":false},"throwError":{"index":34,"kind":"parameter","displayName":"Throw Error","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Throw error if the version matches","optional":true},"version":{"index":35,"kind":"parameter","displayName":"Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource version","optional":true}}},"resourceByUrl":{"properties":{"extraParameters":{"index":3,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"iUrl":{"index":4,"kind":"parameter","displayName":"IUrl","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The IIdType referencing the resource by absolute url","optional":false},"ifVersionMatches":{"index":8,"kind":"parameter","displayName":"If Version Matches","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"A version to match against the newest version on the server","optional":true},"resource":{"index":9,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The resource to read (e.g. Patient)","optional":false},"resourceClass":{"index":10,"kind":"parameter","displayName":"Resource Class","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource to read (e.g. Patient.class)","optional":false},"returnNull":{"index":14,"kind":"parameter","displayName":"Return Null","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Return null if version matches","optional":true},"returnResource":{"index":18,"kind":"parameter","displayName":"Return Resource","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseResource","deprecated":false,"autowired":false,"secret":false,"description":"Return the resource if version matches","optional":true},"throwError":{"index":22,"kind":"parameter","displayName":"Throw Error","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Throw error if the version matches","optional":true},"url":{"index":23,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Referencing the resource by absolute url","optional":false}}}}},"search":{"methods":{"searchByUrl":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"url":{"index":1,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The URL to search for. Note that this URL may be complete (e.g. http://example.com/base/Patientname=foo) in which case the client's base URL will be ignored. Or it can be relative (e.g. Patientname=foo) in which case the client's base URL will be used.","optional":false}}}}},"transaction":{"methods":{"withBundle":{"properties":{"bundle":{"index":0,"kind":"parameter","displayName":"Bundle","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseBundle","deprecated":false,"autowired":false,"secret":false,"description":"Bundle to use in the transaction","optional":false},"extraParameters":{"index":2,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"stringBundle":{"index":3,"kind":"parameter","displayName":"String Bundle","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Bundle to use in the transaction","optional":false}}},"withResources":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"resources":{"index":1,"kind":"parameter","displayName":"Resources","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"Resources to use in the transaction","optional":false}}}}},"update":{"methods":{"resource":{"properties":{"extraParameters":{"index":3,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":4,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The IIdType referencing the resource","optional":true},"preferReturn":{"index":8,"kind":"parameter","displayName":"Prefer Return","group":"common","label":"","required":false,"type":"object","javaType":"ca.uhn.fhir.rest.api.PreferReturnEnum","enum":["REPRESENTATION","MINIMAL","OPERATION_OUTCOME"],"deprecated":false,"autowired":false,"secret":false,"description":"Whether the server include or suppress the resource body as a part of the result","optional":true},"resource":{"index":9,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseResource","deprecated":false,"autowired":false,"secret":false,"description":"The resource to update (e.g. Patient)","optional":false},"resourceAsString":{"index":10,"kind":"parameter","displayName":"Resource As String","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource body to update","optional":false},"stringId":{"index":11,"kind":"parameter","displayName":"String Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID referencing the resource","optional":true}}},"resourceBySearchUrl":{"properties":{"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"preferReturn":{"index":3,"kind":"parameter","displayName":"Prefer Return","group":"common","label":"","required":false,"type":"object","javaType":"ca.uhn.fhir.rest.api.PreferReturnEnum","enum":["REPRESENTATION","MINIMAL","OPERATION_OUTCOME"],"deprecated":false,"autowired":false,"secret":false,"description":"Whether the server include or suppress the resource body as a part of the result","optional":true},"resource":{"index":4,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseResource","deprecated":false,"autowired":false,"secret":false,"description":"The resource to update (e.g. Patient)","optional":false},"resourceAsString":{"index":5,"kind":"parameter","displayName":"Resource As String","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource body to update","optional":false},"url":{"index":6,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies that the update should be performed as a conditional create against a given search URL","optional":false}}}}},"validate":{"methods":{"resource":{"properties":{"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"resource":{"index":2,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseResource","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseResource to validate","optional":false},"resourceAsString":{"index":3,"kind":"parameter","displayName":"Resource As String","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Raw resource to validate","optional":false}}}}}}} +{"component":{"kind":"component","name":"fhir","title":"FHIR","description":"Exchange information in the healthcare domain using the FHIR (Fast Healthcare Interoperability Resources) standard.","deprecated":false,"firstVersion":"2.23.0","label":"api","javaType":"org.apache.camel.component.fhir.FhirComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-fhir","version":"4.8.2","scheme":"fhir","extendsScheme":"","syntax":"fhir:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.fhir.internal.FhirApiName","enum":["CAPABILITIES","CREATE","DELETE","HISTORY","LOAD_PAGE","META","OPERATION","PATCH","READ","SEARCH","TRANSACTION","UPDATE","VALIDATE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"encoding":{"index":2,"kind":"parameter","displayName":"Encoding","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["JSON","XML"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Encoding to use for all request"},"fhirVersion":{"index":3,"kind":"parameter","displayName":"Fhir Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["DSTU2","DSTU2_HL7ORG","DSTU2_1","DSTU3","R4","R4B","R5"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"R4","configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"The FHIR Version to use"},"inBody":{"index":4,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"log":{"index":5,"kind":"parameter","displayName":"Log","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Will log every requests and responses"},"prettyPrint":{"index":6,"kind":"parameter","displayName":"Pretty Print","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Pretty print all request"},"serverUrl":{"index":7,"kind":"parameter","displayName":"Server Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"The FHIR server base URL"},"sendEmptyMessageWhenIdle":{"index":8,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":12,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":13,"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."},"client":{"index":14,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"ca.uhn.fhir.rest.client.api.IGenericClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"To use the custom client"},"clientFactory":{"index":15,"kind":"parameter","displayName":"Client Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"ca.uhn.fhir.rest.client.api.IRestfulClientFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"To use the custom client factory"},"compress":{"index":16,"kind":"parameter","displayName":"Compress","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Compresses outgoing (POST/PUT) contents to the GZIP format"},"connectionTimeout":{"index":17,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"How long to try and establish the initial TCP connection (in ms)"},"deferModelScanning":{"index":18,"kind":"parameter","displayName":"Defer Model Scanning","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"When this option is set, model classes will not be scanned for children until the child list for the given type is actually accessed."},"fhirContext":{"index":19,"kind":"parameter","displayName":"Fhir Context","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"ca.uhn.fhir.context.FhirContext","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly."},"forceConformanceCheck":{"index":20,"kind":"parameter","displayName":"Force Conformance Check","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Force conformance check"},"sessionCookie":{"index":21,"kind":"parameter","displayName":"Session Cookie","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"HTTP session cookie to add to every request"},"socketTimeout":{"index":22,"kind":"parameter","displayName":"Socket Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"How long to block for individual read/write operations (in ms)"},"summary":{"index":23,"kind":"parameter","displayName":"Summary","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["COUNT","TEXT","DATA","TRUE","FALSE"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Request that the server modify the response using the _summary param"},"validationMode":{"index":24,"kind":"parameter","displayName":"Validation Mode","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["NEVER","ONCE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ONCE","configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"When should Camel validate the FHIR Server's conformance statement"},"proxyHost":{"index":25,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"The proxy host"},"proxyPassword":{"index":26,"kind":"parameter","displayName":"Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"The proxy password"},"proxyPort":{"index":27,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"The proxy port"},"proxyUser":{"index":28,"kind":"parameter","displayName":"Proxy User","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"The proxy username"},"backoffErrorThreshold":{"index":29,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":30,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":31,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":32,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":33,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":34,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":35,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":36,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":37,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":38,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":39,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":40,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":41,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":42,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":43,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"OAuth access token"},"password":{"index":44,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Password to use for basic authentication"},"username":{"index":45,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.fhir.FhirConfiguration","configurationField":"configuration","description":"Username to use for basic authentication"}},"apis":{"capabilities":{"consumerOnly":false,"producerOnly":false,"description":"API to Fetch the capability statement for the server","methods":{"ofType":{"description":"Retrieve the conformance statement using the given model type","signatures":["org.hl7.fhir.instance.model.api.IBaseConformance ofType(Class type, java.util.Map extraParameters)"]}}},"create":{"consumerOnly":false,"producerOnly":false,"description":"API for the create operation, which creates a new resource instance on the server","methods":{"resource":{"description":"Creates a IBaseResource on the server","signatures":["ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)"]}}},"delete":{"consumerOnly":false,"producerOnly":false,"description":"API for the delete operation, which performs a logical delete on a server resource","methods":{"resource":{"description":"Deletes the given resource","signatures":["ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map extraParameters)"]},"resourceById":{"description":"Deletes the resource by resource type e","signatures":["ca.uhn.fhir.rest.api.MethodOutcome resourceById(String type, String stringId, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome resourceById(org.hl7.fhir.instance.model.api.IIdType id, java.util.Map extraParameters)"]},"resourceConditionalByUrl":{"description":"Specifies deleting should be performed as a conditional delete against a given search URL","signatures":["ca.uhn.fhir.rest.api.MethodOutcome resourceConditionalByUrl(String url, java.util.Map extraParameters)"]}}},"history":{"consumerOnly":false,"producerOnly":false,"description":"API for the history method","methods":{"onInstance":{"description":"Perform the operation across all versions of a specific resource (by ID and type) on the server","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle onInstance(org.hl7.fhir.instance.model.api.IIdType id, Class returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType iCutoff, java.util.Map extraParameters)"]},"onServer":{"description":"Perform the operation across all versions of all resources of all types on the server","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle onServer(Class returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType iCutoff, java.util.Map extraParameters)"]},"onType":{"description":"Perform the operation across all versions of all resources of the given type on the server","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle onType(Class resourceType, Class returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType iCutoff, java.util.Map extraParameters)"]}}},"load-page":{"consumerOnly":false,"producerOnly":false,"description":"API that Loads the previous/next bundle of resources from a paged set, using the link specified in the link type=next tag within the atom bundle","methods":{"byUrl":{"description":"Load a page of results using the given URL and bundle type and return a DSTU1 Atom bundle","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle byUrl(String url, Class returnType, java.util.Map extraParameters)"]},"next":{"description":"Load the next page of results using the link with relation next in the bundle","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle next(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map extraParameters)"]},"previous":{"description":"Load the previous page of results using the link with relation prev in the bundle","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle previous(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map extraParameters)"]}}},"meta":{"consumerOnly":false,"producerOnly":false,"description":"API for the meta operations, which can be used to get, add and remove tags and other Meta elements from a resource or across the server","methods":{"add":{"description":"Add the elements in the given metadata to the already existing set (do not remove any)","signatures":["org.hl7.fhir.instance.model.api.IBaseMetaType add(org.hl7.fhir.instance.model.api.IBaseMetaType meta, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map extraParameters)"]},"delete":{"description":"Delete the elements in the given metadata from the given id","signatures":["org.hl7.fhir.instance.model.api.IBaseMetaType delete(org.hl7.fhir.instance.model.api.IBaseMetaType meta, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map extraParameters)"]},"getFromResource":{"description":"Fetch the current metadata from a specific resource","signatures":["org.hl7.fhir.instance.model.api.IBaseMetaType getFromResource(Class metaType, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map extraParameters)"]},"getFromServer":{"description":"Fetch the current metadata from the whole Server","signatures":["org.hl7.fhir.instance.model.api.IBaseMetaType getFromServer(Class metaType, java.util.Map extraParameters)"]},"getFromType":{"description":"Fetch the current metadata from a specific type","signatures":["org.hl7.fhir.instance.model.api.IBaseMetaType getFromType(Class metaType, String resourceType, java.util.Map extraParameters)"]}}},"operation":{"consumerOnly":false,"producerOnly":false,"description":"API for extended FHIR operations","methods":{"onInstance":{"description":"Perform the operation across all versions of a specific resource (by ID and type) on the server","signatures":["org.hl7.fhir.instance.model.api.IBaseResource onInstance(org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class outputParameterType, boolean useHttpGet, Class returnType, java.util.Map extraParameters)"]},"onInstanceVersion":{"description":"This operation operates on a specific version of a resource","signatures":["org.hl7.fhir.instance.model.api.IBaseResource onInstanceVersion(org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class outputParameterType, boolean useHttpGet, Class returnType, java.util.Map extraParameters)"]},"onServer":{"description":"Perform the operation across all versions of all resources of all types on the server","signatures":["org.hl7.fhir.instance.model.api.IBaseResource onServer(String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class outputParameterType, boolean useHttpGet, Class returnType, java.util.Map extraParameters)"]},"onType":{"description":"Perform the operation across all versions of all resources of the given type on the server","signatures":["org.hl7.fhir.instance.model.api.IBaseResource onType(Class resourceType, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class outputParameterType, boolean useHttpGet, Class returnType, java.util.Map extraParameters)"]},"processMessage":{"description":"This operation is called $process-message as defined by the FHIR specification","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle processMessage(String respondToUri, org.hl7.fhir.instance.model.api.IBaseBundle msgBundle, boolean asynchronous, Class responseClass, java.util.Map extraParameters)"]}}},"patch":{"consumerOnly":false,"producerOnly":false,"description":"API for the patch operation, which performs a logical patch on a server resource","methods":{"patchById":{"description":"Applies the patch to the given resource ID","signatures":["ca.uhn.fhir.rest.api.MethodOutcome patchById(String patchBody, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome patchById(String patchBody, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)"]},"patchByUrl":{"description":"Specifies that the update should be performed as a conditional create against a given search URL","signatures":["ca.uhn.fhir.rest.api.MethodOutcome patchByUrl(String patchBody, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)"]}}},"read":{"consumerOnly":false,"producerOnly":false,"description":"API method for read operations","methods":{"resourceById":{"description":"Reads a IBaseResource on the server by id","signatures":["org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class resource, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class resource, String stringId, String version, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class resource, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, String stringId, String ifVersionMatches, String version, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)"]},"resourceByUrl":{"description":"Reads a IBaseResource on the server by url","signatures":["org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(Class resource, String url, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(Class resource, org.hl7.fhir.instance.model.api.IIdType iUrl, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(String resourceClass, String url, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(String resourceClass, org.hl7.fhir.instance.model.api.IIdType iUrl, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map extraParameters)"]}}},"search":{"consumerOnly":false,"producerOnly":false,"description":"API to search for resources matching a given set of criteria","methods":{"searchByUrl":{"description":"Perform a search directly by URL","signatures":["org.hl7.fhir.instance.model.api.IBaseBundle searchByUrl(String url, java.util.Map extraParameters)"]}}},"transaction":{"consumerOnly":false,"producerOnly":false,"description":"API for sending a transaction (collection of resources) to the server to be executed as a single unit","methods":{"withBundle":{"description":"Use the given raw text (should be a Bundle resource) as the transaction input","signatures":["String withBundle(String stringBundle, java.util.Map extraParameters)","org.hl7.fhir.instance.model.api.IBaseBundle withBundle(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map extraParameters)"]},"withResources":{"description":"Use a list of resources as the transaction input","signatures":["java.util.List withResources(java.util.List resources, java.util.Map extraParameters)"]}}},"update":{"consumerOnly":false,"producerOnly":false,"description":"API for the update operation, which performs a logical delete on a server resource","methods":{"resource":{"description":"Updates a IBaseResource on the server by id","signatures":["ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)"]},"resourceBySearchUrl":{"description":"Updates a IBaseResource on the server by search url","signatures":["ca.uhn.fhir.rest.api.MethodOutcome resourceBySearchUrl(String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome resourceBySearchUrl(org.hl7.fhir.instance.model.api.IBaseResource resource, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map extraParameters)"]}}},"validate":{"consumerOnly":false,"producerOnly":false,"description":"API for validating resources","methods":{"resource":{"description":"Validates the resource","signatures":["ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, java.util.Map extraParameters)","ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map extraParameters)"]}}}},"apiProperties":{"capabilities":{"methods":{"ofType":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"type":{"index":1,"kind":"parameter","displayName":"Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The model type","optional":false}}}}},"create":{"methods":{"resource":{"properties":{"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"preferReturn":{"index":3,"kind":"parameter","displayName":"Prefer Return","group":"common","label":"","required":false,"type":"object","javaType":"ca.uhn.fhir.rest.api.PreferReturnEnum","enum":["REPRESENTATION","MINIMAL","OPERATION_OUTCOME"],"deprecated":false,"autowired":false,"secret":false,"description":"Add a Prefer header to the request, which requests that the server include or suppress the resource body as a part of the result. If a resource is returned by the server it will be parsed an accessible to the client via MethodOutcome#getResource() , may be null","optional":true},"resource":{"index":4,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseResource","deprecated":false,"autowired":false,"secret":false,"description":"The resource to create","optional":false},"resourceAsString":{"index":5,"kind":"parameter","displayName":"Resource As String","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource to create","optional":false},"url":{"index":7,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&identifier=13.2.4.11.4%7C847366, may be null","optional":true}}}}},"delete":{"methods":{"resource":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"resource":{"index":1,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseResource","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseResource to delete","optional":false}}},"resourceById":{"properties":{"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":2,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The IIdType referencing the resource","optional":false},"stringId":{"index":3,"kind":"parameter","displayName":"String Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"It's id","optional":false},"type":{"index":4,"kind":"parameter","displayName":"Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource type e.g Patient","optional":false}}},"resourceConditionalByUrl":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"url":{"index":1,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&identifier=13.2.4.11.4%7C847366","optional":false}}}}},"history":{"methods":{"onInstance":{"properties":{"count":{"index":0,"kind":"parameter","displayName":"Count","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only up to theCount number of resources, may be NULL","optional":true},"cutoff":{"index":1,"kind":"parameter","displayName":"Cutoff","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL","optional":true},"extraParameters":{"index":2,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"iCutoff":{"index":3,"kind":"parameter","displayName":"ICutoff","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IPrimitiveType","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL","optional":true},"id":{"index":4,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The IIdType which must be populated with both a resource type and a resource ID at","optional":false},"returnType":{"index":5,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"Request that the method return a Bundle resource (such as ca.uhn.fhir.model.dstu2.resource.Bundle). Use this method if you are accessing a DSTU2 server.","optional":false}}},"onServer":{"properties":{"count":{"index":0,"kind":"parameter","displayName":"Count","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only up to theCount number of resources, may be NULL","optional":true},"cutoff":{"index":1,"kind":"parameter","displayName":"Cutoff","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL","optional":true},"extraParameters":{"index":2,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"iCutoff":{"index":3,"kind":"parameter","displayName":"ICutoff","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IPrimitiveType","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL","optional":true},"returnType":{"index":4,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"Request that the method return a Bundle resource (such as ca.uhn.fhir.model.dstu2.resource.Bundle). Use this method if you are accessing a DSTU2 server.","optional":false}}},"onType":{"properties":{"count":{"index":0,"kind":"parameter","displayName":"Count","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only up to theCount number of resources, may be NULL","optional":true},"cutoff":{"index":1,"kind":"parameter","displayName":"Cutoff","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL","optional":true},"extraParameters":{"index":2,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"iCutoff":{"index":3,"kind":"parameter","displayName":"ICutoff","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IPrimitiveType","deprecated":false,"autowired":false,"secret":false,"description":"Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL","optional":true},"resourceType":{"index":4,"kind":"parameter","displayName":"Resource Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The resource type to search for","optional":false},"returnType":{"index":5,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"Request that the method return a Bundle resource (such as ca.uhn.fhir.model.dstu2.resource.Bundle). Use this method if you are accessing a DSTU2 server.","optional":false}}}}},"load-page":{"methods":{"byUrl":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"returnType":{"index":1,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The return type","optional":false},"url":{"index":2,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The search url","optional":false}}},"next":{"properties":{"bundle":{"index":0,"kind":"parameter","displayName":"Bundle","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseBundle","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseBundle","optional":false},"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true}}},"previous":{"properties":{"bundle":{"index":0,"kind":"parameter","displayName":"Bundle","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseBundle","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseBundle","optional":false},"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true}}}}},"meta":{"methods":{"add":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The id","optional":false},"meta":{"index":2,"kind":"parameter","displayName":"Meta","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseMetaType","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseMetaType class","optional":false}}},"delete":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The id","optional":false},"meta":{"index":2,"kind":"parameter","displayName":"Meta","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseMetaType","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseMetaType class","optional":false}}},"getFromResource":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The id","optional":false},"metaType":{"index":2,"kind":"parameter","displayName":"Meta Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseMetaType class","optional":false}}},"getFromServer":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"metaType":{"index":1,"kind":"parameter","displayName":"Meta Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The type of the meta datatype for the given FHIR model version (should be MetaDt.class or MetaType.class)","optional":false}}},"getFromType":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"metaType":{"index":1,"kind":"parameter","displayName":"Meta Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseMetaType class","optional":false},"resourceType":{"index":2,"kind":"parameter","displayName":"Resource Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource type e.g Patient","optional":false}}}}},"operation":{"methods":{"onInstance":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"Resource (version will be stripped)","optional":false},"name":{"index":2,"kind":"parameter","displayName":"Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Operation name","optional":false},"outputParameterType":{"index":3,"kind":"parameter","displayName":"Output Parameter Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using), may be NULL","optional":true},"parameters":{"index":4,"kind":"parameter","displayName":"Parameters","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseParameters","deprecated":false,"autowired":false,"secret":false,"description":"The parameters to use as input. May also be null if the operation does not require any input parameters.","optional":true},"returnType":{"index":5,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"If this operation returns a single resource body as its return type instead of a Parameters resource, use this method to specify that resource type. This is useful for certain operations (e.g. Patient/NNN/$everything) which return a bundle instead of a Parameters resource, may be NULL","optional":true},"useHttpGet":{"index":6,"kind":"parameter","displayName":"Use Http Get","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Use HTTP GET verb","optional":false}}},"onInstanceVersion":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"Resource version","optional":false},"name":{"index":2,"kind":"parameter","displayName":"Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Operation name","optional":false},"outputParameterType":{"index":3,"kind":"parameter","displayName":"Output Parameter Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using), may be NULL","optional":true},"parameters":{"index":4,"kind":"parameter","displayName":"Parameters","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseParameters","deprecated":false,"autowired":false,"secret":false,"description":"The parameters to use as input. May also be null if the operation does not require any input parameters.","optional":true},"returnType":{"index":5,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"If this operation returns a single resource body as its return type instead of a Parameters resource, use this method to specify that resource type. This is useful for certain operations (e.g. Patient/NNN/$everything) which return a bundle instead of a Parameters resource, may be NULL","optional":true},"useHttpGet":{"index":6,"kind":"parameter","displayName":"Use Http Get","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Use HTTP GET verb","optional":false}}},"onServer":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"name":{"index":1,"kind":"parameter","displayName":"Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Operation name","optional":false},"outputParameterType":{"index":2,"kind":"parameter","displayName":"Output Parameter Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using), may be NULL","optional":true},"parameters":{"index":3,"kind":"parameter","displayName":"Parameters","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseParameters","deprecated":false,"autowired":false,"secret":false,"description":"The parameters to use as input. May also be null if the operation does not require any input parameters.","optional":true},"returnType":{"index":4,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"If this operation returns a single resource body as its return type instead of a Parameters resource, use this method to specify that resource type. This is useful for certain operations (e.g. Patient/NNN/$everything) which return a bundle instead of a Parameters resource, may be NULL","optional":true},"useHttpGet":{"index":5,"kind":"parameter","displayName":"Use Http Get","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Use HTTP GET verb","optional":false}}},"onType":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"name":{"index":1,"kind":"parameter","displayName":"Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Operation name","optional":false},"outputParameterType":{"index":2,"kind":"parameter","displayName":"Output Parameter Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using), may be NULL","optional":true},"parameters":{"index":3,"kind":"parameter","displayName":"Parameters","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseParameters","deprecated":false,"autowired":false,"secret":false,"description":"The parameters to use as input. May also be null if the operation does not require any input parameters.","optional":true},"resourceType":{"index":4,"kind":"parameter","displayName":"Resource Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The resource type to operate on","optional":false},"returnType":{"index":5,"kind":"parameter","displayName":"Return Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"If this operation returns a single resource body as its return type instead of a Parameters resource, use this method to specify that resource type. This is useful for certain operations (e.g. Patient/NNN/$everything) which return a bundle instead of a Parameters resource, may be NULL","optional":true},"useHttpGet":{"index":6,"kind":"parameter","displayName":"Use Http Get","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Use HTTP GET verb","optional":false}}},"processMessage":{"properties":{"asynchronous":{"index":0,"kind":"parameter","displayName":"Asynchronous","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Whether to process the message asynchronously or synchronously, defaults to synchronous.","optional":false},"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"msgBundle":{"index":2,"kind":"parameter","displayName":"Msg Bundle","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseBundle","deprecated":false,"autowired":false,"secret":false,"description":"Set the Message Bundle to POST to the messaging server","optional":false},"respondToUri":{"index":3,"kind":"parameter","displayName":"Respond To Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An optional query parameter indicating that responses from the receiving server should be sent to this URI, may be NULL","optional":true},"responseClass":{"index":4,"kind":"parameter","displayName":"Response Class","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The response class","optional":false}}}}},"patch":{"methods":{"patchById":{"properties":{"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":2,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The resource ID to patch","optional":false},"patchBody":{"index":4,"kind":"parameter","displayName":"Patch Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The body of the patch document serialized in either XML or JSON which conforms to http://jsonpatch.com/ or http://tools.ietf.org/html/rfc5261","optional":false},"preferReturn":{"index":6,"kind":"parameter","displayName":"Prefer Return","group":"common","label":"","required":false,"type":"object","javaType":"ca.uhn.fhir.rest.api.PreferReturnEnum","enum":["REPRESENTATION","MINIMAL","OPERATION_OUTCOME"],"deprecated":false,"autowired":false,"secret":false,"description":"Add a Prefer header to the request, which requests that the server include or suppress the resource body as a part of the result. If a resource is returned by the server it will be parsed an accessible to the client via MethodOutcome#getResource()","optional":true},"stringId":{"index":7,"kind":"parameter","displayName":"String Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource ID to patch","optional":false}}},"patchByUrl":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"patchBody":{"index":1,"kind":"parameter","displayName":"Patch Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The body of the patch document serialized in either XML or JSON which conforms to http://jsonpatch.com/ or http://tools.ietf.org/html/rfc5261","optional":false},"preferReturn":{"index":2,"kind":"parameter","displayName":"Prefer Return","group":"common","label":"","required":false,"type":"object","javaType":"ca.uhn.fhir.rest.api.PreferReturnEnum","enum":["REPRESENTATION","MINIMAL","OPERATION_OUTCOME"],"deprecated":false,"autowired":false,"secret":false,"description":"Add a Prefer header to the request, which requests that the server include or suppress the resource body as a part of the result. If a resource is returned by the server it will be parsed an accessible to the client via MethodOutcome#getResource()","optional":true},"url":{"index":3,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&identifier=13.2.4.11.4%7C847366","optional":false}}}}},"read":{"methods":{"resourceById":{"properties":{"extraParameters":{"index":5,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":6,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The IIdType referencing the resource","optional":false},"ifVersionMatches":{"index":12,"kind":"parameter","displayName":"If Version Matches","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"A version to match against the newest version on the server","optional":true},"longId":{"index":13,"kind":"parameter","displayName":"Long Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The resource ID","optional":false},"resource":{"index":14,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The resource to read (e.g. Patient)","optional":false},"resourceClass":{"index":15,"kind":"parameter","displayName":"Resource Class","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource to read (e.g. Patient)","optional":false},"returnNull":{"index":21,"kind":"parameter","displayName":"Return Null","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Return null if version matches","optional":true},"returnResource":{"index":27,"kind":"parameter","displayName":"Return Resource","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseResource","deprecated":false,"autowired":false,"secret":false,"description":"Return the resource if version matches","optional":true},"stringId":{"index":28,"kind":"parameter","displayName":"String Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource ID","optional":false},"throwError":{"index":34,"kind":"parameter","displayName":"Throw Error","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Throw error if the version matches","optional":true},"version":{"index":35,"kind":"parameter","displayName":"Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource version","optional":true}}},"resourceByUrl":{"properties":{"extraParameters":{"index":3,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"iUrl":{"index":4,"kind":"parameter","displayName":"IUrl","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The IIdType referencing the resource by absolute url","optional":false},"ifVersionMatches":{"index":8,"kind":"parameter","displayName":"If Version Matches","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"A version to match against the newest version on the server","optional":true},"resource":{"index":9,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"The resource to read (e.g. Patient)","optional":false},"resourceClass":{"index":10,"kind":"parameter","displayName":"Resource Class","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource to read (e.g. Patient.class)","optional":false},"returnNull":{"index":14,"kind":"parameter","displayName":"Return Null","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Return null if version matches","optional":true},"returnResource":{"index":18,"kind":"parameter","displayName":"Return Resource","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseResource","deprecated":false,"autowired":false,"secret":false,"description":"Return the resource if version matches","optional":true},"throwError":{"index":22,"kind":"parameter","displayName":"Throw Error","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Throw error if the version matches","optional":true},"url":{"index":23,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Referencing the resource by absolute url","optional":false}}}}},"search":{"methods":{"searchByUrl":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"url":{"index":1,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The URL to search for. Note that this URL may be complete (e.g. http://example.com/base/Patientname=foo) in which case the client's base URL will be ignored. Or it can be relative (e.g. Patientname=foo) in which case the client's base URL will be used.","optional":false}}}}},"transaction":{"methods":{"withBundle":{"properties":{"bundle":{"index":0,"kind":"parameter","displayName":"Bundle","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseBundle","deprecated":false,"autowired":false,"secret":false,"description":"Bundle to use in the transaction","optional":false},"extraParameters":{"index":2,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"stringBundle":{"index":3,"kind":"parameter","displayName":"String Bundle","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Bundle to use in the transaction","optional":false}}},"withResources":{"properties":{"extraParameters":{"index":0,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"resources":{"index":1,"kind":"parameter","displayName":"Resources","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"Resources to use in the transaction","optional":false}}}}},"update":{"methods":{"resource":{"properties":{"extraParameters":{"index":3,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"id":{"index":4,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IIdType","deprecated":false,"autowired":false,"secret":false,"description":"The IIdType referencing the resource","optional":true},"preferReturn":{"index":8,"kind":"parameter","displayName":"Prefer Return","group":"common","label":"","required":false,"type":"object","javaType":"ca.uhn.fhir.rest.api.PreferReturnEnum","enum":["REPRESENTATION","MINIMAL","OPERATION_OUTCOME"],"deprecated":false,"autowired":false,"secret":false,"description":"Whether the server include or suppress the resource body as a part of the result","optional":true},"resource":{"index":9,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseResource","deprecated":false,"autowired":false,"secret":false,"description":"The resource to update (e.g. Patient)","optional":false},"resourceAsString":{"index":10,"kind":"parameter","displayName":"Resource As String","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource body to update","optional":false},"stringId":{"index":11,"kind":"parameter","displayName":"String Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID referencing the resource","optional":true}}},"resourceBySearchUrl":{"properties":{"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"preferReturn":{"index":3,"kind":"parameter","displayName":"Prefer Return","group":"common","label":"","required":false,"type":"object","javaType":"ca.uhn.fhir.rest.api.PreferReturnEnum","enum":["REPRESENTATION","MINIMAL","OPERATION_OUTCOME"],"deprecated":false,"autowired":false,"secret":false,"description":"Whether the server include or suppress the resource body as a part of the result","optional":true},"resource":{"index":4,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseResource","deprecated":false,"autowired":false,"secret":false,"description":"The resource to update (e.g. Patient)","optional":false},"resourceAsString":{"index":5,"kind":"parameter","displayName":"Resource As String","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The resource body to update","optional":false},"url":{"index":6,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies that the update should be performed as a conditional create against a given search URL","optional":false}}}}},"validate":{"methods":{"resource":{"properties":{"extraParameters":{"index":1,"kind":"parameter","displayName":"Extra Parameters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"See ExtraParameters for a full list of parameters that can be passed, may be NULL","optional":true},"resource":{"index":2,"kind":"parameter","displayName":"Resource","group":"common","label":"","required":false,"type":"object","javaType":"org.hl7.fhir.instance.model.api.IBaseResource","deprecated":false,"autowired":false,"secret":false,"description":"The IBaseResource to validate","optional":false},"resourceAsString":{"index":3,"kind":"parameter","displayName":"Resource As String","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Raw resource to validate","optional":false}}}}}}} , -{"component":{"kind":"component","name":"file","title":"File","description":"Read and write files.","deprecated":false,"firstVersion":"1.0.0","label":"file,core","javaType":"org.apache.camel.component.file.FileComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-file","version":"4.8.1","scheme":"file","extendsScheme":"","syntax":"file:directoryName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelFileLength":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A long value containing the file size.","constantName":"org.apache.camel.component.file.FileConstants#FILE_LENGTH"},"CamelFileLastModified":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Long value containing the last modified timestamp of the file.","constantName":"org.apache.camel.component.file.FileConstants#FILE_LAST_MODIFIED"},"CamelFileLocalWorkPath":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"File","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local work path","constantName":"org.apache.camel.component.file.FileConstants#FILE_LOCAL_WORK_PATH"},"CamelFileNameOnly":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only the file name (the name with no leading paths).","constantName":"org.apache.camel.component.file.FileConstants#FILE_NAME_ONLY"},"CamelFileName":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) Specifies the name of the file to write (relative to the endpoint directory). This name can be a String; a String with a xref:languages:file-language.adocFile Language or xref:languages:simple-language.adocSimple expression; or an Expression object. If it's null then Camel will auto-generate a filename based on the message unique ID. (consumer) Name of the consumed file as a relative file path with offset from the starting directory configured on the endpoint.","constantName":"org.apache.camel.component.file.FileConstants#FILE_NAME"},"CamelFileNameConsumed":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the file that has been consumed","constantName":"org.apache.camel.component.file.FileConstants#FILE_NAME_CONSUMED"},"CamelFileAbsolute":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A boolean option specifying whether the consumed file denotes an absolute path or not. Should normally be false for relative paths. Absolute paths should normally not be used but we added to the move option to allow moving files to absolute paths. But can be used elsewhere as well.","constantName":"org.apache.camel.component.file.FileConstants#FILE_ABSOLUTE"},"CamelFileAbsolutePath":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The absolute path to the file. For relative files this path holds the relative path instead.","constantName":"org.apache.camel.component.file.FileConstants#FILE_ABSOLUTE_PATH"},"CamelFileExtendedAttributes":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The extended attributes of the file","constantName":"org.apache.camel.component.file.FileConstants#FILE_EXTENDED_ATTRIBUTES"},"CamelFileContentType":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type of the file","constantName":"org.apache.camel.component.file.FileConstants#FILE_CONTENT_TYPE"},"CamelFilePath":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The file path. For relative files this is the starting directory the relative filename. For absolute files this is the absolute path.","constantName":"org.apache.camel.component.file.FileConstants#FILE_PATH"},"CamelFileRelativePath":{"index":11,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The relative path.","constantName":"org.apache.camel.component.file.FileConstants#FILE_RELATIVE_PATH"},"CamelFileParent":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent path.","constantName":"org.apache.camel.component.file.FileConstants#FILE_PARENT"},"CamelFileNameProduced":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The actual absolute filepath (path name) for the output file that was written. This header is set by Camel and its purpose is providing end-users with the name of the file that was written.","constantName":"org.apache.camel.component.file.FileConstants#FILE_NAME_PRODUCED"},"CamelOverruleFileName":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is used for overruling CamelFileName header and use the value instead (but only once, as the producer will remove this header after writing the file). The value can be only be a String. Notice that if the option fileName has been configured, then this is still being evaluated.","constantName":"org.apache.camel.component.file.FileConstants#OVERRULE_FILE_NAME"},"CamelFileInitialOffset":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A long value containing the initial offset.","constantName":"org.apache.camel.component.file.FileConstants#INITIAL_OFFSET"}},"properties":{"directoryName":{"index":0,"kind":"path","displayName":"Directory Name","group":"common","label":"","required":true,"type":"string","javaType":"java.io.File","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The starting directory"},"charset":{"index":1,"kind":"parameter","displayName":"Charset","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages."},"doneFileName":{"index":2,"kind":"parameter","displayName":"Done File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders."},"fileName":{"index":3,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."},"delete":{"index":4,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file will be deleted after it is processed successfully."},"moveFailed":{"index":5,"kind":"parameter","displayName":"Move Failed","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again."},"noop":{"index":6,"kind":"parameter","displayName":"Noop","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again."},"preMove":{"index":7,"kind":"parameter","displayName":"Pre Move","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order."},"preSort":{"index":8,"kind":"parameter","displayName":"Pre Sort","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled."},"recursive":{"index":9,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If a directory, will look for files in all the sub-directories as well."},"sendEmptyMessageWhenIdle":{"index":10,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":11,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"directoryMustExist":{"index":12,"kind":"parameter","displayName":"Directory Must Exist","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Similar to the startingDirectoryMustExist option, but this applies during polling (after starting the consumer)."},"exceptionHandler":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"extendedAttributes":{"index":15,"kind":"parameter","displayName":"Extended Attributes","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To define which file attributes of interest. Like posix:permissions,posix:owner,basic:lastAccessTime, it supports basic wildcard like posix:, basic:lastAccessTime"},"includeHiddenDirs":{"index":16,"kind":"parameter","displayName":"Include Hidden Dirs","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to accept hidden directories. Directories which names starts with dot are regarded as a hidden directory, and by default are not included. Set this option to true to include hidden directories in the file consumer."},"includeHiddenFiles":{"index":17,"kind":"parameter","displayName":"Include Hidden Files","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to accept hidden files. Files which names starts with dot is regarded as a hidden file, and by default not included. Set this option to true to include hidden files in the file consumer."},"inProgressRepository":{"index":18,"kind":"parameter","displayName":"In Progress Repository","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."},"localWorkDirectory":{"index":19,"kind":"parameter","displayName":"Local Work Directory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory."},"onCompletionExceptionHandler":{"index":20,"kind":"parameter","displayName":"On Completion Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore."},"pollStrategy":{"index":21,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"probeContentType":{"index":22,"kind":"parameter","displayName":"Probe Content Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to enable probing of the content type. If enable then the consumer uses Files#probeContentType(java.nio.file.Path) to determine the content-type of the file, and store that as a header with key Exchange#FILE_CONTENT_TYPE on the Message."},"processStrategy":{"index":23,"kind":"parameter","displayName":"Process Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileProcessStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply."},"startingDirectoryMustExist":{"index":24,"kind":"parameter","displayName":"Starting Directory Must Exist","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the starting directory must exist. Mind that the autoCreate option is default enabled, which means the starting directory is normally auto created if it doesn't exist. You can disable autoCreate and enable this to ensure the starting directory must exist. Will throw an exception if the directory doesn't exist."},"startingDirectoryMustHaveAccess":{"index":25,"kind":"parameter","displayName":"Starting Directory Must Have Access","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the starting directory has access permissions. Mind that the startingDirectoryMustExist parameter must be set to true to verify that the directory exists. Will throw an exception if the directory doesn't have read and write permissions."},"appendChars":{"index":26,"kind":"parameter","displayName":"Append Chars","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Used to append characters (text) after writing files. This can for example be used to add new lines or other separators when writing and appending new files or existing files. To specify new-line (slash-n or slash-r) or tab (slash-t) characters then escape with an extra slash, eg slash-slash-n."},"checksumFileAlgorithm":{"index":27,"kind":"parameter","displayName":"Checksum File Algorithm","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["MD2","MD5","SHA_1","SHA_224","SHA_256","SHA_384","SHA_512","SHA_512_224","SHA_512_256","SHA3_224","SHA3_256","SHA3_384","SHA3_512"],"deprecated":false,"autowired":false,"secret":false,"description":"If provided, then Camel will write a checksum file when the original file has been written. The checksum file will contain the checksum created with the provided algorithm for the original file. The checksum file will always be written in the same folder as the original file."},"fileExist":{"index":28,"kind":"parameter","displayName":"File Exist","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExist","enum":["Override","Append","Fail","Ignore","Move","TryRename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Override","description":"What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers."},"flatten":{"index":29,"kind":"parameter","displayName":"Flatten","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."},"jailStartingDirectory":{"index":30,"kind":"parameter","displayName":"Jail Starting Directory","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."},"moveExisting":{"index":31,"kind":"parameter","displayName":"Move Existing","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base."},"tempFileName":{"index":32,"kind":"parameter","displayName":"Temp File Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir."},"tempPrefix":{"index":33,"kind":"parameter","displayName":"Temp Prefix","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files."},"allowNullBody":{"index":34,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."},"chmod":{"index":35,"kind":"parameter","displayName":"Chmod","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specify the file permissions that are sent by the producer, the chmod value must be between 000 and 777; If there is a leading digit like in 0755, we will ignore it."},"chmodDirectory":{"index":36,"kind":"parameter","displayName":"Chmod Directory","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specify the directory permissions used when the producer creates missing directories, the chmod value must be between 000 and 777; If there is a leading digit like in 0755, we will ignore it."},"eagerDeleteTargetFile":{"index":37,"kind":"parameter","displayName":"Eager Delete Target File","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation."},"forceWrites":{"index":38,"kind":"parameter","displayName":"Force Writes","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to force syncing, writes to the file system. You can turn this off if you do not want this level of guarantee, for example, if writing to logs / audit logs etc.; this would yield better performance."},"keepLastModified":{"index":39,"kind":"parameter","displayName":"Keep Last Modified","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers."},"lazyStartProducer":{"index":40,"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."},"moveExistingFileStrategy":{"index":41,"kind":"parameter","displayName":"Move Existing File Strategy","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.strategy.FileMoveExistingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"},"autoCreate":{"index":42,"kind":"parameter","displayName":"Auto Create","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to."},"autoCreateStepwise":{"index":43,"kind":"parameter","displayName":"Auto Create Stepwise","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When auto-creating directories should each subdirectory be created one at a time. This may be needed due to security issues on some file-shares."},"bufferSize":{"index":44,"kind":"parameter","displayName":"Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":131072,"description":"Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files)."},"copyAndDeleteOnRenameFail":{"index":45,"kind":"parameter","displayName":"Copy And Delete On Rename Fail","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to fall back and do a copy and delete file, in case the file could not be renamed directly. This option is not available for the FTP component."},"renameUsingCopy":{"index":46,"kind":"parameter","displayName":"Rename Using Copy","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Perform rename operations using a copy and delete strategy. This is primarily used in environments where the regular rename operation is unreliable (e.g., across different file systems or networks). This option takes precedence over the copyAndDeleteOnRenameFail parameter that will automatically fall back to the copy and delete strategy, but only after additional delays."},"synchronous":{"index":47,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"antExclude":{"index":48,"kind":"parameter","displayName":"Ant Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format."},"antFilterCaseSensitive":{"index":49,"kind":"parameter","displayName":"Ant Filter Case Sensitive","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets case sensitive flag on ant filter."},"antInclude":{"index":50,"kind":"parameter","displayName":"Ant Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format."},"eagerMaxMessagesPerPoll":{"index":51,"kind":"parameter","displayName":"Eager Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting."},"exclude":{"index":52,"kind":"parameter","displayName":"Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"excludeExt":{"index":53,"kind":"parameter","displayName":"Exclude Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat files, use excludeExt=bak,dat. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"filter":{"index":54,"kind":"parameter","displayName":"Filter","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileFilter","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method."},"filterDirectory":{"index":55,"kind":"parameter","displayName":"Filter Directory","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}"},"filterFile":{"index":56,"kind":"parameter","displayName":"Filter File","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000"},"idempotent":{"index":57,"kind":"parameter","displayName":"Idempotent","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentEager":{"index":58,"kind":"parameter","displayName":"Idempotent Eager","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentKey":{"index":59,"kind":"parameter","displayName":"Idempotent Key","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}"},"idempotentRepository":{"index":60,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true."},"include":{"index":61,"kind":"parameter","displayName":"Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"includeExt":{"index":62,"kind":"parameter","displayName":"Include Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml files, use includeExt=txt,xml. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"maxDepth":{"index":63,"kind":"parameter","displayName":"Max Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"description":"The maximum depth to traverse when recursively processing a directory."},"maxMessagesPerPoll":{"index":64,"kind":"parameter","displayName":"Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards."},"minDepth":{"index":65,"kind":"parameter","displayName":"Min Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory."},"move":{"index":66,"kind":"parameter","displayName":"Move","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done."},"exclusiveReadLockStrategy":{"index":67,"kind":"parameter","displayName":"Exclusive Read Lock Strategy","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation."},"readLock":{"index":68,"kind":"parameter","displayName":"Read Lock","group":"lock","label":"consumer,lock","required":false,"type":"string","javaType":"java.lang.String","enum":["none","markerFile","fileLock","rename","changed","idempotent","idempotent-changed","idempotent-rename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: - none - No read lock is in use - markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component - changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. - fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. - rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. - idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that.Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan."},"readLockCheckInterval":{"index":69,"kind":"parameter","displayName":"Read Lock Check Interval","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"readLockDeleteOrphanLockFiles":{"index":70,"kind":"parameter","displayName":"Read Lock Delete Orphan Lock Files","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory."},"readLockIdempotentReleaseAsync":{"index":71,"kind":"parameter","displayName":"Read Lock Idempotent Release Async","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the delayed release task should be synchronous or asynchronous. See more details at the readLockIdempotentReleaseDelay option."},"readLockIdempotentReleaseAsyncPoolSize":{"index":72,"kind":"parameter","displayName":"Read Lock Idempotent Release Async Pool Size","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of threads in the scheduled thread pool when using asynchronous release tasks. Using a default of 1 core threads should be sufficient in almost all use-cases, only set this to a higher value if either updating the idempotent repository is slow, or there are a lot of files to process. This option is not in-use if you use a shared thread pool by configuring the readLockIdempotentReleaseExecutorService option. See more details at the readLockIdempotentReleaseDelay option."},"readLockIdempotentReleaseDelay":{"index":73,"kind":"parameter","displayName":"Read Lock Idempotent Release Delay","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Whether to delay the release task for a period of millis. This can be used to delay the release tasks to expand the window when a file is regarded as read-locked, in an active/active cluster scenario with a shared idempotent repository, to ensure other nodes cannot potentially scan and acquire the same file, due to race-conditions. By expanding the time-window of the release tasks helps prevents these situations. Note delaying is only needed if you have configured readLockRemoveOnCommit to true."},"readLockIdempotentReleaseExecutorService":{"index":74,"kind":"parameter","displayName":"Read Lock Idempotent Release Executor Service","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom and shared thread pool for asynchronous release tasks. See more details at the readLockIdempotentReleaseDelay option."},"readLockLoggingLevel":{"index":75,"kind":"parameter","displayName":"Read Lock Logging Level","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename."},"readLockMarkerFile":{"index":76,"kind":"parameter","displayName":"Read Lock Marker File","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application."},"readLockMinAge":{"index":77,"kind":"parameter","displayName":"Read Lock Min Age","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age."},"readLockMinLength":{"index":78,"kind":"parameter","displayName":"Read Lock Min Length","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files."},"readLockRemoveOnCommit":{"index":79,"kind":"parameter","displayName":"Read Lock Remove On Commit","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option."},"readLockRemoveOnRollback":{"index":80,"kind":"parameter","displayName":"Read Lock Remove On Rollback","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit)."},"readLockTimeout":{"index":81,"kind":"parameter","displayName":"Read Lock Timeout","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"description":"Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"backoffErrorThreshold":{"index":82,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":83,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":84,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":85,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":86,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":87,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":88,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":89,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":90,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":91,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":92,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":93,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":94,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":95,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"shuffle":{"index":96,"kind":"parameter","displayName":"Shuffle","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To shuffle the list of files (sort in random order)"},"sortBy":{"index":97,"kind":"parameter","displayName":"Sort By","group":"sort","label":"consumer,sort","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date."},"sorter":{"index":98,"kind":"parameter","displayName":"Sorter","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"java.util.Comparator>","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable sorter as a java.util.Comparator class."}}} +{"component":{"kind":"component","name":"file","title":"File","description":"Read and write files.","deprecated":false,"firstVersion":"1.0.0","label":"file,core","javaType":"org.apache.camel.component.file.FileComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-file","version":"4.8.2","scheme":"file","extendsScheme":"","syntax":"file:directoryName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelFileLength":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A long value containing the file size.","constantName":"org.apache.camel.component.file.FileConstants#FILE_LENGTH"},"CamelFileLastModified":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Long value containing the last modified timestamp of the file.","constantName":"org.apache.camel.component.file.FileConstants#FILE_LAST_MODIFIED"},"CamelFileLocalWorkPath":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"File","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local work path","constantName":"org.apache.camel.component.file.FileConstants#FILE_LOCAL_WORK_PATH"},"CamelFileNameOnly":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only the file name (the name with no leading paths).","constantName":"org.apache.camel.component.file.FileConstants#FILE_NAME_ONLY"},"CamelFileName":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) Specifies the name of the file to write (relative to the endpoint directory). This name can be a String; a String with a xref:languages:file-language.adocFile Language or xref:languages:simple-language.adocSimple expression; or an Expression object. If it's null then Camel will auto-generate a filename based on the message unique ID. (consumer) Name of the consumed file as a relative file path with offset from the starting directory configured on the endpoint.","constantName":"org.apache.camel.component.file.FileConstants#FILE_NAME"},"CamelFileNameConsumed":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the file that has been consumed","constantName":"org.apache.camel.component.file.FileConstants#FILE_NAME_CONSUMED"},"CamelFileAbsolute":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A boolean option specifying whether the consumed file denotes an absolute path or not. Should normally be false for relative paths. Absolute paths should normally not be used but we added to the move option to allow moving files to absolute paths. But can be used elsewhere as well.","constantName":"org.apache.camel.component.file.FileConstants#FILE_ABSOLUTE"},"CamelFileAbsolutePath":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The absolute path to the file. For relative files this path holds the relative path instead.","constantName":"org.apache.camel.component.file.FileConstants#FILE_ABSOLUTE_PATH"},"CamelFileExtendedAttributes":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The extended attributes of the file","constantName":"org.apache.camel.component.file.FileConstants#FILE_EXTENDED_ATTRIBUTES"},"CamelFileContentType":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type of the file","constantName":"org.apache.camel.component.file.FileConstants#FILE_CONTENT_TYPE"},"CamelFilePath":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The file path. For relative files this is the starting directory the relative filename. For absolute files this is the absolute path.","constantName":"org.apache.camel.component.file.FileConstants#FILE_PATH"},"CamelFileRelativePath":{"index":11,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The relative path.","constantName":"org.apache.camel.component.file.FileConstants#FILE_RELATIVE_PATH"},"CamelFileParent":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent path.","constantName":"org.apache.camel.component.file.FileConstants#FILE_PARENT"},"CamelFileNameProduced":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The actual absolute filepath (path name) for the output file that was written. This header is set by Camel and its purpose is providing end-users with the name of the file that was written.","constantName":"org.apache.camel.component.file.FileConstants#FILE_NAME_PRODUCED"},"CamelOverruleFileName":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is used for overruling CamelFileName header and use the value instead (but only once, as the producer will remove this header after writing the file). The value can be only be a String. Notice that if the option fileName has been configured, then this is still being evaluated.","constantName":"org.apache.camel.component.file.FileConstants#OVERRULE_FILE_NAME"},"CamelFileInitialOffset":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A long value containing the initial offset.","constantName":"org.apache.camel.component.file.FileConstants#INITIAL_OFFSET"}},"properties":{"directoryName":{"index":0,"kind":"path","displayName":"Directory Name","group":"common","label":"","required":true,"type":"string","javaType":"java.io.File","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The starting directory"},"charset":{"index":1,"kind":"parameter","displayName":"Charset","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages."},"doneFileName":{"index":2,"kind":"parameter","displayName":"Done File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders."},"fileName":{"index":3,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."},"delete":{"index":4,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file will be deleted after it is processed successfully."},"moveFailed":{"index":5,"kind":"parameter","displayName":"Move Failed","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again."},"noop":{"index":6,"kind":"parameter","displayName":"Noop","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again."},"preMove":{"index":7,"kind":"parameter","displayName":"Pre Move","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order."},"preSort":{"index":8,"kind":"parameter","displayName":"Pre Sort","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled."},"recursive":{"index":9,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If a directory, will look for files in all the sub-directories as well."},"sendEmptyMessageWhenIdle":{"index":10,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":11,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"directoryMustExist":{"index":12,"kind":"parameter","displayName":"Directory Must Exist","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Similar to the startingDirectoryMustExist option, but this applies during polling (after starting the consumer)."},"exceptionHandler":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"extendedAttributes":{"index":15,"kind":"parameter","displayName":"Extended Attributes","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To define which file attributes of interest. Like posix:permissions,posix:owner,basic:lastAccessTime, it supports basic wildcard like posix:, basic:lastAccessTime"},"includeHiddenDirs":{"index":16,"kind":"parameter","displayName":"Include Hidden Dirs","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to accept hidden directories. Directories which names starts with dot are regarded as a hidden directory, and by default are not included. Set this option to true to include hidden directories in the file consumer."},"includeHiddenFiles":{"index":17,"kind":"parameter","displayName":"Include Hidden Files","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to accept hidden files. Files which names starts with dot is regarded as a hidden file, and by default not included. Set this option to true to include hidden files in the file consumer."},"inProgressRepository":{"index":18,"kind":"parameter","displayName":"In Progress Repository","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."},"localWorkDirectory":{"index":19,"kind":"parameter","displayName":"Local Work Directory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory."},"onCompletionExceptionHandler":{"index":20,"kind":"parameter","displayName":"On Completion Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore."},"pollStrategy":{"index":21,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"probeContentType":{"index":22,"kind":"parameter","displayName":"Probe Content Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to enable probing of the content type. If enable then the consumer uses Files#probeContentType(java.nio.file.Path) to determine the content-type of the file, and store that as a header with key Exchange#FILE_CONTENT_TYPE on the Message."},"processStrategy":{"index":23,"kind":"parameter","displayName":"Process Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileProcessStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply."},"startingDirectoryMustExist":{"index":24,"kind":"parameter","displayName":"Starting Directory Must Exist","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the starting directory must exist. Mind that the autoCreate option is default enabled, which means the starting directory is normally auto created if it doesn't exist. You can disable autoCreate and enable this to ensure the starting directory must exist. Will throw an exception if the directory doesn't exist."},"startingDirectoryMustHaveAccess":{"index":25,"kind":"parameter","displayName":"Starting Directory Must Have Access","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the starting directory has access permissions. Mind that the startingDirectoryMustExist parameter must be set to true to verify that the directory exists. Will throw an exception if the directory doesn't have read and write permissions."},"appendChars":{"index":26,"kind":"parameter","displayName":"Append Chars","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Used to append characters (text) after writing files. This can for example be used to add new lines or other separators when writing and appending new files or existing files. To specify new-line (slash-n or slash-r) or tab (slash-t) characters then escape with an extra slash, eg slash-slash-n."},"checksumFileAlgorithm":{"index":27,"kind":"parameter","displayName":"Checksum File Algorithm","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["MD2","MD5","SHA_1","SHA_224","SHA_256","SHA_384","SHA_512","SHA_512_224","SHA_512_256","SHA3_224","SHA3_256","SHA3_384","SHA3_512"],"deprecated":false,"autowired":false,"secret":false,"description":"If provided, then Camel will write a checksum file when the original file has been written. The checksum file will contain the checksum created with the provided algorithm for the original file. The checksum file will always be written in the same folder as the original file."},"fileExist":{"index":28,"kind":"parameter","displayName":"File Exist","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExist","enum":["Override","Append","Fail","Ignore","Move","TryRename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Override","description":"What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers."},"flatten":{"index":29,"kind":"parameter","displayName":"Flatten","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."},"jailStartingDirectory":{"index":30,"kind":"parameter","displayName":"Jail Starting Directory","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."},"moveExisting":{"index":31,"kind":"parameter","displayName":"Move Existing","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base."},"tempFileName":{"index":32,"kind":"parameter","displayName":"Temp File Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir."},"tempPrefix":{"index":33,"kind":"parameter","displayName":"Temp Prefix","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files."},"allowNullBody":{"index":34,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."},"chmod":{"index":35,"kind":"parameter","displayName":"Chmod","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specify the file permissions that are sent by the producer, the chmod value must be between 000 and 777; If there is a leading digit like in 0755, we will ignore it."},"chmodDirectory":{"index":36,"kind":"parameter","displayName":"Chmod Directory","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specify the directory permissions used when the producer creates missing directories, the chmod value must be between 000 and 777; If there is a leading digit like in 0755, we will ignore it."},"eagerDeleteTargetFile":{"index":37,"kind":"parameter","displayName":"Eager Delete Target File","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation."},"forceWrites":{"index":38,"kind":"parameter","displayName":"Force Writes","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to force syncing, writes to the file system. You can turn this off if you do not want this level of guarantee, for example, if writing to logs / audit logs etc.; this would yield better performance."},"keepLastModified":{"index":39,"kind":"parameter","displayName":"Keep Last Modified","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers."},"lazyStartProducer":{"index":40,"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."},"moveExistingFileStrategy":{"index":41,"kind":"parameter","displayName":"Move Existing File Strategy","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.strategy.FileMoveExistingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"},"autoCreate":{"index":42,"kind":"parameter","displayName":"Auto Create","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to."},"autoCreateStepwise":{"index":43,"kind":"parameter","displayName":"Auto Create Stepwise","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When auto-creating directories should each subdirectory be created one at a time. This may be needed due to security issues on some file-shares."},"bufferSize":{"index":44,"kind":"parameter","displayName":"Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":131072,"description":"Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files)."},"copyAndDeleteOnRenameFail":{"index":45,"kind":"parameter","displayName":"Copy And Delete On Rename Fail","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to fall back and do a copy and delete file, in case the file could not be renamed directly. This option is not available for the FTP component."},"renameUsingCopy":{"index":46,"kind":"parameter","displayName":"Rename Using Copy","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Perform rename operations using a copy and delete strategy. This is primarily used in environments where the regular rename operation is unreliable (e.g., across different file systems or networks). This option takes precedence over the copyAndDeleteOnRenameFail parameter that will automatically fall back to the copy and delete strategy, but only after additional delays."},"synchronous":{"index":47,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"antExclude":{"index":48,"kind":"parameter","displayName":"Ant Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format."},"antFilterCaseSensitive":{"index":49,"kind":"parameter","displayName":"Ant Filter Case Sensitive","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets case sensitive flag on ant filter."},"antInclude":{"index":50,"kind":"parameter","displayName":"Ant Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format."},"eagerMaxMessagesPerPoll":{"index":51,"kind":"parameter","displayName":"Eager Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting."},"exclude":{"index":52,"kind":"parameter","displayName":"Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"excludeExt":{"index":53,"kind":"parameter","displayName":"Exclude Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat files, use excludeExt=bak,dat. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"filter":{"index":54,"kind":"parameter","displayName":"Filter","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileFilter","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method."},"filterDirectory":{"index":55,"kind":"parameter","displayName":"Filter Directory","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}"},"filterFile":{"index":56,"kind":"parameter","displayName":"Filter File","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000"},"idempotent":{"index":57,"kind":"parameter","displayName":"Idempotent","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentEager":{"index":58,"kind":"parameter","displayName":"Idempotent Eager","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentKey":{"index":59,"kind":"parameter","displayName":"Idempotent Key","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}"},"idempotentRepository":{"index":60,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true."},"include":{"index":61,"kind":"parameter","displayName":"Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"includeExt":{"index":62,"kind":"parameter","displayName":"Include Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml files, use includeExt=txt,xml. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"maxDepth":{"index":63,"kind":"parameter","displayName":"Max Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"description":"The maximum depth to traverse when recursively processing a directory."},"maxMessagesPerPoll":{"index":64,"kind":"parameter","displayName":"Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards."},"minDepth":{"index":65,"kind":"parameter","displayName":"Min Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory."},"move":{"index":66,"kind":"parameter","displayName":"Move","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done."},"exclusiveReadLockStrategy":{"index":67,"kind":"parameter","displayName":"Exclusive Read Lock Strategy","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation."},"readLock":{"index":68,"kind":"parameter","displayName":"Read Lock","group":"lock","label":"consumer,lock","required":false,"type":"string","javaType":"java.lang.String","enum":["none","markerFile","fileLock","rename","changed","idempotent","idempotent-changed","idempotent-rename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: - none - No read lock is in use - markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component - changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. - fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. - rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. - idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that.Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan."},"readLockCheckInterval":{"index":69,"kind":"parameter","displayName":"Read Lock Check Interval","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"readLockDeleteOrphanLockFiles":{"index":70,"kind":"parameter","displayName":"Read Lock Delete Orphan Lock Files","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory."},"readLockIdempotentReleaseAsync":{"index":71,"kind":"parameter","displayName":"Read Lock Idempotent Release Async","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the delayed release task should be synchronous or asynchronous. See more details at the readLockIdempotentReleaseDelay option."},"readLockIdempotentReleaseAsyncPoolSize":{"index":72,"kind":"parameter","displayName":"Read Lock Idempotent Release Async Pool Size","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of threads in the scheduled thread pool when using asynchronous release tasks. Using a default of 1 core threads should be sufficient in almost all use-cases, only set this to a higher value if either updating the idempotent repository is slow, or there are a lot of files to process. This option is not in-use if you use a shared thread pool by configuring the readLockIdempotentReleaseExecutorService option. See more details at the readLockIdempotentReleaseDelay option."},"readLockIdempotentReleaseDelay":{"index":73,"kind":"parameter","displayName":"Read Lock Idempotent Release Delay","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Whether to delay the release task for a period of millis. This can be used to delay the release tasks to expand the window when a file is regarded as read-locked, in an active/active cluster scenario with a shared idempotent repository, to ensure other nodes cannot potentially scan and acquire the same file, due to race-conditions. By expanding the time-window of the release tasks helps prevents these situations. Note delaying is only needed if you have configured readLockRemoveOnCommit to true."},"readLockIdempotentReleaseExecutorService":{"index":74,"kind":"parameter","displayName":"Read Lock Idempotent Release Executor Service","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom and shared thread pool for asynchronous release tasks. See more details at the readLockIdempotentReleaseDelay option."},"readLockLoggingLevel":{"index":75,"kind":"parameter","displayName":"Read Lock Logging Level","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename."},"readLockMarkerFile":{"index":76,"kind":"parameter","displayName":"Read Lock Marker File","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application."},"readLockMinAge":{"index":77,"kind":"parameter","displayName":"Read Lock Min Age","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age."},"readLockMinLength":{"index":78,"kind":"parameter","displayName":"Read Lock Min Length","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files."},"readLockRemoveOnCommit":{"index":79,"kind":"parameter","displayName":"Read Lock Remove On Commit","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option."},"readLockRemoveOnRollback":{"index":80,"kind":"parameter","displayName":"Read Lock Remove On Rollback","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit)."},"readLockTimeout":{"index":81,"kind":"parameter","displayName":"Read Lock Timeout","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"description":"Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"backoffErrorThreshold":{"index":82,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":83,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":84,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":85,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":86,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":87,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":88,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":89,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":90,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":91,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":92,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":93,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":94,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":95,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"shuffle":{"index":96,"kind":"parameter","displayName":"Shuffle","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To shuffle the list of files (sort in random order)"},"sortBy":{"index":97,"kind":"parameter","displayName":"Sort By","group":"sort","label":"consumer,sort","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date."},"sorter":{"index":98,"kind":"parameter","displayName":"Sorter","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"java.util.Comparator>","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable sorter as a java.util.Comparator class."}}} , -{"component":{"kind":"component","name":"file-watch","title":"File Watch","description":"Get notified about file events in a directory using java.nio.file.WatchService.","deprecated":false,"firstVersion":"3.0.0","label":"file","javaType":"org.apache.camel.component.file.watch.FileWatchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-file-watch","version":"4.8.1","scheme":"file-watch","extendsScheme":"","syntax":"file-watch:path","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelFileEventType":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Type of event. Possible values: CREATE, DELETE, MODIFY.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#EVENT_TYPE_HEADER"},"CamelFileNameOnly":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only the file name (the name with no leading paths).","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_NAME_ONLY"},"CamelFileAbsolute":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A boolean option specifying whether the consumed file denotes an absolute path or not. Should normally be false for relative paths. Absolute paths should normally not be used but we added to the move option to allow moving files to absolute paths. But can be used elsewhere as well.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_ABSOLUTE"},"CamelFileAbsolutePath":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The absolute path to the file. For relative files this path holds the relative path instead.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_ABSOLUTE_PATH"},"CamelFilePath":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The file path. For relative files this is the starting directory the relative filename. For absolute files this is the absolute path.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_PATH"},"CamelFileName":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the consumed file as a relative file path with offset from the starting directory configured on the endpoint.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_NAME"},"CamelFileRelativePath":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The relative path.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_RELATIVE_PATH"},"CamelFileNameConsumed":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the file that has been consumed","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_NAME_CONSUMED"},"CamelFileParent":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent path.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_PARENT"},"CamelFileLastModified":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Long value containing the last modified timestamp of the file.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_LAST_MODIFIED"}},"properties":{"path":{"index":0,"kind":"path","displayName":"Path","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path of directory to consume events from."},"antInclude":{"index":1,"kind":"parameter","displayName":"Ant Include","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"**","description":"ANT style pattern to match files. The file is matched against path relative to endpoint path. Pattern must be also relative (not starting with slash)"},"autoCreate":{"index":2,"kind":"parameter","displayName":"Auto Create","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Auto create directory if does not exist."},"events":{"index":3,"kind":"parameter","displayName":"Events","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CREATE,MODIFY,DELETE","description":"Comma separated list of events to watch. Possible values: CREATE,MODIFY,DELETE"},"recursive":{"index":4,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Watch recursive in current and child directories (including newly created directories)."},"useFileHashing":{"index":5,"kind":"parameter","displayName":"Use File Hashing","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Enables or disables file hashing to detect duplicate events. If you disable this, you can get some events multiple times on some platforms and JDKs. Check java.nio.file.WatchService limitations for your target platform."},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"concurrentConsumers":{"index":9,"kind":"parameter","displayName":"Concurrent Consumers","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"The number of concurrent consumers. Increase this value, if your route is slow to prevent buffering in queue."},"fileHasher":{"index":10,"kind":"parameter","displayName":"File Hasher","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.methvin.watcher.hashing.FileHasher","deprecated":false,"autowired":false,"secret":false,"defaultValue":"#murmur3FFileHasher","description":"Reference to io.methvin.watcher.hashing.FileHasher. This prevents emitting duplicate events on some platforms. For working with large files and if you dont need detect multiple modifications per second per file, use #lastModifiedTimeFileHasher. You can also provide custom implementation in registry."},"pollThreads":{"index":11,"kind":"parameter","displayName":"Poll Threads","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"The number of threads polling WatchService. Increase this value, if you see OVERFLOW messages in log."},"queueSize":{"index":12,"kind":"parameter","displayName":"Queue Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"description":"Maximum size of queue between WatchService and consumer. Unbounded by default."}}} +{"component":{"kind":"component","name":"file-watch","title":"File Watch","description":"Get notified about file events in a directory using java.nio.file.WatchService.","deprecated":false,"firstVersion":"3.0.0","label":"file","javaType":"org.apache.camel.component.file.watch.FileWatchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-file-watch","version":"4.8.2","scheme":"file-watch","extendsScheme":"","syntax":"file-watch:path","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelFileEventType":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Type of event. Possible values: CREATE, DELETE, MODIFY.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#EVENT_TYPE_HEADER"},"CamelFileNameOnly":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only the file name (the name with no leading paths).","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_NAME_ONLY"},"CamelFileAbsolute":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A boolean option specifying whether the consumed file denotes an absolute path or not. Should normally be false for relative paths. Absolute paths should normally not be used but we added to the move option to allow moving files to absolute paths. But can be used elsewhere as well.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_ABSOLUTE"},"CamelFileAbsolutePath":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The absolute path to the file. For relative files this path holds the relative path instead.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_ABSOLUTE_PATH"},"CamelFilePath":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The file path. For relative files this is the starting directory the relative filename. For absolute files this is the absolute path.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_PATH"},"CamelFileName":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the consumed file as a relative file path with offset from the starting directory configured on the endpoint.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_NAME"},"CamelFileRelativePath":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The relative path.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_RELATIVE_PATH"},"CamelFileNameConsumed":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the file that has been consumed","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_NAME_CONSUMED"},"CamelFileParent":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent path.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_PARENT"},"CamelFileLastModified":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Long value containing the last modified timestamp of the file.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_LAST_MODIFIED"}},"properties":{"path":{"index":0,"kind":"path","displayName":"Path","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path of directory to consume events from."},"antInclude":{"index":1,"kind":"parameter","displayName":"Ant Include","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"**","description":"ANT style pattern to match files. The file is matched against path relative to endpoint path. Pattern must be also relative (not starting with slash)"},"autoCreate":{"index":2,"kind":"parameter","displayName":"Auto Create","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Auto create directory if does not exist."},"events":{"index":3,"kind":"parameter","displayName":"Events","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CREATE,MODIFY,DELETE","description":"Comma separated list of events to watch. Possible values: CREATE,MODIFY,DELETE"},"recursive":{"index":4,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Watch recursive in current and child directories (including newly created directories)."},"useFileHashing":{"index":5,"kind":"parameter","displayName":"Use File Hashing","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Enables or disables file hashing to detect duplicate events. If you disable this, you can get some events multiple times on some platforms and JDKs. Check java.nio.file.WatchService limitations for your target platform."},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"concurrentConsumers":{"index":9,"kind":"parameter","displayName":"Concurrent Consumers","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"The number of concurrent consumers. Increase this value, if your route is slow to prevent buffering in queue."},"fileHasher":{"index":10,"kind":"parameter","displayName":"File Hasher","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.methvin.watcher.hashing.FileHasher","deprecated":false,"autowired":false,"secret":false,"defaultValue":"#murmur3FFileHasher","description":"Reference to io.methvin.watcher.hashing.FileHasher. This prevents emitting duplicate events on some platforms. For working with large files and if you dont need detect multiple modifications per second per file, use #lastModifiedTimeFileHasher. You can also provide custom implementation in registry."},"pollThreads":{"index":11,"kind":"parameter","displayName":"Poll Threads","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"The number of threads polling WatchService. Increase this value, if you see OVERFLOW messages in log."},"queueSize":{"index":12,"kind":"parameter","displayName":"Queue Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"description":"Maximum size of queue between WatchService and consumer. Unbounded by default."}}} , -{"component":{"kind":"component","name":"flatpack","title":"Flatpack","description":"Parse fixed width and delimited files using the FlatPack library.","deprecated":false,"firstVersion":"1.4.0","label":"transformation","javaType":"org.apache.camel.component.flatpack.FlatpackComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-flatpack","version":"4.8.1","scheme":"flatpack","extendsScheme":"","syntax":"flatpack:type:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"headers":{"CamelFlatpackCounter":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The current row index. For splitRows=false the counter is the total number of rows.","constantName":"org.apache.camel.component.flatpack.FlatpackConstants#FLATPACK_COUNTER"}},"properties":{"type":{"index":0,"kind":"path","displayName":"Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.flatpack.FlatpackType","enum":["fixed","delim"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"delim","description":"Whether to use fixed or delimiter"},"resourceUri":{"index":1,"kind":"path","displayName":"Resource Uri","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"URL for loading the flatpack mapping file from classpath or file system"},"allowShortLines":{"index":2,"kind":"parameter","displayName":"Allow Short Lines","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Allows for lines to be shorter than expected and ignores the extra characters"},"delimiter":{"index":3,"kind":"parameter","displayName":"Delimiter","group":"common","label":"","required":false,"type":"string","javaType":"char","deprecated":false,"autowired":false,"secret":false,"defaultValue":",","description":"The default character delimiter for delimited files."},"ignoreExtraColumns":{"index":4,"kind":"parameter","displayName":"Ignore Extra Columns","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Allows for lines to be longer than expected and ignores the extra characters"},"ignoreFirstRecord":{"index":5,"kind":"parameter","displayName":"Ignore First Record","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the first line is ignored for delimited files (for the column headers)."},"splitRows":{"index":6,"kind":"parameter","displayName":"Split Rows","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets the Component to send each row as a separate exchange once parsed"},"textQualifier":{"index":7,"kind":"parameter","displayName":"Text Qualifier","group":"common","label":"","required":false,"type":"string","javaType":"char","deprecated":false,"autowired":false,"secret":false,"description":"The text qualifier for delimited files."},"sendEmptyMessageWhenIdle":{"index":8,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":12,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":13,"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."},"backoffErrorThreshold":{"index":14,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":16,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":17,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":18,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":19,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":20,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":21,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":22,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":23,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":24,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":25,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":26,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":27,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} +{"component":{"kind":"component","name":"flatpack","title":"Flatpack","description":"Parse fixed width and delimited files using the FlatPack library.","deprecated":false,"firstVersion":"1.4.0","label":"transformation","javaType":"org.apache.camel.component.flatpack.FlatpackComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-flatpack","version":"4.8.2","scheme":"flatpack","extendsScheme":"","syntax":"flatpack:type:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"headers":{"CamelFlatpackCounter":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The current row index. For splitRows=false the counter is the total number of rows.","constantName":"org.apache.camel.component.flatpack.FlatpackConstants#FLATPACK_COUNTER"}},"properties":{"type":{"index":0,"kind":"path","displayName":"Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.flatpack.FlatpackType","enum":["fixed","delim"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"delim","description":"Whether to use fixed or delimiter"},"resourceUri":{"index":1,"kind":"path","displayName":"Resource Uri","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"URL for loading the flatpack mapping file from classpath or file system"},"allowShortLines":{"index":2,"kind":"parameter","displayName":"Allow Short Lines","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Allows for lines to be shorter than expected and ignores the extra characters"},"delimiter":{"index":3,"kind":"parameter","displayName":"Delimiter","group":"common","label":"","required":false,"type":"string","javaType":"char","deprecated":false,"autowired":false,"secret":false,"defaultValue":",","description":"The default character delimiter for delimited files."},"ignoreExtraColumns":{"index":4,"kind":"parameter","displayName":"Ignore Extra Columns","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Allows for lines to be longer than expected and ignores the extra characters"},"ignoreFirstRecord":{"index":5,"kind":"parameter","displayName":"Ignore First Record","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the first line is ignored for delimited files (for the column headers)."},"splitRows":{"index":6,"kind":"parameter","displayName":"Split Rows","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets the Component to send each row as a separate exchange once parsed"},"textQualifier":{"index":7,"kind":"parameter","displayName":"Text Qualifier","group":"common","label":"","required":false,"type":"string","javaType":"char","deprecated":false,"autowired":false,"secret":false,"description":"The text qualifier for delimited files."},"sendEmptyMessageWhenIdle":{"index":8,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":12,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":13,"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."},"backoffErrorThreshold":{"index":14,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":16,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":17,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":18,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":19,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":20,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":21,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":22,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":23,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":24,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":25,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":26,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":27,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} , -{"component":{"kind":"component","name":"flink","title":"Flink","description":"Send DataSet jobs to an Apache Flink cluster.","deprecated":false,"firstVersion":"2.18.0","label":"transformation,bigdata","javaType":"org.apache.camel.component.flink.FlinkComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-flink","version":"4.8.1","scheme":"flink","extendsScheme":"","syntax":"flink:endpointType","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelFlinkDataSet":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The dataset","constantName":"org.apache.camel.component.flink.FlinkConstants#FLINK_DATASET_HEADER"},"CamelFlinkDataSetCallback":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.flink.DataSetCallback","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The dataset callback","constantName":"org.apache.camel.component.flink.FlinkConstants#FLINK_DATASET_CALLBACK_HEADER"},"CamelFlinkDataStream":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data stream","constantName":"org.apache.camel.component.flink.FlinkConstants#FLINK_DATASTREAM_HEADER"},"CamelFlinkDataStreamCallback":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.flink.DataStreamCallback","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data stream callback","constantName":"org.apache.camel.component.flink.FlinkConstants#FLINK_DATASTREAM_CALLBACK_HEADER"}},"properties":{"endpointType":{"index":0,"kind":"path","displayName":"Endpoint Type","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.flink.EndpointType","enum":["dataset","datastream"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Type of the endpoint (dataset, datastream)."},"collect":{"index":1,"kind":"parameter","displayName":"Collect","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Indicates if results should be collected or counted."},"dataSet":{"index":2,"kind":"parameter","displayName":"Data Set","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.flink.api.java.DataSet","deprecated":false,"autowired":false,"secret":false,"description":"DataSet to compute against."},"dataSetCallback":{"index":3,"kind":"parameter","displayName":"Data Set Callback","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.flink.DataSetCallback","deprecated":false,"autowired":false,"secret":false,"description":"Function performing action against a DataSet."},"dataStream":{"index":4,"kind":"parameter","displayName":"Data Stream","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.flink.streaming.api.datastream.DataStream","deprecated":false,"autowired":false,"secret":false,"description":"DataStream to compute against."},"dataStreamCallback":{"index":5,"kind":"parameter","displayName":"Data Stream Callback","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.flink.DataStreamCallback","deprecated":false,"autowired":false,"secret":false,"description":"Function performing action against a DataStream."},"lazyStartProducer":{"index":6,"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."}}} +{"component":{"kind":"component","name":"flink","title":"Flink","description":"Send DataSet jobs to an Apache Flink cluster.","deprecated":false,"firstVersion":"2.18.0","label":"transformation,bigdata","javaType":"org.apache.camel.component.flink.FlinkComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-flink","version":"4.8.2","scheme":"flink","extendsScheme":"","syntax":"flink:endpointType","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelFlinkDataSet":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The dataset","constantName":"org.apache.camel.component.flink.FlinkConstants#FLINK_DATASET_HEADER"},"CamelFlinkDataSetCallback":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.flink.DataSetCallback","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The dataset callback","constantName":"org.apache.camel.component.flink.FlinkConstants#FLINK_DATASET_CALLBACK_HEADER"},"CamelFlinkDataStream":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data stream","constantName":"org.apache.camel.component.flink.FlinkConstants#FLINK_DATASTREAM_HEADER"},"CamelFlinkDataStreamCallback":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.flink.DataStreamCallback","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data stream callback","constantName":"org.apache.camel.component.flink.FlinkConstants#FLINK_DATASTREAM_CALLBACK_HEADER"}},"properties":{"endpointType":{"index":0,"kind":"path","displayName":"Endpoint Type","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.flink.EndpointType","enum":["dataset","datastream"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Type of the endpoint (dataset, datastream)."},"collect":{"index":1,"kind":"parameter","displayName":"Collect","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Indicates if results should be collected or counted."},"dataSet":{"index":2,"kind":"parameter","displayName":"Data Set","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.flink.api.java.DataSet","deprecated":false,"autowired":false,"secret":false,"description":"DataSet to compute against."},"dataSetCallback":{"index":3,"kind":"parameter","displayName":"Data Set Callback","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.flink.DataSetCallback","deprecated":false,"autowired":false,"secret":false,"description":"Function performing action against a DataSet."},"dataStream":{"index":4,"kind":"parameter","displayName":"Data Stream","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.flink.streaming.api.datastream.DataStream","deprecated":false,"autowired":false,"secret":false,"description":"DataStream to compute against."},"dataStreamCallback":{"index":5,"kind":"parameter","displayName":"Data Stream Callback","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.flink.DataStreamCallback","deprecated":false,"autowired":false,"secret":false,"description":"Function performing action against a DataStream."},"lazyStartProducer":{"index":6,"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."}}} , -{"component":{"kind":"component","name":"fop","title":"FOP","description":"Render messages into PDF and other output formats supported by Apache FOP.","deprecated":false,"firstVersion":"2.10.0","label":"file,transformation","javaType":"org.apache.camel.component.fop.FopComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-fop","version":"4.8.1","scheme":"fop","extendsScheme":"","syntax":"fop:outputType","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelFop.Output.Format":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The output format","constantName":"org.apache.camel.component.fop.FopConstants#CAMEL_FOP_OUTPUT_FORMAT"}},"properties":{"outputType":{"index":0,"kind":"path","displayName":"Output Type","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.fop.FopOutputType","enum":["pdf","ps","pcl","png","jpeg","svg","xml","mif","rtf","txt"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The primary output format is PDF but other output formats are also supported."},"fopFactory":{"index":1,"kind":"parameter","displayName":"Fop Factory","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.fop.apps.FopFactory","deprecated":false,"autowired":false,"secret":false,"description":"Allows to use a custom configured or implementation of org.apache.fop.apps.FopFactory."},"userConfigURL":{"index":2,"kind":"parameter","displayName":"User Config URL","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"The location of a configuration file which can be loaded from classpath or file system."},"lazyStartProducer":{"index":3,"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."}}} +{"component":{"kind":"component","name":"fop","title":"FOP","description":"Render messages into PDF and other output formats supported by Apache FOP.","deprecated":false,"firstVersion":"2.10.0","label":"file,transformation","javaType":"org.apache.camel.component.fop.FopComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-fop","version":"4.8.2","scheme":"fop","extendsScheme":"","syntax":"fop:outputType","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelFop.Output.Format":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The output format","constantName":"org.apache.camel.component.fop.FopConstants#CAMEL_FOP_OUTPUT_FORMAT"}},"properties":{"outputType":{"index":0,"kind":"path","displayName":"Output Type","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.fop.FopOutputType","enum":["pdf","ps","pcl","png","jpeg","svg","xml","mif","rtf","txt"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The primary output format is PDF but other output formats are also supported."},"fopFactory":{"index":1,"kind":"parameter","displayName":"Fop Factory","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.fop.apps.FopFactory","deprecated":false,"autowired":false,"secret":false,"description":"Allows to use a custom configured or implementation of org.apache.fop.apps.FopFactory."},"userConfigURL":{"index":2,"kind":"parameter","displayName":"User Config URL","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"The location of a configuration file which can be loaded from classpath or file system."},"lazyStartProducer":{"index":3,"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."}}} , -{"component":{"kind":"component","name":"freemarker","title":"Freemarker","description":"Transform messages using FreeMarker templates.","deprecated":false,"firstVersion":"2.10.0","label":"transformation","javaType":"org.apache.camel.component.freemarker.FreemarkerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-freemarker","version":"4.8.1","scheme":"freemarker","extendsScheme":"","syntax":"freemarker:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelFreemarkerResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to use instead of the endpoint configured.","constantName":"org.apache.camel.component.freemarker.FreemarkerConstants#FREEMARKER_RESOURCE_URI"},"CamelFreemarkerTemplate":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.freemarker.FreemarkerConstants#FREEMARKER_TEMPLATE"},"CamelFreemarkerDataModel":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data model","constantName":"org.apache.camel.component.freemarker.FreemarkerConstants#FREEMARKER_DATA_MODEL"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"configuration":{"index":3,"kind":"parameter","displayName":"Configuration","group":"producer","label":"","required":false,"type":"object","javaType":"freemarker.template.Configuration","deprecated":false,"autowired":false,"secret":false,"description":"Sets the Freemarker configuration to use"},"contentCache":{"index":4,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"encoding":{"index":5,"kind":"parameter","displayName":"Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the encoding to be used for loading the template file."},"templateUpdateDelay":{"index":6,"kind":"parameter","displayName":"Template Update Delay","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Number of seconds the loaded template resource will remain in the cache."},"lazyStartProducer":{"index":7,"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."}}} +{"component":{"kind":"component","name":"freemarker","title":"Freemarker","description":"Transform messages using FreeMarker templates.","deprecated":false,"firstVersion":"2.10.0","label":"transformation","javaType":"org.apache.camel.component.freemarker.FreemarkerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-freemarker","version":"4.8.2","scheme":"freemarker","extendsScheme":"","syntax":"freemarker:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelFreemarkerResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to use instead of the endpoint configured.","constantName":"org.apache.camel.component.freemarker.FreemarkerConstants#FREEMARKER_RESOURCE_URI"},"CamelFreemarkerTemplate":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.freemarker.FreemarkerConstants#FREEMARKER_TEMPLATE"},"CamelFreemarkerDataModel":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data model","constantName":"org.apache.camel.component.freemarker.FreemarkerConstants#FREEMARKER_DATA_MODEL"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"configuration":{"index":3,"kind":"parameter","displayName":"Configuration","group":"producer","label":"","required":false,"type":"object","javaType":"freemarker.template.Configuration","deprecated":false,"autowired":false,"secret":false,"description":"Sets the Freemarker configuration to use"},"contentCache":{"index":4,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"encoding":{"index":5,"kind":"parameter","displayName":"Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the encoding to be used for loading the template file."},"templateUpdateDelay":{"index":6,"kind":"parameter","displayName":"Template Update Delay","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Number of seconds the loaded template resource will remain in the cache."},"lazyStartProducer":{"index":7,"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."}}} , -{"component":{"kind":"component","name":"ftp","title":"FTP","description":"Upload and download files to/from FTP servers.","deprecated":false,"firstVersion":"1.1.0","label":"file","javaType":"org.apache.camel.component.file.remote.FtpComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ftp","version":"4.8.1","scheme":"ftp","extendsScheme":"file","syntax":"ftp:host:port/directoryName","alternativeSyntax":"ftp:username:password@host:port/directoryName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelFileLength":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A long value containing the file size.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LENGTH"},"CamelFileLastModified":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Long value containing the last modified timestamp of the file.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LAST_MODIFIED"},"CamelFileName":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the output file name (relative to the endpoint directory) to be used for the output message when sending to the endpoint. If this is not present and no expression either, then a generated message ID is used as the filename instead.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_NAME"},"CamelFileNameOnly":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only the file name (the name with no leading paths).","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_NAME_ONLY"},"CamelFileParent":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent path.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_PARENT"},"CamelRemoteFileInputStream":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.io.InputStream","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote file input stream.","constantName":"org.apache.camel.component.file.remote.FtpConstants#REMOTE_FILE_INPUT_STREAM"},"CamelFileLocalWorkPath":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the local work file, if local work directory is used.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LOCAL_WORK_PATH"},"CamelFtpReplyCode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FTP client reply code","constantName":"org.apache.camel.component.file.remote.FtpConstants#FTP_REPLY_CODE"},"CamelFtpReplyString":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FTP client reply string","constantName":"org.apache.camel.component.file.remote.FtpConstants#FTP_REPLY_STRING"},"CamelFileHost":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote hostname.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_HOST"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Hostname of the FTP server"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Port of the FTP server"},"directoryName":{"index":2,"kind":"path","displayName":"Directory Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"The starting directory"},"binary":{"index":3,"kind":"parameter","displayName":"Binary","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false)."},"charset":{"index":4,"kind":"parameter","displayName":"Charset","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages."},"disconnect":{"index":5,"kind":"parameter","displayName":"Disconnect","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead."},"doneFileName":{"index":6,"kind":"parameter","displayName":"Done File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders."},"fileName":{"index":7,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."},"passiveMode":{"index":8,"kind":"parameter","displayName":"Passive Mode","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets passive mode connections. Default is active mode connections."},"separator":{"index":9,"kind":"parameter","displayName":"Separator","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator","enum":["UNIX","Windows","Auto"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"UNIX","configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name"},"transferLoggingIntervalSeconds":{"index":10,"kind":"parameter","displayName":"Transfer Logging Interval Seconds","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5,"description":"Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight. This is used for logging progress when operations take a longer time."},"transferLoggingLevel":{"index":11,"kind":"parameter","displayName":"Transfer Logging Level","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Configure the logging level to use when logging the progress of upload and download operations."},"transferLoggingVerbose":{"index":12,"kind":"parameter","displayName":"Transfer Logging Verbose","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configures whether perform verbose (fine-grained) logging of the progress of upload and download operations."},"fastExistsCheck":{"index":13,"kind":"parameter","displayName":"Fast Exists Check","group":"common (advanced)","label":"common,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set this option to be true, camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly, if the option is false, camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files."},"delete":{"index":14,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file will be deleted after it is processed successfully."},"moveFailed":{"index":15,"kind":"parameter","displayName":"Move Failed","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again."},"noop":{"index":16,"kind":"parameter","displayName":"Noop","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again."},"preMove":{"index":17,"kind":"parameter","displayName":"Pre Move","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order."},"preSort":{"index":18,"kind":"parameter","displayName":"Pre Sort","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled."},"recursive":{"index":19,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If a directory, will look for files in all the sub-directories as well."},"resumeDownload":{"index":20,"kind":"parameter","displayName":"Resume Download","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configures whether resume download is enabled. This must be supported by the FTP server (almost all FTP servers support it). In addition, the options localWorkDirectory must be configured so downloaded files are stored in a local directory, and the option binary must be enabled, which is required to support resuming of downloads."},"sendEmptyMessageWhenIdle":{"index":21,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"streamDownload":{"index":22,"kind":"parameter","displayName":"Stream Download","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets the download method to use when not using a local working directory. If set to true, the remote files are streamed to the route as they are read. When set to false, the remote files are loaded into memory before being sent into the route. If enabling this option then you must set stepwise=false as both cannot be enabled at the same time."},"bridgeErrorHandler":{"index":23,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"download":{"index":24,"kind":"parameter","displayName":"Download","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded."},"exceptionHandler":{"index":25,"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":{"index":26,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"handleDirectoryParserAbsoluteResult":{"index":27,"kind":"parameter","displayName":"Handle Directory Parser Absolute Result","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Allows you to set how the consumer will handle subfolders and files in the path if the directory parser results in with absolute paths. The reason for this is that some FTP servers may return file names with absolute paths, and if so, then the FTP component needs to handle this by converting the returned path into a relative path."},"ignoreFileNotFoundOrPermissionError":{"index":28,"kind":"parameter","displayName":"Ignore File Not Found Or Permission Error","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exist or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead."},"inProgressRepository":{"index":29,"kind":"parameter","displayName":"In Progress Repository","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."},"localWorkDirectory":{"index":30,"kind":"parameter","displayName":"Local Work Directory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory."},"onCompletionExceptionHandler":{"index":31,"kind":"parameter","displayName":"On Completion Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore."},"pollStrategy":{"index":32,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"processStrategy":{"index":33,"kind":"parameter","displayName":"Process Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileProcessStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply."},"useList":{"index":34,"kind":"parameter","displayName":"Use List","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Whether to allow using LIST command when downloading a file. Default is true. In some use cases you may want to download a specific file and are not allowed to use the LIST command, and therefore you can set this option to false. Notice when using this option, then the specific file to download does not include meta-data information such as file size, timestamp, permissions etc, because those information is only possible to retrieve when LIST command is in use."},"checksumFileAlgorithm":{"index":35,"kind":"parameter","displayName":"Checksum File Algorithm","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["MD2","MD5","SHA_1","SHA_224","SHA_256","SHA_384","SHA_512","SHA_512_224","SHA_512_256","SHA3_224","SHA3_256","SHA3_384","SHA3_512"],"deprecated":false,"autowired":false,"secret":false,"description":"If provided, then Camel will write a checksum file when the original file has been written. The checksum file will contain the checksum created with the provided algorithm for the original file. The checksum file will always be written in the same folder as the original file."},"fileExist":{"index":36,"kind":"parameter","displayName":"File Exist","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExist","enum":["Override","Append","Fail","Ignore","Move","TryRename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Override","description":"What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers."},"flatten":{"index":37,"kind":"parameter","displayName":"Flatten","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."},"jailStartingDirectory":{"index":38,"kind":"parameter","displayName":"Jail Starting Directory","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."},"moveExisting":{"index":39,"kind":"parameter","displayName":"Move Existing","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base."},"tempFileName":{"index":40,"kind":"parameter","displayName":"Temp File Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir."},"tempPrefix":{"index":41,"kind":"parameter","displayName":"Temp Prefix","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files."},"allowNullBody":{"index":42,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."},"chmod":{"index":43,"kind":"parameter","displayName":"Chmod","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Allows you to set chmod on the stored file. For example, chmod=640."},"disconnectOnBatchComplete":{"index":44,"kind":"parameter","displayName":"Disconnect On Batch Complete","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server."},"eagerDeleteTargetFile":{"index":45,"kind":"parameter","displayName":"Eager Delete Target File","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation."},"keepLastModified":{"index":46,"kind":"parameter","displayName":"Keep Last Modified","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers."},"lazyStartProducer":{"index":47,"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."},"moveExistingFileStrategy":{"index":48,"kind":"parameter","displayName":"Move Existing File Strategy","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.strategy.FileMoveExistingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"},"sendNoop":{"index":49,"kind":"parameter","displayName":"Send Noop","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Whether to send a noop command as a pre-write check before uploading files to the FTP server. This is enabled by default as a validation of the connection is still valid, which allows to silently re-connect to be able to upload the file. However if this causes problems, you can turn this option off."},"activePortRange":{"index":50,"kind":"parameter","displayName":"Active Port Range","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Set the client side port range in active mode. The syntax is: minPort-maxPort Both port numbers are inclusive, e.g., 10000-19999 to include all 1xxxx ports."},"autoCreate":{"index":51,"kind":"parameter","displayName":"Auto Create","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to."},"bufferSize":{"index":52,"kind":"parameter","displayName":"Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":131072,"description":"Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files)."},"connectTimeout":{"index":53,"kind":"parameter","displayName":"Connect Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH"},"ftpClient":{"index":54,"kind":"parameter","displayName":"Ftp Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.commons.net.ftp.FTPClient","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom instance of FTPClient"},"ftpClientConfig":{"index":55,"kind":"parameter","displayName":"Ftp Client Config","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.commons.net.ftp.FTPClientConfig","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use."},"ftpClientConfigParameters":{"index":56,"kind":"parameter","displayName":"Ftp Client Config Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"ftpClientConfig.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Used by FtpComponent to provide additional parameters for the FTPClientConfig"},"ftpClientParameters":{"index":57,"kind":"parameter","displayName":"Ftp Client Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"ftpClient.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Used by FtpComponent to provide additional parameters for the FTPClient"},"maximumReconnectAttempts":{"index":58,"kind":"parameter","displayName":"Maximum Reconnect Attempts","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior."},"reconnectDelay":{"index":59,"kind":"parameter","displayName":"Reconnect Delay","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Delay in millis Camel will wait before performing a reconnect attempt."},"siteCommand":{"index":60,"kind":"parameter","displayName":"Site Command","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets optional site command(s) to be executed after successful login. Multiple site commands can be separated using a new line character."},"soTimeout":{"index":61,"kind":"parameter","displayName":"So Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"300000","configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance."},"stepwise":{"index":62,"kind":"parameter","displayName":"Stepwise","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets whether we should stepwise change directories while traversing file structures when downloading files, or as well when uploading a file to a directory. You can disable this if you for example are in a situation where you cannot change directory on the FTP server due security reasons. Stepwise cannot be used together with streamDownload."},"throwExceptionOnConnectFailed":{"index":63,"kind":"parameter","displayName":"Throw Exception On Connect Failed","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method."},"timeout":{"index":64,"kind":"parameter","displayName":"Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets the data timeout for waiting for reply Used only by FTPClient"},"antExclude":{"index":65,"kind":"parameter","displayName":"Ant Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format."},"antFilterCaseSensitive":{"index":66,"kind":"parameter","displayName":"Ant Filter Case Sensitive","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets case sensitive flag on ant filter."},"antInclude":{"index":67,"kind":"parameter","displayName":"Ant Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format."},"eagerMaxMessagesPerPoll":{"index":68,"kind":"parameter","displayName":"Eager Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting."},"exclude":{"index":69,"kind":"parameter","displayName":"Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"excludeExt":{"index":70,"kind":"parameter","displayName":"Exclude Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat files, use excludeExt=bak,dat. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"filter":{"index":71,"kind":"parameter","displayName":"Filter","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileFilter","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method."},"filterDirectory":{"index":72,"kind":"parameter","displayName":"Filter Directory","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}"},"filterFile":{"index":73,"kind":"parameter","displayName":"Filter File","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000"},"idempotent":{"index":74,"kind":"parameter","displayName":"Idempotent","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentEager":{"index":75,"kind":"parameter","displayName":"Idempotent Eager","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentKey":{"index":76,"kind":"parameter","displayName":"Idempotent Key","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}"},"idempotentRepository":{"index":77,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true."},"include":{"index":78,"kind":"parameter","displayName":"Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"includeExt":{"index":79,"kind":"parameter","displayName":"Include Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml files, use includeExt=txt,xml. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"maxDepth":{"index":80,"kind":"parameter","displayName":"Max Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"description":"The maximum depth to traverse when recursively processing a directory."},"maxMessagesPerPoll":{"index":81,"kind":"parameter","displayName":"Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards."},"minDepth":{"index":82,"kind":"parameter","displayName":"Min Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory."},"move":{"index":83,"kind":"parameter","displayName":"Move","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done."},"exclusiveReadLockStrategy":{"index":84,"kind":"parameter","displayName":"Exclusive Read Lock Strategy","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation."},"readLock":{"index":85,"kind":"parameter","displayName":"Read Lock","group":"lock","label":"consumer,lock","required":false,"type":"string","javaType":"java.lang.String","enum":["none","markerFile","fileLock","rename","changed","idempotent","idempotent-changed","idempotent-rename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: - none - No read lock is in use - markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component - changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. - fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. - rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. - idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that.Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan."},"readLockCheckInterval":{"index":86,"kind":"parameter","displayName":"Read Lock Check Interval","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"readLockDeleteOrphanLockFiles":{"index":87,"kind":"parameter","displayName":"Read Lock Delete Orphan Lock Files","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory."},"readLockLoggingLevel":{"index":88,"kind":"parameter","displayName":"Read Lock Logging Level","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename."},"readLockMarkerFile":{"index":89,"kind":"parameter","displayName":"Read Lock Marker File","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application."},"readLockMinAge":{"index":90,"kind":"parameter","displayName":"Read Lock Min Age","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age."},"readLockMinLength":{"index":91,"kind":"parameter","displayName":"Read Lock Min Length","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files."},"readLockRemoveOnCommit":{"index":92,"kind":"parameter","displayName":"Read Lock Remove On Commit","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option."},"readLockRemoveOnRollback":{"index":93,"kind":"parameter","displayName":"Read Lock Remove On Rollback","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit)."},"readLockTimeout":{"index":94,"kind":"parameter","displayName":"Read Lock Timeout","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"description":"Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"backoffErrorThreshold":{"index":95,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":96,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":97,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":98,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":99,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":100,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":101,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":102,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":103,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":104,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":105,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":106,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":107,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":108,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"account":{"index":109,"kind":"parameter","displayName":"Account","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Account to use for login"},"password":{"index":110,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Password to use for login"},"username":{"index":111,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Username to use for login"},"shuffle":{"index":112,"kind":"parameter","displayName":"Shuffle","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To shuffle the list of files (sort in random order)"},"sortBy":{"index":113,"kind":"parameter","displayName":"Sort By","group":"sort","label":"consumer,sort","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date."},"sorter":{"index":114,"kind":"parameter","displayName":"Sorter","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"java.util.Comparator>","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable sorter as a java.util.Comparator class."}}} +{"component":{"kind":"component","name":"ftp","title":"FTP","description":"Upload and download files to/from FTP servers.","deprecated":false,"firstVersion":"1.1.0","label":"file","javaType":"org.apache.camel.component.file.remote.FtpComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ftp","version":"4.8.2","scheme":"ftp","extendsScheme":"file","syntax":"ftp:host:port/directoryName","alternativeSyntax":"ftp:username:password@host:port/directoryName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelFileLength":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A long value containing the file size.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LENGTH"},"CamelFileLastModified":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Long value containing the last modified timestamp of the file.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LAST_MODIFIED"},"CamelFileName":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the output file name (relative to the endpoint directory) to be used for the output message when sending to the endpoint. If this is not present and no expression either, then a generated message ID is used as the filename instead.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_NAME"},"CamelFileNameOnly":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only the file name (the name with no leading paths).","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_NAME_ONLY"},"CamelFileParent":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent path.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_PARENT"},"CamelRemoteFileInputStream":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.io.InputStream","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote file input stream.","constantName":"org.apache.camel.component.file.remote.FtpConstants#REMOTE_FILE_INPUT_STREAM"},"CamelFileLocalWorkPath":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the local work file, if local work directory is used.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LOCAL_WORK_PATH"},"CamelFtpReplyCode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FTP client reply code","constantName":"org.apache.camel.component.file.remote.FtpConstants#FTP_REPLY_CODE"},"CamelFtpReplyString":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FTP client reply string","constantName":"org.apache.camel.component.file.remote.FtpConstants#FTP_REPLY_STRING"},"CamelFileHost":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote hostname.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_HOST"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Hostname of the FTP server"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Port of the FTP server"},"directoryName":{"index":2,"kind":"path","displayName":"Directory Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"The starting directory"},"binary":{"index":3,"kind":"parameter","displayName":"Binary","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false)."},"charset":{"index":4,"kind":"parameter","displayName":"Charset","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages."},"disconnect":{"index":5,"kind":"parameter","displayName":"Disconnect","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead."},"doneFileName":{"index":6,"kind":"parameter","displayName":"Done File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders."},"fileName":{"index":7,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."},"passiveMode":{"index":8,"kind":"parameter","displayName":"Passive Mode","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets passive mode connections. Default is active mode connections."},"separator":{"index":9,"kind":"parameter","displayName":"Separator","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator","enum":["UNIX","Windows","Auto"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"UNIX","configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name"},"transferLoggingIntervalSeconds":{"index":10,"kind":"parameter","displayName":"Transfer Logging Interval Seconds","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5,"description":"Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight. This is used for logging progress when operations take a longer time."},"transferLoggingLevel":{"index":11,"kind":"parameter","displayName":"Transfer Logging Level","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Configure the logging level to use when logging the progress of upload and download operations."},"transferLoggingVerbose":{"index":12,"kind":"parameter","displayName":"Transfer Logging Verbose","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configures whether perform verbose (fine-grained) logging of the progress of upload and download operations."},"fastExistsCheck":{"index":13,"kind":"parameter","displayName":"Fast Exists Check","group":"common (advanced)","label":"common,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set this option to be true, camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly, if the option is false, camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files."},"delete":{"index":14,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file will be deleted after it is processed successfully."},"moveFailed":{"index":15,"kind":"parameter","displayName":"Move Failed","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again."},"noop":{"index":16,"kind":"parameter","displayName":"Noop","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again."},"preMove":{"index":17,"kind":"parameter","displayName":"Pre Move","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order."},"preSort":{"index":18,"kind":"parameter","displayName":"Pre Sort","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled."},"recursive":{"index":19,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If a directory, will look for files in all the sub-directories as well."},"resumeDownload":{"index":20,"kind":"parameter","displayName":"Resume Download","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configures whether resume download is enabled. This must be supported by the FTP server (almost all FTP servers support it). In addition, the options localWorkDirectory must be configured so downloaded files are stored in a local directory, and the option binary must be enabled, which is required to support resuming of downloads."},"sendEmptyMessageWhenIdle":{"index":21,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"streamDownload":{"index":22,"kind":"parameter","displayName":"Stream Download","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets the download method to use when not using a local working directory. If set to true, the remote files are streamed to the route as they are read. When set to false, the remote files are loaded into memory before being sent into the route. If enabling this option then you must set stepwise=false as both cannot be enabled at the same time."},"bridgeErrorHandler":{"index":23,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"download":{"index":24,"kind":"parameter","displayName":"Download","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded."},"exceptionHandler":{"index":25,"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":{"index":26,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"handleDirectoryParserAbsoluteResult":{"index":27,"kind":"parameter","displayName":"Handle Directory Parser Absolute Result","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Allows you to set how the consumer will handle subfolders and files in the path if the directory parser results in with absolute paths. The reason for this is that some FTP servers may return file names with absolute paths, and if so, then the FTP component needs to handle this by converting the returned path into a relative path."},"ignoreFileNotFoundOrPermissionError":{"index":28,"kind":"parameter","displayName":"Ignore File Not Found Or Permission Error","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exist or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead."},"inProgressRepository":{"index":29,"kind":"parameter","displayName":"In Progress Repository","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."},"localWorkDirectory":{"index":30,"kind":"parameter","displayName":"Local Work Directory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory."},"onCompletionExceptionHandler":{"index":31,"kind":"parameter","displayName":"On Completion Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore."},"pollStrategy":{"index":32,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"processStrategy":{"index":33,"kind":"parameter","displayName":"Process Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileProcessStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply."},"useList":{"index":34,"kind":"parameter","displayName":"Use List","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Whether to allow using LIST command when downloading a file. Default is true. In some use cases you may want to download a specific file and are not allowed to use the LIST command, and therefore you can set this option to false. Notice when using this option, then the specific file to download does not include meta-data information such as file size, timestamp, permissions etc, because those information is only possible to retrieve when LIST command is in use."},"checksumFileAlgorithm":{"index":35,"kind":"parameter","displayName":"Checksum File Algorithm","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["MD2","MD5","SHA_1","SHA_224","SHA_256","SHA_384","SHA_512","SHA_512_224","SHA_512_256","SHA3_224","SHA3_256","SHA3_384","SHA3_512"],"deprecated":false,"autowired":false,"secret":false,"description":"If provided, then Camel will write a checksum file when the original file has been written. The checksum file will contain the checksum created with the provided algorithm for the original file. The checksum file will always be written in the same folder as the original file."},"fileExist":{"index":36,"kind":"parameter","displayName":"File Exist","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExist","enum":["Override","Append","Fail","Ignore","Move","TryRename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Override","description":"What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers."},"flatten":{"index":37,"kind":"parameter","displayName":"Flatten","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."},"jailStartingDirectory":{"index":38,"kind":"parameter","displayName":"Jail Starting Directory","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."},"moveExisting":{"index":39,"kind":"parameter","displayName":"Move Existing","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base."},"tempFileName":{"index":40,"kind":"parameter","displayName":"Temp File Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir."},"tempPrefix":{"index":41,"kind":"parameter","displayName":"Temp Prefix","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files."},"allowNullBody":{"index":42,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."},"chmod":{"index":43,"kind":"parameter","displayName":"Chmod","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Allows you to set chmod on the stored file. For example, chmod=640."},"disconnectOnBatchComplete":{"index":44,"kind":"parameter","displayName":"Disconnect On Batch Complete","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server."},"eagerDeleteTargetFile":{"index":45,"kind":"parameter","displayName":"Eager Delete Target File","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation."},"keepLastModified":{"index":46,"kind":"parameter","displayName":"Keep Last Modified","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers."},"lazyStartProducer":{"index":47,"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."},"moveExistingFileStrategy":{"index":48,"kind":"parameter","displayName":"Move Existing File Strategy","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.strategy.FileMoveExistingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"},"sendNoop":{"index":49,"kind":"parameter","displayName":"Send Noop","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Whether to send a noop command as a pre-write check before uploading files to the FTP server. This is enabled by default as a validation of the connection is still valid, which allows to silently re-connect to be able to upload the file. However if this causes problems, you can turn this option off."},"activePortRange":{"index":50,"kind":"parameter","displayName":"Active Port Range","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Set the client side port range in active mode. The syntax is: minPort-maxPort Both port numbers are inclusive, e.g., 10000-19999 to include all 1xxxx ports."},"autoCreate":{"index":51,"kind":"parameter","displayName":"Auto Create","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to."},"bufferSize":{"index":52,"kind":"parameter","displayName":"Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":131072,"description":"Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files)."},"connectTimeout":{"index":53,"kind":"parameter","displayName":"Connect Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH"},"ftpClient":{"index":54,"kind":"parameter","displayName":"Ftp Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.commons.net.ftp.FTPClient","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom instance of FTPClient"},"ftpClientConfig":{"index":55,"kind":"parameter","displayName":"Ftp Client Config","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.commons.net.ftp.FTPClientConfig","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use."},"ftpClientConfigParameters":{"index":56,"kind":"parameter","displayName":"Ftp Client Config Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"ftpClientConfig.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Used by FtpComponent to provide additional parameters for the FTPClientConfig"},"ftpClientParameters":{"index":57,"kind":"parameter","displayName":"Ftp Client Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"ftpClient.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Used by FtpComponent to provide additional parameters for the FTPClient"},"maximumReconnectAttempts":{"index":58,"kind":"parameter","displayName":"Maximum Reconnect Attempts","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior."},"reconnectDelay":{"index":59,"kind":"parameter","displayName":"Reconnect Delay","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Delay in millis Camel will wait before performing a reconnect attempt."},"siteCommand":{"index":60,"kind":"parameter","displayName":"Site Command","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets optional site command(s) to be executed after successful login. Multiple site commands can be separated using a new line character."},"soTimeout":{"index":61,"kind":"parameter","displayName":"So Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"300000","configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance."},"stepwise":{"index":62,"kind":"parameter","displayName":"Stepwise","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets whether we should stepwise change directories while traversing file structures when downloading files, or as well when uploading a file to a directory. You can disable this if you for example are in a situation where you cannot change directory on the FTP server due security reasons. Stepwise cannot be used together with streamDownload."},"throwExceptionOnConnectFailed":{"index":63,"kind":"parameter","displayName":"Throw Exception On Connect Failed","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method."},"timeout":{"index":64,"kind":"parameter","displayName":"Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Sets the data timeout for waiting for reply Used only by FTPClient"},"antExclude":{"index":65,"kind":"parameter","displayName":"Ant Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format."},"antFilterCaseSensitive":{"index":66,"kind":"parameter","displayName":"Ant Filter Case Sensitive","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets case sensitive flag on ant filter."},"antInclude":{"index":67,"kind":"parameter","displayName":"Ant Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format."},"eagerMaxMessagesPerPoll":{"index":68,"kind":"parameter","displayName":"Eager Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting."},"exclude":{"index":69,"kind":"parameter","displayName":"Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"excludeExt":{"index":70,"kind":"parameter","displayName":"Exclude Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat files, use excludeExt=bak,dat. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"filter":{"index":71,"kind":"parameter","displayName":"Filter","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileFilter","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method."},"filterDirectory":{"index":72,"kind":"parameter","displayName":"Filter Directory","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}"},"filterFile":{"index":73,"kind":"parameter","displayName":"Filter File","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000"},"idempotent":{"index":74,"kind":"parameter","displayName":"Idempotent","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentEager":{"index":75,"kind":"parameter","displayName":"Idempotent Eager","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentKey":{"index":76,"kind":"parameter","displayName":"Idempotent Key","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}"},"idempotentRepository":{"index":77,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true."},"include":{"index":78,"kind":"parameter","displayName":"Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"includeExt":{"index":79,"kind":"parameter","displayName":"Include Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml files, use includeExt=txt,xml. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"maxDepth":{"index":80,"kind":"parameter","displayName":"Max Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"description":"The maximum depth to traverse when recursively processing a directory."},"maxMessagesPerPoll":{"index":81,"kind":"parameter","displayName":"Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards."},"minDepth":{"index":82,"kind":"parameter","displayName":"Min Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory."},"move":{"index":83,"kind":"parameter","displayName":"Move","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done."},"exclusiveReadLockStrategy":{"index":84,"kind":"parameter","displayName":"Exclusive Read Lock Strategy","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation."},"readLock":{"index":85,"kind":"parameter","displayName":"Read Lock","group":"lock","label":"consumer,lock","required":false,"type":"string","javaType":"java.lang.String","enum":["none","markerFile","fileLock","rename","changed","idempotent","idempotent-changed","idempotent-rename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: - none - No read lock is in use - markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component - changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. - fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. - rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. - idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that.Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan."},"readLockCheckInterval":{"index":86,"kind":"parameter","displayName":"Read Lock Check Interval","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"readLockDeleteOrphanLockFiles":{"index":87,"kind":"parameter","displayName":"Read Lock Delete Orphan Lock Files","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory."},"readLockLoggingLevel":{"index":88,"kind":"parameter","displayName":"Read Lock Logging Level","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename."},"readLockMarkerFile":{"index":89,"kind":"parameter","displayName":"Read Lock Marker File","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application."},"readLockMinAge":{"index":90,"kind":"parameter","displayName":"Read Lock Min Age","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age."},"readLockMinLength":{"index":91,"kind":"parameter","displayName":"Read Lock Min Length","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files."},"readLockRemoveOnCommit":{"index":92,"kind":"parameter","displayName":"Read Lock Remove On Commit","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option."},"readLockRemoveOnRollback":{"index":93,"kind":"parameter","displayName":"Read Lock Remove On Rollback","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit)."},"readLockTimeout":{"index":94,"kind":"parameter","displayName":"Read Lock Timeout","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"description":"Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"backoffErrorThreshold":{"index":95,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":96,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":97,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":98,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":99,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":100,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":101,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":102,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":103,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":104,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":105,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":106,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":107,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":108,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"account":{"index":109,"kind":"parameter","displayName":"Account","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Account to use for login"},"password":{"index":110,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Password to use for login"},"username":{"index":111,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.FtpConfiguration","configurationField":"configuration","description":"Username to use for login"},"shuffle":{"index":112,"kind":"parameter","displayName":"Shuffle","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To shuffle the list of files (sort in random order)"},"sortBy":{"index":113,"kind":"parameter","displayName":"Sort By","group":"sort","label":"consumer,sort","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date."},"sorter":{"index":114,"kind":"parameter","displayName":"Sorter","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"java.util.Comparator>","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable sorter as a java.util.Comparator class."}}} , -{"component":{"kind":"component","name":"ftps","title":"FTPS","description":"Upload and download files to/from FTP servers supporting the FTPS protocol.","deprecated":false,"firstVersion":"2.2.0","label":"file","javaType":"org.apache.camel.component.file.remote.FtpsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ftp","version":"4.8.1","scheme":"ftps","extendsScheme":"file","syntax":"ftps:host:port/directoryName","alternativeSyntax":"ftps:username:password@host:port/directoryName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelFileLength":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A long value containing the file size.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LENGTH"},"CamelFileLastModified":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Long value containing the last modified timestamp of the file.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LAST_MODIFIED"},"CamelFileName":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the output file name (relative to the endpoint directory) to be used for the output message when sending to the endpoint. If this is not present and no expression either, then a generated message ID is used as the filename instead.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_NAME"},"CamelFileNameOnly":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only the file name (the name with no leading paths).","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_NAME_ONLY"},"CamelFileParent":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent path.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_PARENT"},"CamelRemoteFileInputStream":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.io.InputStream","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote file input stream.","constantName":"org.apache.camel.component.file.remote.FtpConstants#REMOTE_FILE_INPUT_STREAM"},"CamelFileLocalWorkPath":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the local work file, if local work directory is used.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LOCAL_WORK_PATH"},"CamelFtpReplyCode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FTP client reply code","constantName":"org.apache.camel.component.file.remote.FtpConstants#FTP_REPLY_CODE"},"CamelFtpReplyString":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FTP client reply string","constantName":"org.apache.camel.component.file.remote.FtpConstants#FTP_REPLY_STRING"},"CamelFileHost":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote hostname.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_HOST"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Hostname of the FTP server"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Port of the FTP server"},"directoryName":{"index":2,"kind":"path","displayName":"Directory Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"The starting directory"},"binary":{"index":3,"kind":"parameter","displayName":"Binary","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false)."},"charset":{"index":4,"kind":"parameter","displayName":"Charset","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages."},"disconnect":{"index":5,"kind":"parameter","displayName":"Disconnect","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead."},"doneFileName":{"index":6,"kind":"parameter","displayName":"Done File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders."},"fileName":{"index":7,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."},"passiveMode":{"index":8,"kind":"parameter","displayName":"Passive Mode","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets passive mode connections. Default is active mode connections."},"separator":{"index":9,"kind":"parameter","displayName":"Separator","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator","enum":["UNIX","Windows","Auto"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"UNIX","configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name"},"transferLoggingIntervalSeconds":{"index":10,"kind":"parameter","displayName":"Transfer Logging Interval Seconds","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5,"description":"Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight. This is used for logging progress when operations take a longer time."},"transferLoggingLevel":{"index":11,"kind":"parameter","displayName":"Transfer Logging Level","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Configure the logging level to use when logging the progress of upload and download operations."},"transferLoggingVerbose":{"index":12,"kind":"parameter","displayName":"Transfer Logging Verbose","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configures whether perform verbose (fine-grained) logging of the progress of upload and download operations."},"fastExistsCheck":{"index":13,"kind":"parameter","displayName":"Fast Exists Check","group":"common (advanced)","label":"common,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set this option to be true, camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly, if the option is false, camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files."},"delete":{"index":14,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file will be deleted after it is processed successfully."},"moveFailed":{"index":15,"kind":"parameter","displayName":"Move Failed","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again."},"noop":{"index":16,"kind":"parameter","displayName":"Noop","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again."},"preMove":{"index":17,"kind":"parameter","displayName":"Pre Move","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order."},"preSort":{"index":18,"kind":"parameter","displayName":"Pre Sort","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled."},"recursive":{"index":19,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If a directory, will look for files in all the sub-directories as well."},"resumeDownload":{"index":20,"kind":"parameter","displayName":"Resume Download","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configures whether resume download is enabled. This must be supported by the FTP server (almost all FTP servers support it). In addition, the options localWorkDirectory must be configured so downloaded files are stored in a local directory, and the option binary must be enabled, which is required to support resuming of downloads."},"sendEmptyMessageWhenIdle":{"index":21,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"streamDownload":{"index":22,"kind":"parameter","displayName":"Stream Download","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets the download method to use when not using a local working directory. If set to true, the remote files are streamed to the route as they are read. When set to false, the remote files are loaded into memory before being sent into the route. If enabling this option then you must set stepwise=false as both cannot be enabled at the same time."},"bridgeErrorHandler":{"index":23,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"download":{"index":24,"kind":"parameter","displayName":"Download","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded."},"exceptionHandler":{"index":25,"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":{"index":26,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"handleDirectoryParserAbsoluteResult":{"index":27,"kind":"parameter","displayName":"Handle Directory Parser Absolute Result","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Allows you to set how the consumer will handle subfolders and files in the path if the directory parser results in with absolute paths. The reason for this is that some FTP servers may return file names with absolute paths, and if so, then the FTP component needs to handle this by converting the returned path into a relative path."},"ignoreFileNotFoundOrPermissionError":{"index":28,"kind":"parameter","displayName":"Ignore File Not Found Or Permission Error","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exist or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead."},"inProgressRepository":{"index":29,"kind":"parameter","displayName":"In Progress Repository","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."},"localWorkDirectory":{"index":30,"kind":"parameter","displayName":"Local Work Directory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory."},"onCompletionExceptionHandler":{"index":31,"kind":"parameter","displayName":"On Completion Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore."},"pollStrategy":{"index":32,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"processStrategy":{"index":33,"kind":"parameter","displayName":"Process Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileProcessStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply."},"useList":{"index":34,"kind":"parameter","displayName":"Use List","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Whether to allow using LIST command when downloading a file. Default is true. In some use cases you may want to download a specific file and are not allowed to use the LIST command, and therefore you can set this option to false. Notice when using this option, then the specific file to download does not include meta-data information such as file size, timestamp, permissions etc, because those information is only possible to retrieve when LIST command is in use."},"checksumFileAlgorithm":{"index":35,"kind":"parameter","displayName":"Checksum File Algorithm","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["MD2","MD5","SHA_1","SHA_224","SHA_256","SHA_384","SHA_512","SHA_512_224","SHA_512_256","SHA3_224","SHA3_256","SHA3_384","SHA3_512"],"deprecated":false,"autowired":false,"secret":false,"description":"If provided, then Camel will write a checksum file when the original file has been written. The checksum file will contain the checksum created with the provided algorithm for the original file. The checksum file will always be written in the same folder as the original file."},"fileExist":{"index":36,"kind":"parameter","displayName":"File Exist","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExist","enum":["Override","Append","Fail","Ignore","Move","TryRename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Override","description":"What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers."},"flatten":{"index":37,"kind":"parameter","displayName":"Flatten","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."},"jailStartingDirectory":{"index":38,"kind":"parameter","displayName":"Jail Starting Directory","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."},"moveExisting":{"index":39,"kind":"parameter","displayName":"Move Existing","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base."},"tempFileName":{"index":40,"kind":"parameter","displayName":"Temp File Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir."},"tempPrefix":{"index":41,"kind":"parameter","displayName":"Temp Prefix","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files."},"allowNullBody":{"index":42,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."},"chmod":{"index":43,"kind":"parameter","displayName":"Chmod","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Allows you to set chmod on the stored file. For example, chmod=640."},"disconnectOnBatchComplete":{"index":44,"kind":"parameter","displayName":"Disconnect On Batch Complete","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server."},"eagerDeleteTargetFile":{"index":45,"kind":"parameter","displayName":"Eager Delete Target File","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation."},"keepLastModified":{"index":46,"kind":"parameter","displayName":"Keep Last Modified","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers."},"lazyStartProducer":{"index":47,"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."},"moveExistingFileStrategy":{"index":48,"kind":"parameter","displayName":"Move Existing File Strategy","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.strategy.FileMoveExistingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"},"sendNoop":{"index":49,"kind":"parameter","displayName":"Send Noop","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Whether to send a noop command as a pre-write check before uploading files to the FTP server. This is enabled by default as a validation of the connection is still valid, which allows to silently re-connect to be able to upload the file. However if this causes problems, you can turn this option off."},"activePortRange":{"index":50,"kind":"parameter","displayName":"Active Port Range","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Set the client side port range in active mode. The syntax is: minPort-maxPort Both port numbers are inclusive, e.g., 10000-19999 to include all 1xxxx ports."},"autoCreate":{"index":51,"kind":"parameter","displayName":"Auto Create","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to."},"bufferSize":{"index":52,"kind":"parameter","displayName":"Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":131072,"description":"Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files)."},"connectTimeout":{"index":53,"kind":"parameter","displayName":"Connect Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH"},"ftpClient":{"index":54,"kind":"parameter","displayName":"Ftp Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.commons.net.ftp.FTPClient","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom instance of FTPClient"},"ftpClientConfig":{"index":55,"kind":"parameter","displayName":"Ftp Client Config","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.commons.net.ftp.FTPClientConfig","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use."},"ftpClientConfigParameters":{"index":56,"kind":"parameter","displayName":"Ftp Client Config Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"ftpClientConfig.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Used by FtpComponent to provide additional parameters for the FTPClientConfig"},"ftpClientParameters":{"index":57,"kind":"parameter","displayName":"Ftp Client Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"ftpClient.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Used by FtpComponent to provide additional parameters for the FTPClient"},"maximumReconnectAttempts":{"index":58,"kind":"parameter","displayName":"Maximum Reconnect Attempts","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior."},"reconnectDelay":{"index":59,"kind":"parameter","displayName":"Reconnect Delay","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Delay in millis Camel will wait before performing a reconnect attempt."},"siteCommand":{"index":60,"kind":"parameter","displayName":"Site Command","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets optional site command(s) to be executed after successful login. Multiple site commands can be separated using a new line character."},"soTimeout":{"index":61,"kind":"parameter","displayName":"So Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"300000","configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance."},"stepwise":{"index":62,"kind":"parameter","displayName":"Stepwise","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets whether we should stepwise change directories while traversing file structures when downloading files, or as well when uploading a file to a directory. You can disable this if you for example are in a situation where you cannot change directory on the FTP server due security reasons. Stepwise cannot be used together with streamDownload."},"throwExceptionOnConnectFailed":{"index":63,"kind":"parameter","displayName":"Throw Exception On Connect Failed","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method."},"timeout":{"index":64,"kind":"parameter","displayName":"Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets the data timeout for waiting for reply Used only by FTPClient"},"antExclude":{"index":65,"kind":"parameter","displayName":"Ant Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format."},"antFilterCaseSensitive":{"index":66,"kind":"parameter","displayName":"Ant Filter Case Sensitive","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets case sensitive flag on ant filter."},"antInclude":{"index":67,"kind":"parameter","displayName":"Ant Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format."},"eagerMaxMessagesPerPoll":{"index":68,"kind":"parameter","displayName":"Eager Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting."},"exclude":{"index":69,"kind":"parameter","displayName":"Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"excludeExt":{"index":70,"kind":"parameter","displayName":"Exclude Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat files, use excludeExt=bak,dat. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"filter":{"index":71,"kind":"parameter","displayName":"Filter","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileFilter","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method."},"filterDirectory":{"index":72,"kind":"parameter","displayName":"Filter Directory","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}"},"filterFile":{"index":73,"kind":"parameter","displayName":"Filter File","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000"},"idempotent":{"index":74,"kind":"parameter","displayName":"Idempotent","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentEager":{"index":75,"kind":"parameter","displayName":"Idempotent Eager","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentKey":{"index":76,"kind":"parameter","displayName":"Idempotent Key","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}"},"idempotentRepository":{"index":77,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true."},"include":{"index":78,"kind":"parameter","displayName":"Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"includeExt":{"index":79,"kind":"parameter","displayName":"Include Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml files, use includeExt=txt,xml. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"maxDepth":{"index":80,"kind":"parameter","displayName":"Max Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"description":"The maximum depth to traverse when recursively processing a directory."},"maxMessagesPerPoll":{"index":81,"kind":"parameter","displayName":"Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards."},"minDepth":{"index":82,"kind":"parameter","displayName":"Min Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory."},"move":{"index":83,"kind":"parameter","displayName":"Move","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done."},"exclusiveReadLockStrategy":{"index":84,"kind":"parameter","displayName":"Exclusive Read Lock Strategy","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation."},"readLock":{"index":85,"kind":"parameter","displayName":"Read Lock","group":"lock","label":"consumer,lock","required":false,"type":"string","javaType":"java.lang.String","enum":["none","markerFile","fileLock","rename","changed","idempotent","idempotent-changed","idempotent-rename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: - none - No read lock is in use - markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component - changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. - fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. - rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. - idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that.Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan."},"readLockCheckInterval":{"index":86,"kind":"parameter","displayName":"Read Lock Check Interval","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"readLockDeleteOrphanLockFiles":{"index":87,"kind":"parameter","displayName":"Read Lock Delete Orphan Lock Files","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory."},"readLockLoggingLevel":{"index":88,"kind":"parameter","displayName":"Read Lock Logging Level","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename."},"readLockMarkerFile":{"index":89,"kind":"parameter","displayName":"Read Lock Marker File","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application."},"readLockMinAge":{"index":90,"kind":"parameter","displayName":"Read Lock Min Age","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age."},"readLockMinLength":{"index":91,"kind":"parameter","displayName":"Read Lock Min Length","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files."},"readLockRemoveOnCommit":{"index":92,"kind":"parameter","displayName":"Read Lock Remove On Commit","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option."},"readLockRemoveOnRollback":{"index":93,"kind":"parameter","displayName":"Read Lock Remove On Rollback","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit)."},"readLockTimeout":{"index":94,"kind":"parameter","displayName":"Read Lock Timeout","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"description":"Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"backoffErrorThreshold":{"index":95,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":96,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":97,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":98,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":99,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":100,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":101,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":102,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":103,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":104,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":105,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":106,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":107,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":108,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"account":{"index":109,"kind":"parameter","displayName":"Account","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Account to use for login"},"disableSecureDataChannelDefaults":{"index":110,"kind":"parameter","displayName":"Disable Secure Data Channel Defaults","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Use this option to disable default options when using secure data channel. This allows you to be in full control what the execPbsz and execProt setting should be used. Default is false"},"execPbsz":{"index":111,"kind":"parameter","displayName":"Exec Pbsz","group":"security","label":"security","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"When using secure data channel you can set the exec protection buffer size"},"execProt":{"index":112,"kind":"parameter","displayName":"Exec Prot","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"The exec protection level PROT command. C - Clear S - Safe(SSL protocol only) E - Confidential(SSL protocol only) P - Private"},"ftpClientKeyStoreParameters":{"index":113,"kind":"parameter","displayName":"Ftp Client Key Store Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"java.util.Map","prefix":"ftpClient.keyStore.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Set the key store parameters"},"ftpClientTrustStoreParameters":{"index":114,"kind":"parameter","displayName":"Ftp Client Trust Store Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"java.util.Map","prefix":"ftpClient.trustStore.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Set the trust store parameters"},"implicit":{"index":115,"kind":"parameter","displayName":"Implicit","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Set the security mode (Implicit/Explicit). true - Implicit Mode / False - Explicit Mode"},"password":{"index":116,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Password to use for login"},"securityProtocol":{"index":117,"kind":"parameter","displayName":"Security Protocol","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"TLSv1.3","configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Set the underlying security protocol."},"sslContextParameters":{"index":118,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"Gets the JSSE configuration that overrides any settings in FtpsEndpoint#ftpClientKeyStoreParameters, ftpClientTrustStoreParameters, and FtpsConfiguration#getSecurityProtocol()."},"username":{"index":119,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Username to use for login"},"shuffle":{"index":120,"kind":"parameter","displayName":"Shuffle","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To shuffle the list of files (sort in random order)"},"sortBy":{"index":121,"kind":"parameter","displayName":"Sort By","group":"sort","label":"consumer,sort","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date."},"sorter":{"index":122,"kind":"parameter","displayName":"Sorter","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"java.util.Comparator>","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable sorter as a java.util.Comparator class."}}} +{"component":{"kind":"component","name":"ftps","title":"FTPS","description":"Upload and download files to/from FTP servers supporting the FTPS protocol.","deprecated":false,"firstVersion":"2.2.0","label":"file","javaType":"org.apache.camel.component.file.remote.FtpsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ftp","version":"4.8.2","scheme":"ftps","extendsScheme":"file","syntax":"ftps:host:port/directoryName","alternativeSyntax":"ftps:username:password@host:port/directoryName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelFileLength":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A long value containing the file size.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LENGTH"},"CamelFileLastModified":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Long value containing the last modified timestamp of the file.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LAST_MODIFIED"},"CamelFileName":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the output file name (relative to the endpoint directory) to be used for the output message when sending to the endpoint. If this is not present and no expression either, then a generated message ID is used as the filename instead.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_NAME"},"CamelFileNameOnly":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only the file name (the name with no leading paths).","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_NAME_ONLY"},"CamelFileParent":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent path.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_PARENT"},"CamelRemoteFileInputStream":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.io.InputStream","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote file input stream.","constantName":"org.apache.camel.component.file.remote.FtpConstants#REMOTE_FILE_INPUT_STREAM"},"CamelFileLocalWorkPath":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the local work file, if local work directory is used.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LOCAL_WORK_PATH"},"CamelFtpReplyCode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FTP client reply code","constantName":"org.apache.camel.component.file.remote.FtpConstants#FTP_REPLY_CODE"},"CamelFtpReplyString":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FTP client reply string","constantName":"org.apache.camel.component.file.remote.FtpConstants#FTP_REPLY_STRING"},"CamelFileHost":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote hostname.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_HOST"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Hostname of the FTP server"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Port of the FTP server"},"directoryName":{"index":2,"kind":"path","displayName":"Directory Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"The starting directory"},"binary":{"index":3,"kind":"parameter","displayName":"Binary","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false)."},"charset":{"index":4,"kind":"parameter","displayName":"Charset","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages."},"disconnect":{"index":5,"kind":"parameter","displayName":"Disconnect","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead."},"doneFileName":{"index":6,"kind":"parameter","displayName":"Done File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders."},"fileName":{"index":7,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."},"passiveMode":{"index":8,"kind":"parameter","displayName":"Passive Mode","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets passive mode connections. Default is active mode connections."},"separator":{"index":9,"kind":"parameter","displayName":"Separator","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator","enum":["UNIX","Windows","Auto"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"UNIX","configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name"},"transferLoggingIntervalSeconds":{"index":10,"kind":"parameter","displayName":"Transfer Logging Interval Seconds","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5,"description":"Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight. This is used for logging progress when operations take a longer time."},"transferLoggingLevel":{"index":11,"kind":"parameter","displayName":"Transfer Logging Level","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Configure the logging level to use when logging the progress of upload and download operations."},"transferLoggingVerbose":{"index":12,"kind":"parameter","displayName":"Transfer Logging Verbose","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configures whether perform verbose (fine-grained) logging of the progress of upload and download operations."},"fastExistsCheck":{"index":13,"kind":"parameter","displayName":"Fast Exists Check","group":"common (advanced)","label":"common,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set this option to be true, camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly, if the option is false, camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files."},"delete":{"index":14,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file will be deleted after it is processed successfully."},"moveFailed":{"index":15,"kind":"parameter","displayName":"Move Failed","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again."},"noop":{"index":16,"kind":"parameter","displayName":"Noop","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again."},"preMove":{"index":17,"kind":"parameter","displayName":"Pre Move","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order."},"preSort":{"index":18,"kind":"parameter","displayName":"Pre Sort","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled."},"recursive":{"index":19,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If a directory, will look for files in all the sub-directories as well."},"resumeDownload":{"index":20,"kind":"parameter","displayName":"Resume Download","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configures whether resume download is enabled. This must be supported by the FTP server (almost all FTP servers support it). In addition, the options localWorkDirectory must be configured so downloaded files are stored in a local directory, and the option binary must be enabled, which is required to support resuming of downloads."},"sendEmptyMessageWhenIdle":{"index":21,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"streamDownload":{"index":22,"kind":"parameter","displayName":"Stream Download","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets the download method to use when not using a local working directory. If set to true, the remote files are streamed to the route as they are read. When set to false, the remote files are loaded into memory before being sent into the route. If enabling this option then you must set stepwise=false as both cannot be enabled at the same time."},"bridgeErrorHandler":{"index":23,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"download":{"index":24,"kind":"parameter","displayName":"Download","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded."},"exceptionHandler":{"index":25,"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":{"index":26,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"handleDirectoryParserAbsoluteResult":{"index":27,"kind":"parameter","displayName":"Handle Directory Parser Absolute Result","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Allows you to set how the consumer will handle subfolders and files in the path if the directory parser results in with absolute paths. The reason for this is that some FTP servers may return file names with absolute paths, and if so, then the FTP component needs to handle this by converting the returned path into a relative path."},"ignoreFileNotFoundOrPermissionError":{"index":28,"kind":"parameter","displayName":"Ignore File Not Found Or Permission Error","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exist or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead."},"inProgressRepository":{"index":29,"kind":"parameter","displayName":"In Progress Repository","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."},"localWorkDirectory":{"index":30,"kind":"parameter","displayName":"Local Work Directory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory."},"onCompletionExceptionHandler":{"index":31,"kind":"parameter","displayName":"On Completion Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore."},"pollStrategy":{"index":32,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"processStrategy":{"index":33,"kind":"parameter","displayName":"Process Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileProcessStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply."},"useList":{"index":34,"kind":"parameter","displayName":"Use List","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Whether to allow using LIST command when downloading a file. Default is true. In some use cases you may want to download a specific file and are not allowed to use the LIST command, and therefore you can set this option to false. Notice when using this option, then the specific file to download does not include meta-data information such as file size, timestamp, permissions etc, because those information is only possible to retrieve when LIST command is in use."},"checksumFileAlgorithm":{"index":35,"kind":"parameter","displayName":"Checksum File Algorithm","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["MD2","MD5","SHA_1","SHA_224","SHA_256","SHA_384","SHA_512","SHA_512_224","SHA_512_256","SHA3_224","SHA3_256","SHA3_384","SHA3_512"],"deprecated":false,"autowired":false,"secret":false,"description":"If provided, then Camel will write a checksum file when the original file has been written. The checksum file will contain the checksum created with the provided algorithm for the original file. The checksum file will always be written in the same folder as the original file."},"fileExist":{"index":36,"kind":"parameter","displayName":"File Exist","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExist","enum":["Override","Append","Fail","Ignore","Move","TryRename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Override","description":"What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers."},"flatten":{"index":37,"kind":"parameter","displayName":"Flatten","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."},"jailStartingDirectory":{"index":38,"kind":"parameter","displayName":"Jail Starting Directory","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."},"moveExisting":{"index":39,"kind":"parameter","displayName":"Move Existing","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base."},"tempFileName":{"index":40,"kind":"parameter","displayName":"Temp File Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir."},"tempPrefix":{"index":41,"kind":"parameter","displayName":"Temp Prefix","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files."},"allowNullBody":{"index":42,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."},"chmod":{"index":43,"kind":"parameter","displayName":"Chmod","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Allows you to set chmod on the stored file. For example, chmod=640."},"disconnectOnBatchComplete":{"index":44,"kind":"parameter","displayName":"Disconnect On Batch Complete","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server."},"eagerDeleteTargetFile":{"index":45,"kind":"parameter","displayName":"Eager Delete Target File","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation."},"keepLastModified":{"index":46,"kind":"parameter","displayName":"Keep Last Modified","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers."},"lazyStartProducer":{"index":47,"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."},"moveExistingFileStrategy":{"index":48,"kind":"parameter","displayName":"Move Existing File Strategy","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.strategy.FileMoveExistingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"},"sendNoop":{"index":49,"kind":"parameter","displayName":"Send Noop","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Whether to send a noop command as a pre-write check before uploading files to the FTP server. This is enabled by default as a validation of the connection is still valid, which allows to silently re-connect to be able to upload the file. However if this causes problems, you can turn this option off."},"activePortRange":{"index":50,"kind":"parameter","displayName":"Active Port Range","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Set the client side port range in active mode. The syntax is: minPort-maxPort Both port numbers are inclusive, e.g., 10000-19999 to include all 1xxxx ports."},"autoCreate":{"index":51,"kind":"parameter","displayName":"Auto Create","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to."},"bufferSize":{"index":52,"kind":"parameter","displayName":"Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":131072,"description":"Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files)."},"connectTimeout":{"index":53,"kind":"parameter","displayName":"Connect Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH"},"ftpClient":{"index":54,"kind":"parameter","displayName":"Ftp Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.commons.net.ftp.FTPClient","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom instance of FTPClient"},"ftpClientConfig":{"index":55,"kind":"parameter","displayName":"Ftp Client Config","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.commons.net.ftp.FTPClientConfig","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use."},"ftpClientConfigParameters":{"index":56,"kind":"parameter","displayName":"Ftp Client Config Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"ftpClientConfig.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Used by FtpComponent to provide additional parameters for the FTPClientConfig"},"ftpClientParameters":{"index":57,"kind":"parameter","displayName":"Ftp Client Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"ftpClient.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Used by FtpComponent to provide additional parameters for the FTPClient"},"maximumReconnectAttempts":{"index":58,"kind":"parameter","displayName":"Maximum Reconnect Attempts","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior."},"reconnectDelay":{"index":59,"kind":"parameter","displayName":"Reconnect Delay","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Delay in millis Camel will wait before performing a reconnect attempt."},"siteCommand":{"index":60,"kind":"parameter","displayName":"Site Command","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets optional site command(s) to be executed after successful login. Multiple site commands can be separated using a new line character."},"soTimeout":{"index":61,"kind":"parameter","displayName":"So Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"300000","configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance."},"stepwise":{"index":62,"kind":"parameter","displayName":"Stepwise","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets whether we should stepwise change directories while traversing file structures when downloading files, or as well when uploading a file to a directory. You can disable this if you for example are in a situation where you cannot change directory on the FTP server due security reasons. Stepwise cannot be used together with streamDownload."},"throwExceptionOnConnectFailed":{"index":63,"kind":"parameter","displayName":"Throw Exception On Connect Failed","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method."},"timeout":{"index":64,"kind":"parameter","displayName":"Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Sets the data timeout for waiting for reply Used only by FTPClient"},"antExclude":{"index":65,"kind":"parameter","displayName":"Ant Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format."},"antFilterCaseSensitive":{"index":66,"kind":"parameter","displayName":"Ant Filter Case Sensitive","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets case sensitive flag on ant filter."},"antInclude":{"index":67,"kind":"parameter","displayName":"Ant Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format."},"eagerMaxMessagesPerPoll":{"index":68,"kind":"parameter","displayName":"Eager Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting."},"exclude":{"index":69,"kind":"parameter","displayName":"Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"excludeExt":{"index":70,"kind":"parameter","displayName":"Exclude Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat files, use excludeExt=bak,dat. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"filter":{"index":71,"kind":"parameter","displayName":"Filter","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileFilter","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method."},"filterDirectory":{"index":72,"kind":"parameter","displayName":"Filter Directory","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}"},"filterFile":{"index":73,"kind":"parameter","displayName":"Filter File","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000"},"idempotent":{"index":74,"kind":"parameter","displayName":"Idempotent","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentEager":{"index":75,"kind":"parameter","displayName":"Idempotent Eager","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentKey":{"index":76,"kind":"parameter","displayName":"Idempotent Key","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}"},"idempotentRepository":{"index":77,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true."},"include":{"index":78,"kind":"parameter","displayName":"Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"includeExt":{"index":79,"kind":"parameter","displayName":"Include Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml files, use includeExt=txt,xml. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"maxDepth":{"index":80,"kind":"parameter","displayName":"Max Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"description":"The maximum depth to traverse when recursively processing a directory."},"maxMessagesPerPoll":{"index":81,"kind":"parameter","displayName":"Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards."},"minDepth":{"index":82,"kind":"parameter","displayName":"Min Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory."},"move":{"index":83,"kind":"parameter","displayName":"Move","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done."},"exclusiveReadLockStrategy":{"index":84,"kind":"parameter","displayName":"Exclusive Read Lock Strategy","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation."},"readLock":{"index":85,"kind":"parameter","displayName":"Read Lock","group":"lock","label":"consumer,lock","required":false,"type":"string","javaType":"java.lang.String","enum":["none","markerFile","fileLock","rename","changed","idempotent","idempotent-changed","idempotent-rename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: - none - No read lock is in use - markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component - changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. - fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. - rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. - idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that.Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan."},"readLockCheckInterval":{"index":86,"kind":"parameter","displayName":"Read Lock Check Interval","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"readLockDeleteOrphanLockFiles":{"index":87,"kind":"parameter","displayName":"Read Lock Delete Orphan Lock Files","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory."},"readLockLoggingLevel":{"index":88,"kind":"parameter","displayName":"Read Lock Logging Level","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename."},"readLockMarkerFile":{"index":89,"kind":"parameter","displayName":"Read Lock Marker File","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application."},"readLockMinAge":{"index":90,"kind":"parameter","displayName":"Read Lock Min Age","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age."},"readLockMinLength":{"index":91,"kind":"parameter","displayName":"Read Lock Min Length","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files."},"readLockRemoveOnCommit":{"index":92,"kind":"parameter","displayName":"Read Lock Remove On Commit","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option."},"readLockRemoveOnRollback":{"index":93,"kind":"parameter","displayName":"Read Lock Remove On Rollback","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit)."},"readLockTimeout":{"index":94,"kind":"parameter","displayName":"Read Lock Timeout","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"description":"Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"backoffErrorThreshold":{"index":95,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":96,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":97,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":98,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":99,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":100,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":101,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":102,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":103,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":104,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":105,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":106,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":107,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":108,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"account":{"index":109,"kind":"parameter","displayName":"Account","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Account to use for login"},"disableSecureDataChannelDefaults":{"index":110,"kind":"parameter","displayName":"Disable Secure Data Channel Defaults","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Use this option to disable default options when using secure data channel. This allows you to be in full control what the execPbsz and execProt setting should be used. Default is false"},"execPbsz":{"index":111,"kind":"parameter","displayName":"Exec Pbsz","group":"security","label":"security","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"When using secure data channel you can set the exec protection buffer size"},"execProt":{"index":112,"kind":"parameter","displayName":"Exec Prot","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"The exec protection level PROT command. C - Clear S - Safe(SSL protocol only) E - Confidential(SSL protocol only) P - Private"},"ftpClientKeyStoreParameters":{"index":113,"kind":"parameter","displayName":"Ftp Client Key Store Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"java.util.Map","prefix":"ftpClient.keyStore.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Set the key store parameters"},"ftpClientTrustStoreParameters":{"index":114,"kind":"parameter","displayName":"Ftp Client Trust Store Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"java.util.Map","prefix":"ftpClient.trustStore.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Set the trust store parameters"},"implicit":{"index":115,"kind":"parameter","displayName":"Implicit","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Set the security mode (Implicit/Explicit). true - Implicit Mode / False - Explicit Mode"},"password":{"index":116,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Password to use for login"},"securityProtocol":{"index":117,"kind":"parameter","displayName":"Security Protocol","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"TLSv1.3","configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Set the underlying security protocol."},"sslContextParameters":{"index":118,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"Gets the JSSE configuration that overrides any settings in FtpsEndpoint#ftpClientKeyStoreParameters, ftpClientTrustStoreParameters, and FtpsConfiguration#getSecurityProtocol()."},"username":{"index":119,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.FtpsConfiguration","configurationField":"configuration","description":"Username to use for login"},"shuffle":{"index":120,"kind":"parameter","displayName":"Shuffle","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To shuffle the list of files (sort in random order)"},"sortBy":{"index":121,"kind":"parameter","displayName":"Sort By","group":"sort","label":"consumer,sort","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date."},"sorter":{"index":122,"kind":"parameter","displayName":"Sorter","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"java.util.Comparator>","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable sorter as a java.util.Comparator class."}}} , -{"component":{"kind":"component","name":"geocoder","title":"Geocoder","description":"Find geocodes (latitude and longitude) for a given address or the other way round.","deprecated":false,"firstVersion":"2.12.0","label":"api,search","javaType":"org.apache.camel.component.geocoder.GeoCoderComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-geocoder","version":"4.8.1","scheme":"geocoder","extendsScheme":"","syntax":"geocoder:address:latlng","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelGeoCoderAddress":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The formatted address","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#ADDRESS"},"CamelGeoCoderLatlng":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The latitude and longitude of the location. Separated by comma.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#LATLNG"},"CamelGeoCoderLat":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The latitude of the location.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#LAT"},"CamelGeoCoderLng":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The longitude of the location.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#LNG"},"CamelGeoCoderStatus":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":true,"javaType":"org.apache.camel.component.geocoder.GeocoderStatus","enum":["ERROR","INVALID_REQUEST","ACCESS_NOT_CONFIGURED","OK","OVER_QUERY_LIMIT","OVER_DAILY_LIMIT","REQUEST_DENIED","UNKNOWN_ERROR","ZERO_RESULTS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Status code from the geocoder library. If status is GeocoderStatus.OK then additional headers is enriched","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#STATUS"},"CamelGeoCoderRegionCode":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The region code.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#REGION_CODE"},"CamelGeoCoderRegionName":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The region name.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#REGION_NAME"},"CamelGeoCoderCity":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The city long name.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#CITY"},"CamelGeoCoderCountryLong":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The country long name.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#COUNTRY_LONG"},"CamelGeoCoderCountryShort":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The country short name.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#COUNTRY_SHORT"},"CamelGeoCoderPostalCode":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The postal code.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#POSTAL_CODE"}},"properties":{"address":{"index":0,"kind":"path","displayName":"Address","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The geo address which should be prefixed with address:"},"latlng":{"index":1,"kind":"path","displayName":"Latlng","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The geo latitude and longitude which should be prefixed with latlng:"},"headersOnly":{"index":2,"kind":"parameter","displayName":"Headers Only","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to only enrich the Exchange with headers, and leave the body as-is."},"language":{"index":3,"kind":"parameter","displayName":"Language","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"en","description":"The language to use."},"serverUrl":{"index":4,"kind":"parameter","displayName":"Server URL","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"URL to the geocoder server. Mandatory for Nominatim server."},"type":{"index":5,"kind":"parameter","displayName":"GeoCoding Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.geocoder.GeoCoderType","enum":["NOMINATIM","GOOGLE"],"deprecated":false,"autowired":false,"secret":false,"description":"Type of GeoCoding server. Supported Nominatim and Google."},"lazyStartProducer":{"index":6,"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."},"proxyAuthDomain":{"index":7,"kind":"parameter","displayName":"Proxy Auth Domain","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy Authentication Domain to access Google GeoCoding server."},"proxyAuthHost":{"index":8,"kind":"parameter","displayName":"Proxy Auth Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy Authentication Host to access Google GeoCoding server."},"proxyAuthMethod":{"index":9,"kind":"parameter","displayName":"Proxy Auth Method","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication Method to Google GeoCoding server."},"proxyAuthPassword":{"index":10,"kind":"parameter","displayName":"Proxy Auth Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy Password to access GeoCoding server."},"proxyAuthUsername":{"index":11,"kind":"parameter","displayName":"Proxy Auth Username","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy Username to access GeoCoding server."},"proxyHost":{"index":12,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy Host to access GeoCoding server."},"proxyPort":{"index":13,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"Proxy Port to access GeoCoding server."},"apiKey":{"index":14,"kind":"parameter","displayName":"Api Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"API Key to access Google. Mandatory for Google GeoCoding server."},"clientId":{"index":15,"kind":"parameter","displayName":"Client Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Client ID to access Google GeoCoding server."},"clientKey":{"index":16,"kind":"parameter","displayName":"Client Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Client Key to access Google GeoCoding server."}}} +{"component":{"kind":"component","name":"geocoder","title":"Geocoder","description":"Find geocodes (latitude and longitude) for a given address or the other way round.","deprecated":false,"firstVersion":"2.12.0","label":"api,search","javaType":"org.apache.camel.component.geocoder.GeoCoderComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-geocoder","version":"4.8.2","scheme":"geocoder","extendsScheme":"","syntax":"geocoder:address:latlng","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelGeoCoderAddress":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The formatted address","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#ADDRESS"},"CamelGeoCoderLatlng":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The latitude and longitude of the location. Separated by comma.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#LATLNG"},"CamelGeoCoderLat":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The latitude of the location.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#LAT"},"CamelGeoCoderLng":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The longitude of the location.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#LNG"},"CamelGeoCoderStatus":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":true,"javaType":"org.apache.camel.component.geocoder.GeocoderStatus","enum":["ERROR","INVALID_REQUEST","ACCESS_NOT_CONFIGURED","OK","OVER_QUERY_LIMIT","OVER_DAILY_LIMIT","REQUEST_DENIED","UNKNOWN_ERROR","ZERO_RESULTS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Status code from the geocoder library. If status is GeocoderStatus.OK then additional headers is enriched","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#STATUS"},"CamelGeoCoderRegionCode":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The region code.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#REGION_CODE"},"CamelGeoCoderRegionName":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The region name.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#REGION_NAME"},"CamelGeoCoderCity":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The city long name.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#CITY"},"CamelGeoCoderCountryLong":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The country long name.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#COUNTRY_LONG"},"CamelGeoCoderCountryShort":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The country short name.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#COUNTRY_SHORT"},"CamelGeoCoderPostalCode":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The postal code.","constantName":"org.apache.camel.component.geocoder.GeoCoderConstants#POSTAL_CODE"}},"properties":{"address":{"index":0,"kind":"path","displayName":"Address","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The geo address which should be prefixed with address:"},"latlng":{"index":1,"kind":"path","displayName":"Latlng","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The geo latitude and longitude which should be prefixed with latlng:"},"headersOnly":{"index":2,"kind":"parameter","displayName":"Headers Only","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to only enrich the Exchange with headers, and leave the body as-is."},"language":{"index":3,"kind":"parameter","displayName":"Language","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"en","description":"The language to use."},"serverUrl":{"index":4,"kind":"parameter","displayName":"Server URL","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"URL to the geocoder server. Mandatory for Nominatim server."},"type":{"index":5,"kind":"parameter","displayName":"GeoCoding Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.geocoder.GeoCoderType","enum":["NOMINATIM","GOOGLE"],"deprecated":false,"autowired":false,"secret":false,"description":"Type of GeoCoding server. Supported Nominatim and Google."},"lazyStartProducer":{"index":6,"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."},"proxyAuthDomain":{"index":7,"kind":"parameter","displayName":"Proxy Auth Domain","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy Authentication Domain to access Google GeoCoding server."},"proxyAuthHost":{"index":8,"kind":"parameter","displayName":"Proxy Auth Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy Authentication Host to access Google GeoCoding server."},"proxyAuthMethod":{"index":9,"kind":"parameter","displayName":"Proxy Auth Method","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication Method to Google GeoCoding server."},"proxyAuthPassword":{"index":10,"kind":"parameter","displayName":"Proxy Auth Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy Password to access GeoCoding server."},"proxyAuthUsername":{"index":11,"kind":"parameter","displayName":"Proxy Auth Username","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy Username to access GeoCoding server."},"proxyHost":{"index":12,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy Host to access GeoCoding server."},"proxyPort":{"index":13,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"Proxy Port to access GeoCoding server."},"apiKey":{"index":14,"kind":"parameter","displayName":"Api Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"API Key to access Google. Mandatory for Google GeoCoding server."},"clientId":{"index":15,"kind":"parameter","displayName":"Client Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Client ID to access Google GeoCoding server."},"clientKey":{"index":16,"kind":"parameter","displayName":"Client Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Client Key to access Google GeoCoding server."}}} , -{"component":{"kind":"component","name":"git","title":"Git","description":"Perform operations on git repositories.","deprecated":false,"firstVersion":"2.16.0","label":"file","javaType":"org.apache.camel.component.git.GitComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-git","version":"4.8.1","scheme":"git","extendsScheme":"","syntax":"git:localPath","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelGitOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to do on a repository, if not specified as endpoint option","constantName":"org.apache.camel.component.git.GitConstants#GIT_OPERATION"},"CamelGitFilename":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The file name in an add operation","constantName":"org.apache.camel.component.git.GitConstants#GIT_FILE_NAME"},"CamelGitCommitMessage":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit message related in a commit operation","constantName":"org.apache.camel.component.git.GitConstants#GIT_COMMIT_MESSAGE"},"CamelGitCommitUsername":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit username in a commit operation","constantName":"org.apache.camel.component.git.GitConstants#GIT_COMMIT_USERNAME"},"CamelGitCommitEmail":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit email in a commit operation","constantName":"org.apache.camel.component.git.GitConstants#GIT_COMMIT_EMAIL"},"CamelGitCommitId":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit id","constantName":"org.apache.camel.component.git.GitConstants#GIT_COMMIT_ID"},"CamelGitAllowEmpty":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag to manage empty git commits","constantName":"org.apache.camel.component.git.GitConstants#GIT_ALLOW_EMPTY"},"CamelGitAuthorName":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The author name","constantName":"org.apache.camel.component.git.GitConstants#GIT_COMMIT_AUTHOR_NAME"},"CamelGitCommiterName":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The committer name","constantName":"org.apache.camel.component.git.GitConstants#GIT_COMMIT_COMMITTER_NAME"},"CamelGitCommitTime":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit time","constantName":"org.apache.camel.component.git.GitConstants#GIT_COMMIT_TIME"},"CamelGitBranchLeaf":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The leaf","constantName":"org.apache.camel.component.git.GitConstants#GIT_BRANCH_LEAF"},"CamelGitBranchObjectId":{"index":11,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object id","constantName":"org.apache.camel.component.git.GitConstants#GIT_BRANCH_OBJECT_ID"}},"properties":{"localPath":{"index":0,"kind":"path","displayName":"Local Path","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Local repository path"},"branchName":{"index":1,"kind":"parameter","displayName":"Branch Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The branch name to work on"},"type":{"index":2,"kind":"parameter","displayName":"Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.git.consumer.GitType","enum":["commit","tag","branch"],"deprecated":false,"autowired":false,"secret":false,"description":"The consumer type"},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"allowEmpty":{"index":6,"kind":"parameter","displayName":"Allow Empty","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"description":"The flag to manage empty git commits"},"operation":{"index":7,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["clone","init","add","remove","commit","commitAll","createBranch","deleteBranch","createTag","deleteTag","status","log","push","pull","showBranches","cherryPick","remoteAdd","remoteList"],"deprecated":false,"autowired":false,"secret":false,"description":"The operation to do on the repository"},"password":{"index":8,"kind":"parameter","displayName":"Password","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Remote repository password"},"remoteName":{"index":9,"kind":"parameter","displayName":"Remote Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The remote repository name to use in particular operation like pull"},"remotePath":{"index":10,"kind":"parameter","displayName":"Remote Path","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The remote repository path"},"tagName":{"index":11,"kind":"parameter","displayName":"Tag Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The tag name to work on"},"targetBranchName":{"index":12,"kind":"parameter","displayName":"Target Branch Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"master","description":"Name of target branch in merge operation. If not supplied will try to use init.defaultBranch git configs. If not configured will use default value"},"username":{"index":13,"kind":"parameter","displayName":"Username","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Remote repository username"},"lazyStartProducer":{"index":14,"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."},"gitConfigFile":{"index":15,"kind":"parameter","displayName":"Git Config File","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"A String with path to a .gitconfig file"}}} +{"component":{"kind":"component","name":"git","title":"Git","description":"Perform operations on git repositories.","deprecated":false,"firstVersion":"2.16.0","label":"file","javaType":"org.apache.camel.component.git.GitComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-git","version":"4.8.2","scheme":"git","extendsScheme":"","syntax":"git:localPath","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelGitOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to do on a repository, if not specified as endpoint option","constantName":"org.apache.camel.component.git.GitConstants#GIT_OPERATION"},"CamelGitFilename":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The file name in an add operation","constantName":"org.apache.camel.component.git.GitConstants#GIT_FILE_NAME"},"CamelGitCommitMessage":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit message related in a commit operation","constantName":"org.apache.camel.component.git.GitConstants#GIT_COMMIT_MESSAGE"},"CamelGitCommitUsername":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit username in a commit operation","constantName":"org.apache.camel.component.git.GitConstants#GIT_COMMIT_USERNAME"},"CamelGitCommitEmail":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit email in a commit operation","constantName":"org.apache.camel.component.git.GitConstants#GIT_COMMIT_EMAIL"},"CamelGitCommitId":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit id","constantName":"org.apache.camel.component.git.GitConstants#GIT_COMMIT_ID"},"CamelGitAllowEmpty":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag to manage empty git commits","constantName":"org.apache.camel.component.git.GitConstants#GIT_ALLOW_EMPTY"},"CamelGitAuthorName":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The author name","constantName":"org.apache.camel.component.git.GitConstants#GIT_COMMIT_AUTHOR_NAME"},"CamelGitCommiterName":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The committer name","constantName":"org.apache.camel.component.git.GitConstants#GIT_COMMIT_COMMITTER_NAME"},"CamelGitCommitTime":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit time","constantName":"org.apache.camel.component.git.GitConstants#GIT_COMMIT_TIME"},"CamelGitBranchLeaf":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The leaf","constantName":"org.apache.camel.component.git.GitConstants#GIT_BRANCH_LEAF"},"CamelGitBranchObjectId":{"index":11,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object id","constantName":"org.apache.camel.component.git.GitConstants#GIT_BRANCH_OBJECT_ID"}},"properties":{"localPath":{"index":0,"kind":"path","displayName":"Local Path","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Local repository path"},"branchName":{"index":1,"kind":"parameter","displayName":"Branch Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The branch name to work on"},"type":{"index":2,"kind":"parameter","displayName":"Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.git.consumer.GitType","enum":["commit","tag","branch"],"deprecated":false,"autowired":false,"secret":false,"description":"The consumer type"},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"allowEmpty":{"index":6,"kind":"parameter","displayName":"Allow Empty","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"description":"The flag to manage empty git commits"},"operation":{"index":7,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["clone","init","add","remove","commit","commitAll","createBranch","deleteBranch","createTag","deleteTag","status","log","push","pull","showBranches","cherryPick","remoteAdd","remoteList"],"deprecated":false,"autowired":false,"secret":false,"description":"The operation to do on the repository"},"password":{"index":8,"kind":"parameter","displayName":"Password","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Remote repository password"},"remoteName":{"index":9,"kind":"parameter","displayName":"Remote Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The remote repository name to use in particular operation like pull"},"remotePath":{"index":10,"kind":"parameter","displayName":"Remote Path","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The remote repository path"},"tagName":{"index":11,"kind":"parameter","displayName":"Tag Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The tag name to work on"},"targetBranchName":{"index":12,"kind":"parameter","displayName":"Target Branch Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"master","description":"Name of target branch in merge operation. If not supplied will try to use init.defaultBranch git configs. If not configured will use default value"},"username":{"index":13,"kind":"parameter","displayName":"Username","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Remote repository username"},"lazyStartProducer":{"index":14,"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."},"gitConfigFile":{"index":15,"kind":"parameter","displayName":"Git Config File","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"A String with path to a .gitconfig file"}}} , -{"component":{"kind":"component","name":"github","title":"GitHub","description":"Interact with the GitHub API.","deprecated":false,"firstVersion":"2.15.0","label":"file,cloud,api","javaType":"org.apache.camel.component.github.GitHubComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-github","version":"4.8.1","scheme":"github","extendsScheme":"","syntax":"github:type/branchName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"GitHubPullRequest":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"PullRequest or Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The pull request","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_PULLREQUEST"},"GitHubInResponseTo":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the comment to reply to","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_INRESPONSETO"},"GitHubPullRequestHeadCommitSHA":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sha of the head of the pull request","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_PULLREQUEST_HEAD_COMMIT_SHA"},"GitHubIssueTitle":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The title of the issue","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_ISSUE_TITLE"},"CamelGitHubCommitAuthor":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit author","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_COMMIT_AUTHOR"},"CamelGitHubCommitCommitter":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The committer name","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_COMMIT_COMMITTER"},"CamelGitHubCommitSha":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit sha","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_COMMIT_SHA"},"CamelGitHubCommitUrl":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit URL","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_COMMIT_URL"},"CamelGitHubEventPayload":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.eclipse.egit.github.core.event.EventPayload","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event payload","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_EVENT_PAYLOAD"}},"properties":{"type":{"index":0,"kind":"path","displayName":"Type","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.github.GitHubType","enum":["CLOSEPULLREQUEST","PULLREQUESTCOMMENT","COMMIT","PULLREQUEST","TAG","PULLREQUESTSTATE","PULLREQUESTFILES","GETCOMMITFILE","CREATEISSUE","EVENT"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"What git operation to execute"},"branchName":{"index":1,"kind":"path","displayName":"Branch Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Name of branch"},"repoName":{"index":2,"kind":"parameter","displayName":"Repo Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"GitHub repository name"},"repoOwner":{"index":3,"kind":"parameter","displayName":"Repo Owner","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"GitHub repository owner (organization)"},"sendEmptyMessageWhenIdle":{"index":4,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"startingSha":{"index":5,"kind":"parameter","displayName":"Starting Sha","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"last","description":"The starting sha to use for polling commits with the commit consumer. The value can either be a sha for the sha to start from, or use beginning to start from the beginning, or last to start from the last commit."},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"eventFetchStrategy":{"index":7,"kind":"parameter","displayName":"Event Fetch Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.github.event.GitHubEventFetchStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To specify a custom strategy that configures how the EventsConsumer fetches events."},"exceptionHandler":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":10,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"encoding":{"index":11,"kind":"parameter","displayName":"Encoding","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use the given encoding when getting a git commit file"},"state":{"index":12,"kind":"parameter","displayName":"State","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["error","failure","pending","success"],"deprecated":false,"autowired":false,"secret":false,"description":"To set git commit status state"},"targetUrl":{"index":13,"kind":"parameter","displayName":"Target Url","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To set git commit status target url"},"lazyStartProducer":{"index":14,"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."},"backoffErrorThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":17,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":18,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":19,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":20,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":21,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":22,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":23,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":24,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":25,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":26,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":27,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":28,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"oauthToken":{"index":29,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"GitHub OAuth token. Must be configured on either component or endpoint."}}} +{"component":{"kind":"component","name":"github","title":"GitHub","description":"Interact with the GitHub API.","deprecated":false,"firstVersion":"2.15.0","label":"file,cloud,api","javaType":"org.apache.camel.component.github.GitHubComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-github","version":"4.8.2","scheme":"github","extendsScheme":"","syntax":"github:type/branchName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"GitHubPullRequest":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"PullRequest or Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The pull request","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_PULLREQUEST"},"GitHubInResponseTo":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the comment to reply to","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_INRESPONSETO"},"GitHubPullRequestHeadCommitSHA":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sha of the head of the pull request","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_PULLREQUEST_HEAD_COMMIT_SHA"},"GitHubIssueTitle":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The title of the issue","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_ISSUE_TITLE"},"CamelGitHubCommitAuthor":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit author","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_COMMIT_AUTHOR"},"CamelGitHubCommitCommitter":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The committer name","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_COMMIT_COMMITTER"},"CamelGitHubCommitSha":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit sha","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_COMMIT_SHA"},"CamelGitHubCommitUrl":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit URL","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_COMMIT_URL"},"CamelGitHubEventPayload":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.eclipse.egit.github.core.event.EventPayload","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event payload","constantName":"org.apache.camel.component.github.GitHubConstants#GITHUB_EVENT_PAYLOAD"}},"properties":{"type":{"index":0,"kind":"path","displayName":"Type","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.github.GitHubType","enum":["CLOSEPULLREQUEST","PULLREQUESTCOMMENT","COMMIT","PULLREQUEST","TAG","PULLREQUESTSTATE","PULLREQUESTFILES","GETCOMMITFILE","CREATEISSUE","EVENT"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"What git operation to execute"},"branchName":{"index":1,"kind":"path","displayName":"Branch Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Name of branch"},"repoName":{"index":2,"kind":"parameter","displayName":"Repo Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"GitHub repository name"},"repoOwner":{"index":3,"kind":"parameter","displayName":"Repo Owner","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"GitHub repository owner (organization)"},"sendEmptyMessageWhenIdle":{"index":4,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"startingSha":{"index":5,"kind":"parameter","displayName":"Starting Sha","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"last","description":"The starting sha to use for polling commits with the commit consumer. The value can either be a sha for the sha to start from, or use beginning to start from the beginning, or last to start from the last commit."},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"eventFetchStrategy":{"index":7,"kind":"parameter","displayName":"Event Fetch Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.github.event.GitHubEventFetchStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To specify a custom strategy that configures how the EventsConsumer fetches events."},"exceptionHandler":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":10,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"encoding":{"index":11,"kind":"parameter","displayName":"Encoding","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use the given encoding when getting a git commit file"},"state":{"index":12,"kind":"parameter","displayName":"State","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["error","failure","pending","success"],"deprecated":false,"autowired":false,"secret":false,"description":"To set git commit status state"},"targetUrl":{"index":13,"kind":"parameter","displayName":"Target Url","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To set git commit status target url"},"lazyStartProducer":{"index":14,"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."},"backoffErrorThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":17,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":18,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":19,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":20,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":21,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":22,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":23,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":24,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":25,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":26,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":27,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":28,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"oauthToken":{"index":29,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"GitHub OAuth token. Must be configured on either component or endpoint."}}} , -{"component":{"kind":"component","name":"google-bigquery","title":"Google BigQuery","description":"Google BigQuery data warehouse for analytics.","deprecated":false,"firstVersion":"2.20.0","label":"cloud,bigdata","javaType":"org.apache.camel.component.google.bigquery.GoogleBigQueryComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-bigquery","version":"4.8.1","scheme":"google-bigquery","extendsScheme":"","syntax":"google-bigquery:projectId:datasetId:tableId","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelGoogleBigQueryTableSuffix":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Table suffix to use when inserting data","constantName":"org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#TABLE_SUFFIX"},"CamelGoogleBigQueryTableId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Table id where data will be submitted. If specified will override endpoint configuration","constantName":"org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#TABLE_ID"},"CamelGoogleBigQueryInsertId":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"InsertId to use when inserting data","constantName":"org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#INSERT_ID"},"CamelGoogleBigQueryPartitionDecorator":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Partition decorator to indicate partition to use when inserting data","constantName":"org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#PARTITION_DECORATOR"}},"properties":{"projectId":{"index":0,"kind":"path","displayName":"Project Id","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.GoogleBigQueryConfiguration","configurationField":"configuration","description":"Google Cloud Project Id"},"datasetId":{"index":1,"kind":"path","displayName":"Dataset Id","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.GoogleBigQueryConfiguration","configurationField":"configuration","description":"BigQuery Dataset Id"},"tableId":{"index":2,"kind":"path","displayName":"Table Id","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.GoogleBigQueryConfiguration","configurationField":"configuration","description":"BigQuery table id"},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.google.bigquery.GoogleBigQueryConnectionFactory","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.GoogleBigQueryConfiguration","configurationField":"configuration","description":"ConnectionFactory to obtain connection to Bigquery Service. If not provided the default one will be used"},"useAsInsertId":{"index":4,"kind":"parameter","displayName":"Use As Insert Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.GoogleBigQueryConfiguration","configurationField":"configuration","description":"Field name to use as insert id"},"lazyStartProducer":{"index":5,"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."},"serviceAccountKey":{"index":6,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.GoogleBigQueryConfiguration","configurationField":"configuration","description":"Service account key in json format to authenticate an application as a service account to google cloud platform"}}} +{"component":{"kind":"component","name":"google-bigquery","title":"Google BigQuery","description":"Google BigQuery data warehouse for analytics.","deprecated":false,"firstVersion":"2.20.0","label":"cloud,bigdata","javaType":"org.apache.camel.component.google.bigquery.GoogleBigQueryComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-bigquery","version":"4.8.2","scheme":"google-bigquery","extendsScheme":"","syntax":"google-bigquery:projectId:datasetId:tableId","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelGoogleBigQueryTableSuffix":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Table suffix to use when inserting data","constantName":"org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#TABLE_SUFFIX"},"CamelGoogleBigQueryTableId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Table id where data will be submitted. If specified will override endpoint configuration","constantName":"org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#TABLE_ID"},"CamelGoogleBigQueryInsertId":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"InsertId to use when inserting data","constantName":"org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#INSERT_ID"},"CamelGoogleBigQueryPartitionDecorator":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Partition decorator to indicate partition to use when inserting data","constantName":"org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#PARTITION_DECORATOR"}},"properties":{"projectId":{"index":0,"kind":"path","displayName":"Project Id","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.GoogleBigQueryConfiguration","configurationField":"configuration","description":"Google Cloud Project Id"},"datasetId":{"index":1,"kind":"path","displayName":"Dataset Id","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.GoogleBigQueryConfiguration","configurationField":"configuration","description":"BigQuery Dataset Id"},"tableId":{"index":2,"kind":"path","displayName":"Table Id","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.GoogleBigQueryConfiguration","configurationField":"configuration","description":"BigQuery table id"},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.google.bigquery.GoogleBigQueryConnectionFactory","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.GoogleBigQueryConfiguration","configurationField":"configuration","description":"ConnectionFactory to obtain connection to Bigquery Service. If not provided the default one will be used"},"useAsInsertId":{"index":4,"kind":"parameter","displayName":"Use As Insert Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.GoogleBigQueryConfiguration","configurationField":"configuration","description":"Field name to use as insert id"},"lazyStartProducer":{"index":5,"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."},"serviceAccountKey":{"index":6,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.GoogleBigQueryConfiguration","configurationField":"configuration","description":"Service account key in json format to authenticate an application as a service account to google cloud platform"}}} , -{"component":{"kind":"component","name":"google-bigquery-sql","title":"Google BigQuery Standard SQL","description":"Access Google Cloud BigQuery service using SQL queries.","deprecated":false,"firstVersion":"2.23.0","label":"cloud,messaging","javaType":"org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-bigquery","version":"4.8.1","scheme":"google-bigquery-sql","extendsScheme":"","syntax":"google-bigquery-sql:projectId:queryString","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelGoogleBigQueryTranslatedQuery":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Preprocessed query text","constantName":"org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#TRANSLATED_QUERY"},"CamelGoogleBigQueryJobId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"com.google.cloud.bigquery.JobId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A custom JobId to use","constantName":"org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#JOB_ID"}},"properties":{"projectId":{"index":0,"kind":"path","displayName":"Project Id","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration","configurationField":"configuration","description":"Google Cloud Project Id"},"queryString":{"index":1,"kind":"path","displayName":"Query String","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"largeInput":true,"configurationClass":"org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration","configurationField":"configuration","description":"BigQuery standard SQL query"},"connectionFactory":{"index":2,"kind":"parameter","displayName":"Connection Factory","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.google.bigquery.GoogleBigQueryConnectionFactory","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration","configurationField":"configuration","description":"ConnectionFactory to obtain connection to Bigquery Service. If not provided the default one will be used"},"lazyStartProducer":{"index":3,"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."},"serviceAccountKey":{"index":4,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration","configurationField":"configuration","description":"Service account key in json format to authenticate an application as a service account to google cloud platform"}}} +{"component":{"kind":"component","name":"google-bigquery-sql","title":"Google BigQuery Standard SQL","description":"Access Google Cloud BigQuery service using SQL queries.","deprecated":false,"firstVersion":"2.23.0","label":"cloud,messaging","javaType":"org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-bigquery","version":"4.8.2","scheme":"google-bigquery-sql","extendsScheme":"","syntax":"google-bigquery-sql:projectId:queryString","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelGoogleBigQueryTranslatedQuery":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Preprocessed query text","constantName":"org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#TRANSLATED_QUERY"},"CamelGoogleBigQueryJobId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"com.google.cloud.bigquery.JobId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A custom JobId to use","constantName":"org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#JOB_ID"}},"properties":{"projectId":{"index":0,"kind":"path","displayName":"Project Id","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration","configurationField":"configuration","description":"Google Cloud Project Id"},"queryString":{"index":1,"kind":"path","displayName":"Query String","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"largeInput":true,"configurationClass":"org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration","configurationField":"configuration","description":"BigQuery standard SQL query"},"connectionFactory":{"index":2,"kind":"parameter","displayName":"Connection Factory","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.google.bigquery.GoogleBigQueryConnectionFactory","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration","configurationField":"configuration","description":"ConnectionFactory to obtain connection to Bigquery Service. If not provided the default one will be used"},"lazyStartProducer":{"index":3,"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."},"serviceAccountKey":{"index":4,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration","configurationField":"configuration","description":"Service account key in json format to authenticate an application as a service account to google cloud platform"}}} , -{"component":{"kind":"component","name":"google-calendar","title":"Google Calendar","description":"Perform various operations on a Google Calendar.","deprecated":false,"firstVersion":"2.15.0","label":"api,cloud","javaType":"org.apache.camel.component.google.calendar.GoogleCalendarComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-calendar","version":"4.8.1","scheme":"google-calendar","extendsScheme":"","syntax":"google-calendar:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.google.calendar.internal.GoogleCalendarApiName","enum":["ACL","LIST","CALENDARS","CHANNELS","COLORS","FREEBUSY","EVENTS","SETTINGS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["calendarImport","clear","delete","get","insert","instances","list","move","patch","query","quickAdd","stop","update","watch"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"applicationName":{"index":2,"kind":"parameter","displayName":"Application Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"Google calendar application name. Example would be camel-google-calendar/1.0"},"clientId":{"index":3,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"Client ID of the calendar application"},"delegate":{"index":4,"kind":"parameter","displayName":"Delegate","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"Delegate for wide-domain service account"},"inBody":{"index":5,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"scopes":{"index":6,"kind":"parameter","displayName":"Scopes","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https://www.googleapis.com/auth/calendar","configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"Specifies the level of permissions you want a calendar application to have to a user account. You can separate multiple scopes by comma. See https://developers.google.com/google-apps/calendar/auth for more info."},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":12,"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."},"backoffErrorThreshold":{"index":13,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":14,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":15,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":16,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":17,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":18,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":19,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":20,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":21,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":22,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":23,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":24,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":25,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":26,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":27,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."},"clientSecret":{"index":28,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"Client secret of the calendar application"},"emailAddress":{"index":29,"kind":"parameter","displayName":"Email Address","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"The emailAddress of the Google Service Account."},"p12FileName":{"index":30,"kind":"parameter","displayName":"P12 File Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"The name of the p12 file which has the private key to use with the Google Service Account."},"refreshToken":{"index":31,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."},"serviceAccountKey":{"index":32,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"Service account key in json format to authenticate an application as a service account. Accept base64 adding the prefix base64:"},"user":{"index":33,"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"The email address of the user the application is trying to impersonate in the service account flow"}},"apis":{"acl":{"consumerOnly":false,"producerOnly":false,"description":"The acl collection of methods","methods":{"delete":{"description":"Deletes an access control rule","signatures":["com.google.api.services.calendar.Calendar$Acl$Delete delete(String calendarId, String ruleId)"]},"get":{"description":"Returns an access control rule","signatures":["com.google.api.services.calendar.Calendar$Acl$Get get(String calendarId, String ruleId)"]},"insert":{"description":"Creates an access control rule","signatures":["com.google.api.services.calendar.Calendar$Acl$Insert insert(String calendarId, com.google.api.services.calendar.model.AclRule content)"]},"list":{"description":"Returns the rules in the access control list for the calendar","signatures":["com.google.api.services.calendar.Calendar$Acl$List list(String calendarId)"]},"patch":{"description":"Updates an access control rule","signatures":["com.google.api.services.calendar.Calendar$Acl$Patch patch(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content)"]},"update":{"description":"Updates an access control rule","signatures":["com.google.api.services.calendar.Calendar$Acl$Update update(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content)"]},"watch":{"description":"Watch for changes to ACL resources","signatures":["com.google.api.services.calendar.Calendar$Acl$Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content)"]}}},"calendars":{"consumerOnly":false,"producerOnly":false,"description":"The calendars collection of methods","methods":{"clear":{"description":"Clears a primary calendar","signatures":["com.google.api.services.calendar.Calendar$Calendars$Clear clear(String calendarId)"]},"delete":{"description":"Deletes a secondary calendar","signatures":["com.google.api.services.calendar.Calendar$Calendars$Delete delete(String calendarId)"]},"get":{"description":"Returns metadata for a calendar","signatures":["com.google.api.services.calendar.Calendar$Calendars$Get get(String calendarId)"]},"insert":{"description":"Creates a secondary calendar","signatures":["com.google.api.services.calendar.Calendar$Calendars$Insert insert(com.google.api.services.calendar.model.Calendar content)"]},"patch":{"description":"Updates metadata for a calendar","signatures":["com.google.api.services.calendar.Calendar$Calendars$Patch patch(String calendarId, com.google.api.services.calendar.model.Calendar content)"]},"update":{"description":"Updates metadata for a calendar","signatures":["com.google.api.services.calendar.Calendar$Calendars$Update update(String calendarId, com.google.api.services.calendar.model.Calendar content)"]}}},"channels":{"consumerOnly":false,"producerOnly":false,"description":"The channels collection of methods","methods":{"stop":{"description":"Stop watching resources through this channel","signatures":["com.google.api.services.calendar.Calendar$Channels$Stop stop(com.google.api.services.calendar.model.Channel content)"]}}},"events":{"consumerOnly":false,"producerOnly":false,"description":"The events collection of methods","methods":{"calendarImport":{"description":"Imports an event","signatures":["com.google.api.services.calendar.Calendar$Events$CalendarImport calendarImport(String calendarId, com.google.api.services.calendar.model.Event content)"]},"delete":{"description":"Deletes an event","signatures":["com.google.api.services.calendar.Calendar$Events$Delete delete(String calendarId, String eventId)"]},"get":{"description":"Returns an event based on its Google Calendar ID","signatures":["com.google.api.services.calendar.Calendar$Events$Get get(String calendarId, String eventId)"]},"insert":{"description":"Creates an event","signatures":["com.google.api.services.calendar.Calendar$Events$Insert insert(String calendarId, com.google.api.services.calendar.model.Event content)"]},"instances":{"description":"Returns instances of the specified recurring event","signatures":["com.google.api.services.calendar.Calendar$Events$Instances instances(String calendarId, String eventId)"]},"list":{"description":"Returns events on the specified calendar","signatures":["com.google.api.services.calendar.Calendar$Events$List list(String calendarId)"]},"move":{"description":"Moves an event to another calendar, i","signatures":["com.google.api.services.calendar.Calendar$Events$Move move(String calendarId, String eventId, String destination)"]},"patch":{"description":"Updates an event","signatures":["com.google.api.services.calendar.Calendar$Events$Patch patch(String calendarId, String eventId, com.google.api.services.calendar.model.Event content)"]},"quickAdd":{"description":"Creates an event based on a simple text string","signatures":["com.google.api.services.calendar.Calendar$Events$QuickAdd quickAdd(String calendarId, String text)"]},"update":{"description":"Updates an event","signatures":["com.google.api.services.calendar.Calendar$Events$Update update(String calendarId, String eventId, com.google.api.services.calendar.model.Event content)"]},"watch":{"description":"Watch for changes to Events resources","signatures":["com.google.api.services.calendar.Calendar$Events$Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content)"]}}},"freebusy":{"consumerOnly":false,"producerOnly":false,"description":"The freebusy collection of methods","methods":{"query":{"description":"Returns free/busy information for a set of calendars","signatures":["com.google.api.services.calendar.Calendar$Freebusy$Query query(com.google.api.services.calendar.model.FreeBusyRequest content)"]}}},"list":{"consumerOnly":false,"producerOnly":false,"description":"The calendarList collection of methods","methods":{"delete":{"description":"Removes a calendar from the user's calendar list","signatures":["com.google.api.services.calendar.Calendar$CalendarList$Delete delete(String calendarId)"]},"get":{"description":"Returns a calendar from the user's calendar list","signatures":["com.google.api.services.calendar.Calendar$CalendarList$Get get(String calendarId)"]},"insert":{"description":"Inserts an existing calendar into the user's calendar list","signatures":["com.google.api.services.calendar.Calendar$CalendarList$Insert insert(com.google.api.services.calendar.model.CalendarListEntry content)"]},"patch":{"description":"Updates an existing calendar on the user's calendar list","signatures":["com.google.api.services.calendar.Calendar$CalendarList$Patch patch(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content)"]},"update":{"description":"Updates an existing calendar on the user's calendar list","signatures":["com.google.api.services.calendar.Calendar$CalendarList$Update update(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content)"]},"watch":{"description":"Watch for changes to CalendarList resources","signatures":["com.google.api.services.calendar.Calendar$CalendarList$Watch watch(com.google.api.services.calendar.model.Channel content)"]}}},"settings":{"consumerOnly":false,"producerOnly":false,"description":"The settings collection of methods","methods":{"get":{"description":"Returns a single user setting","signatures":["com.google.api.services.calendar.Calendar$Settings$Get get(String setting)"]},"watch":{"description":"Watch for changes to Settings resources","signatures":["com.google.api.services.calendar.Calendar$Settings$Watch watch(com.google.api.services.calendar.model.Channel content)"]}}}},"apiProperties":{"acl":{"methods":{"delete":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"ruleId":{"index":1,"kind":"parameter","displayName":"Rule Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"ACL rule identifier","optional":false}}},"get":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"ruleId":{"index":1,"kind":"parameter","displayName":"Rule Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"ACL rule identifier","optional":false}}},"insert":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.AclRule","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.AclRule","optional":false}}},"list":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false}}},"patch":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.AclRule","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.AclRule","optional":false},"ruleId":{"index":2,"kind":"parameter","displayName":"Rule Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"ACL rule identifier","optional":false}}},"update":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.AclRule","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.AclRule","optional":false},"ruleId":{"index":2,"kind":"parameter","displayName":"Rule Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"ACL rule identifier","optional":false}}},"watch":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"contentChannel":{"index":1,"kind":"parameter","displayName":"Content Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Channel","optional":false}}}}},"calendars":{"methods":{"clear":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false}}},"delete":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false}}},"get":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false}}},"insert":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Calendar","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Calendar","optional":false}}},"patch":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Calendar","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Calendar","optional":false}}},"update":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Calendar","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Calendar","optional":false}}}}},"channels":{"methods":{"stop":{"properties":{"contentChannel":{"index":0,"kind":"parameter","displayName":"Content Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Channel","optional":false}}}}},"events":{"methods":{"calendarImport":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Event","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Event","optional":false}}},"delete":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"eventId":{"index":1,"kind":"parameter","displayName":"Event Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Event identifier","optional":false}}},"get":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"eventId":{"index":1,"kind":"parameter","displayName":"Event Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Event identifier","optional":false}}},"insert":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Event","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Event","optional":false}}},"instances":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"eventId":{"index":1,"kind":"parameter","displayName":"Event Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Recurring event identifier","optional":false}}},"list":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false}}},"move":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier of the source calendar where the event currently is on","optional":false},"destination":{"index":1,"kind":"parameter","displayName":"Destination","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier of the target calendar where the event is to be moved to","optional":false},"eventId":{"index":2,"kind":"parameter","displayName":"Event Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Event identifier","optional":false}}},"patch":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Event","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Event","optional":false},"eventId":{"index":2,"kind":"parameter","displayName":"Event Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Event identifier","optional":false}}},"quickAdd":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"text":{"index":1,"kind":"parameter","displayName":"Text","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The text describing the event to be created","optional":false}}},"update":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Event","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Event","optional":false},"eventId":{"index":2,"kind":"parameter","displayName":"Event Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Event identifier","optional":false}}},"watch":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"contentChannel":{"index":1,"kind":"parameter","displayName":"Content Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Channel","optional":false}}}}},"freebusy":{"methods":{"query":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.FreeBusyRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.FreeBusyRequest","optional":false}}}}},"list":{"methods":{"delete":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false}}},"get":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false}}},"insert":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.CalendarListEntry","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.CalendarListEntry","optional":false}}},"patch":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.CalendarListEntry","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.CalendarListEntry","optional":false}}},"update":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.CalendarListEntry","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.CalendarListEntry","optional":false}}},"watch":{"properties":{"contentChannel":{"index":0,"kind":"parameter","displayName":"Content Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Channel","optional":false}}}}},"settings":{"methods":{"get":{"properties":{"setting":{"index":0,"kind":"parameter","displayName":"Setting","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the user setting","optional":false}}},"watch":{"properties":{"contentChannel":{"index":0,"kind":"parameter","displayName":"Content Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Channel","optional":false}}}}}}} +{"component":{"kind":"component","name":"google-calendar","title":"Google Calendar","description":"Perform various operations on a Google Calendar.","deprecated":false,"firstVersion":"2.15.0","label":"api,cloud","javaType":"org.apache.camel.component.google.calendar.GoogleCalendarComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-calendar","version":"4.8.2","scheme":"google-calendar","extendsScheme":"","syntax":"google-calendar:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.google.calendar.internal.GoogleCalendarApiName","enum":["ACL","LIST","CALENDARS","CHANNELS","COLORS","FREEBUSY","EVENTS","SETTINGS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["calendarImport","clear","delete","get","insert","instances","list","move","patch","query","quickAdd","stop","update","watch"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"applicationName":{"index":2,"kind":"parameter","displayName":"Application Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"Google calendar application name. Example would be camel-google-calendar/1.0"},"clientId":{"index":3,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"Client ID of the calendar application"},"delegate":{"index":4,"kind":"parameter","displayName":"Delegate","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"Delegate for wide-domain service account"},"inBody":{"index":5,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"scopes":{"index":6,"kind":"parameter","displayName":"Scopes","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https://www.googleapis.com/auth/calendar","configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"Specifies the level of permissions you want a calendar application to have to a user account. You can separate multiple scopes by comma. See https://developers.google.com/google-apps/calendar/auth for more info."},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":12,"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."},"backoffErrorThreshold":{"index":13,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":14,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":15,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":16,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":17,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":18,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":19,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":20,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":21,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":22,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":23,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":24,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":25,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":26,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":27,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."},"clientSecret":{"index":28,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"Client secret of the calendar application"},"emailAddress":{"index":29,"kind":"parameter","displayName":"Email Address","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"The emailAddress of the Google Service Account."},"p12FileName":{"index":30,"kind":"parameter","displayName":"P12 File Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"The name of the p12 file which has the private key to use with the Google Service Account."},"refreshToken":{"index":31,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."},"serviceAccountKey":{"index":32,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"Service account key in json format to authenticate an application as a service account. Accept base64 adding the prefix base64:"},"user":{"index":33,"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.GoogleCalendarConfiguration","configurationField":"configuration","description":"The email address of the user the application is trying to impersonate in the service account flow"}},"apis":{"acl":{"consumerOnly":false,"producerOnly":false,"description":"The acl collection of methods","methods":{"delete":{"description":"Deletes an access control rule","signatures":["com.google.api.services.calendar.Calendar$Acl$Delete delete(String calendarId, String ruleId)"]},"get":{"description":"Returns an access control rule","signatures":["com.google.api.services.calendar.Calendar$Acl$Get get(String calendarId, String ruleId)"]},"insert":{"description":"Creates an access control rule","signatures":["com.google.api.services.calendar.Calendar$Acl$Insert insert(String calendarId, com.google.api.services.calendar.model.AclRule content)"]},"list":{"description":"Returns the rules in the access control list for the calendar","signatures":["com.google.api.services.calendar.Calendar$Acl$List list(String calendarId)"]},"patch":{"description":"Updates an access control rule","signatures":["com.google.api.services.calendar.Calendar$Acl$Patch patch(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content)"]},"update":{"description":"Updates an access control rule","signatures":["com.google.api.services.calendar.Calendar$Acl$Update update(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content)"]},"watch":{"description":"Watch for changes to ACL resources","signatures":["com.google.api.services.calendar.Calendar$Acl$Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content)"]}}},"calendars":{"consumerOnly":false,"producerOnly":false,"description":"The calendars collection of methods","methods":{"clear":{"description":"Clears a primary calendar","signatures":["com.google.api.services.calendar.Calendar$Calendars$Clear clear(String calendarId)"]},"delete":{"description":"Deletes a secondary calendar","signatures":["com.google.api.services.calendar.Calendar$Calendars$Delete delete(String calendarId)"]},"get":{"description":"Returns metadata for a calendar","signatures":["com.google.api.services.calendar.Calendar$Calendars$Get get(String calendarId)"]},"insert":{"description":"Creates a secondary calendar","signatures":["com.google.api.services.calendar.Calendar$Calendars$Insert insert(com.google.api.services.calendar.model.Calendar content)"]},"patch":{"description":"Updates metadata for a calendar","signatures":["com.google.api.services.calendar.Calendar$Calendars$Patch patch(String calendarId, com.google.api.services.calendar.model.Calendar content)"]},"update":{"description":"Updates metadata for a calendar","signatures":["com.google.api.services.calendar.Calendar$Calendars$Update update(String calendarId, com.google.api.services.calendar.model.Calendar content)"]}}},"channels":{"consumerOnly":false,"producerOnly":false,"description":"The channels collection of methods","methods":{"stop":{"description":"Stop watching resources through this channel","signatures":["com.google.api.services.calendar.Calendar$Channels$Stop stop(com.google.api.services.calendar.model.Channel content)"]}}},"events":{"consumerOnly":false,"producerOnly":false,"description":"The events collection of methods","methods":{"calendarImport":{"description":"Imports an event","signatures":["com.google.api.services.calendar.Calendar$Events$CalendarImport calendarImport(String calendarId, com.google.api.services.calendar.model.Event content)"]},"delete":{"description":"Deletes an event","signatures":["com.google.api.services.calendar.Calendar$Events$Delete delete(String calendarId, String eventId)"]},"get":{"description":"Returns an event based on its Google Calendar ID","signatures":["com.google.api.services.calendar.Calendar$Events$Get get(String calendarId, String eventId)"]},"insert":{"description":"Creates an event","signatures":["com.google.api.services.calendar.Calendar$Events$Insert insert(String calendarId, com.google.api.services.calendar.model.Event content)"]},"instances":{"description":"Returns instances of the specified recurring event","signatures":["com.google.api.services.calendar.Calendar$Events$Instances instances(String calendarId, String eventId)"]},"list":{"description":"Returns events on the specified calendar","signatures":["com.google.api.services.calendar.Calendar$Events$List list(String calendarId)"]},"move":{"description":"Moves an event to another calendar, i","signatures":["com.google.api.services.calendar.Calendar$Events$Move move(String calendarId, String eventId, String destination)"]},"patch":{"description":"Updates an event","signatures":["com.google.api.services.calendar.Calendar$Events$Patch patch(String calendarId, String eventId, com.google.api.services.calendar.model.Event content)"]},"quickAdd":{"description":"Creates an event based on a simple text string","signatures":["com.google.api.services.calendar.Calendar$Events$QuickAdd quickAdd(String calendarId, String text)"]},"update":{"description":"Updates an event","signatures":["com.google.api.services.calendar.Calendar$Events$Update update(String calendarId, String eventId, com.google.api.services.calendar.model.Event content)"]},"watch":{"description":"Watch for changes to Events resources","signatures":["com.google.api.services.calendar.Calendar$Events$Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content)"]}}},"freebusy":{"consumerOnly":false,"producerOnly":false,"description":"The freebusy collection of methods","methods":{"query":{"description":"Returns free/busy information for a set of calendars","signatures":["com.google.api.services.calendar.Calendar$Freebusy$Query query(com.google.api.services.calendar.model.FreeBusyRequest content)"]}}},"list":{"consumerOnly":false,"producerOnly":false,"description":"The calendarList collection of methods","methods":{"delete":{"description":"Removes a calendar from the user's calendar list","signatures":["com.google.api.services.calendar.Calendar$CalendarList$Delete delete(String calendarId)"]},"get":{"description":"Returns a calendar from the user's calendar list","signatures":["com.google.api.services.calendar.Calendar$CalendarList$Get get(String calendarId)"]},"insert":{"description":"Inserts an existing calendar into the user's calendar list","signatures":["com.google.api.services.calendar.Calendar$CalendarList$Insert insert(com.google.api.services.calendar.model.CalendarListEntry content)"]},"patch":{"description":"Updates an existing calendar on the user's calendar list","signatures":["com.google.api.services.calendar.Calendar$CalendarList$Patch patch(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content)"]},"update":{"description":"Updates an existing calendar on the user's calendar list","signatures":["com.google.api.services.calendar.Calendar$CalendarList$Update update(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content)"]},"watch":{"description":"Watch for changes to CalendarList resources","signatures":["com.google.api.services.calendar.Calendar$CalendarList$Watch watch(com.google.api.services.calendar.model.Channel content)"]}}},"settings":{"consumerOnly":false,"producerOnly":false,"description":"The settings collection of methods","methods":{"get":{"description":"Returns a single user setting","signatures":["com.google.api.services.calendar.Calendar$Settings$Get get(String setting)"]},"watch":{"description":"Watch for changes to Settings resources","signatures":["com.google.api.services.calendar.Calendar$Settings$Watch watch(com.google.api.services.calendar.model.Channel content)"]}}}},"apiProperties":{"acl":{"methods":{"delete":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"ruleId":{"index":1,"kind":"parameter","displayName":"Rule Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"ACL rule identifier","optional":false}}},"get":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"ruleId":{"index":1,"kind":"parameter","displayName":"Rule Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"ACL rule identifier","optional":false}}},"insert":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.AclRule","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.AclRule","optional":false}}},"list":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false}}},"patch":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.AclRule","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.AclRule","optional":false},"ruleId":{"index":2,"kind":"parameter","displayName":"Rule Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"ACL rule identifier","optional":false}}},"update":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.AclRule","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.AclRule","optional":false},"ruleId":{"index":2,"kind":"parameter","displayName":"Rule Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"ACL rule identifier","optional":false}}},"watch":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"contentChannel":{"index":1,"kind":"parameter","displayName":"Content Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Channel","optional":false}}}}},"calendars":{"methods":{"clear":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false}}},"delete":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false}}},"get":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false}}},"insert":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Calendar","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Calendar","optional":false}}},"patch":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Calendar","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Calendar","optional":false}}},"update":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Calendar","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Calendar","optional":false}}}}},"channels":{"methods":{"stop":{"properties":{"contentChannel":{"index":0,"kind":"parameter","displayName":"Content Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Channel","optional":false}}}}},"events":{"methods":{"calendarImport":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Event","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Event","optional":false}}},"delete":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"eventId":{"index":1,"kind":"parameter","displayName":"Event Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Event identifier","optional":false}}},"get":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"eventId":{"index":1,"kind":"parameter","displayName":"Event Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Event identifier","optional":false}}},"insert":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Event","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Event","optional":false}}},"instances":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"eventId":{"index":1,"kind":"parameter","displayName":"Event Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Recurring event identifier","optional":false}}},"list":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false}}},"move":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier of the source calendar where the event currently is on","optional":false},"destination":{"index":1,"kind":"parameter","displayName":"Destination","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier of the target calendar where the event is to be moved to","optional":false},"eventId":{"index":2,"kind":"parameter","displayName":"Event Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Event identifier","optional":false}}},"patch":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Event","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Event","optional":false},"eventId":{"index":2,"kind":"parameter","displayName":"Event Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Event identifier","optional":false}}},"quickAdd":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"text":{"index":1,"kind":"parameter","displayName":"Text","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The text describing the event to be created","optional":false}}},"update":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Event","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Event","optional":false},"eventId":{"index":2,"kind":"parameter","displayName":"Event Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Event identifier","optional":false}}},"watch":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"contentChannel":{"index":1,"kind":"parameter","displayName":"Content Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Channel","optional":false}}}}},"freebusy":{"methods":{"query":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.FreeBusyRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.FreeBusyRequest","optional":false}}}}},"list":{"methods":{"delete":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false}}},"get":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false}}},"insert":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.CalendarListEntry","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.CalendarListEntry","optional":false}}},"patch":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.CalendarListEntry","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.CalendarListEntry","optional":false}}},"update":{"properties":{"calendarId":{"index":0,"kind":"parameter","displayName":"Calendar Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.CalendarListEntry","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.CalendarListEntry","optional":false}}},"watch":{"properties":{"contentChannel":{"index":0,"kind":"parameter","displayName":"Content Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Channel","optional":false}}}}},"settings":{"methods":{"get":{"properties":{"setting":{"index":0,"kind":"parameter","displayName":"Setting","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The id of the user setting","optional":false}}},"watch":{"properties":{"contentChannel":{"index":0,"kind":"parameter","displayName":"Content Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.calendar.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.calendar.model.Channel","optional":false}}}}}}} , -{"component":{"kind":"component","name":"google-calendar-stream","title":"Google Calendar Stream","description":"Poll for changes in a Google Calendar.","deprecated":false,"firstVersion":"2.23.0","label":"cloud","javaType":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-calendar","version":"4.8.1","scheme":"google-calendar-stream","extendsScheme":"","syntax":"google-calendar-stream:index","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelGoogleCalendarEventId":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The calendar event id","constantName":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConstants#EVENT_ID"}},"properties":{"index":{"index":0,"kind":"path","displayName":"Index","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Specifies an index for the endpoint"},"applicationName":{"index":1,"kind":"parameter","displayName":"Application Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Google Calendar application name. Example would be camel-google-calendar/1.0"},"calendarId":{"index":2,"kind":"parameter","displayName":"Calendar Id","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"primary","configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"The calendarId to be used"},"clientId":{"index":3,"kind":"parameter","displayName":"Client Id","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Client ID of the calendar application"},"considerLastUpdate":{"index":4,"kind":"parameter","displayName":"Consider Last Update","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Take into account the lastUpdate of the last event polled as start date for the next poll"},"consumeFromNow":{"index":5,"kind":"parameter","displayName":"Consume From Now","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Consume events in the selected calendar from now on"},"delegate":{"index":6,"kind":"parameter","displayName":"Delegate","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Delegate for wide-domain service account"},"maxResults":{"index":7,"kind":"parameter","displayName":"Max Results","group":"consumer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Max results to be returned"},"query":{"index":8,"kind":"parameter","displayName":"Query","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"The query to execute on calendar"},"scopes":{"index":9,"kind":"parameter","displayName":"Scopes","group":"consumer","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Specifies the level of permissions you want a calendar application to have to a user account. See https://developers.google.com/calendar/auth for more info."},"sendEmptyMessageWhenIdle":{"index":10,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"syncFlow":{"index":11,"kind":"parameter","displayName":"Sync Flow","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Sync events, see https://developers.google.com/calendar/v3/sync Note: not compatible with: 'query' and 'considerLastUpdate' parameters"},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":15,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"backoffErrorThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":17,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":18,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":19,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":20,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":21,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":22,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":23,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":24,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":25,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":26,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":27,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":28,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":29,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":30,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."},"clientSecret":{"index":31,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Client secret of the calendar application"},"emailAddress":{"index":32,"kind":"parameter","displayName":"Email Address","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"The emailAddress of the Google Service Account."},"p12FileName":{"index":33,"kind":"parameter","displayName":"P12 File Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"The name of the p12 file which has the private key to use with the Google Service Account."},"refreshToken":{"index":34,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."},"serviceAccountKey":{"index":35,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Service account key in json format to authenticate an application as a service account. Accept base64 adding the prefix base64:"},"user":{"index":36,"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"The email address of the user the application is trying to impersonate in the service account flow."}}} +{"component":{"kind":"component","name":"google-calendar-stream","title":"Google Calendar Stream","description":"Poll for changes in a Google Calendar.","deprecated":false,"firstVersion":"2.23.0","label":"cloud","javaType":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-calendar","version":"4.8.2","scheme":"google-calendar-stream","extendsScheme":"","syntax":"google-calendar-stream:index","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelGoogleCalendarEventId":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The calendar event id","constantName":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConstants#EVENT_ID"}},"properties":{"index":{"index":0,"kind":"path","displayName":"Index","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Specifies an index for the endpoint"},"applicationName":{"index":1,"kind":"parameter","displayName":"Application Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Google Calendar application name. Example would be camel-google-calendar/1.0"},"calendarId":{"index":2,"kind":"parameter","displayName":"Calendar Id","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"primary","configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"The calendarId to be used"},"clientId":{"index":3,"kind":"parameter","displayName":"Client Id","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Client ID of the calendar application"},"considerLastUpdate":{"index":4,"kind":"parameter","displayName":"Consider Last Update","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Take into account the lastUpdate of the last event polled as start date for the next poll"},"consumeFromNow":{"index":5,"kind":"parameter","displayName":"Consume From Now","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Consume events in the selected calendar from now on"},"delegate":{"index":6,"kind":"parameter","displayName":"Delegate","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Delegate for wide-domain service account"},"maxResults":{"index":7,"kind":"parameter","displayName":"Max Results","group":"consumer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Max results to be returned"},"query":{"index":8,"kind":"parameter","displayName":"Query","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"The query to execute on calendar"},"scopes":{"index":9,"kind":"parameter","displayName":"Scopes","group":"consumer","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Specifies the level of permissions you want a calendar application to have to a user account. See https://developers.google.com/calendar/auth for more info."},"sendEmptyMessageWhenIdle":{"index":10,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"syncFlow":{"index":11,"kind":"parameter","displayName":"Sync Flow","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Sync events, see https://developers.google.com/calendar/v3/sync Note: not compatible with: 'query' and 'considerLastUpdate' parameters"},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":15,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"backoffErrorThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":17,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":18,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":19,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":20,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":21,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":22,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":23,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":24,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":25,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":26,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":27,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":28,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":29,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":30,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."},"clientSecret":{"index":31,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Client secret of the calendar application"},"emailAddress":{"index":32,"kind":"parameter","displayName":"Email Address","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"The emailAddress of the Google Service Account."},"p12FileName":{"index":33,"kind":"parameter","displayName":"P12 File Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"The name of the p12 file which has the private key to use with the Google Service Account."},"refreshToken":{"index":34,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."},"serviceAccountKey":{"index":35,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"Service account key in json format to authenticate an application as a service account. Accept base64 adding the prefix base64:"},"user":{"index":36,"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration","configurationField":"configuration","description":"The email address of the user the application is trying to impersonate in the service account flow."}}} , -{"component":{"kind":"component","name":"google-drive","title":"Google Drive","description":"Manage files in Google Drive.","deprecated":false,"firstVersion":"2.14.0","label":"file,cloud,api","javaType":"org.apache.camel.component.google.drive.GoogleDriveComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-drive","version":"4.8.1","scheme":"google-drive","extendsScheme":"","syntax":"google-drive:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.google.drive.internal.GoogleDriveApiName","enum":["DRIVE_ABOUT","DRIVE_CHANGES","DRIVE_CHANNELS","DRIVE_COMMENTS","DRIVE_DRIVES","DRIVE_FILES","DRIVE_PERMISSIONS","DRIVE_REPLIES","DRIVE_REVISIONS","DRIVE_TEAMDRIVES"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["copy","delete","get","getIdForEmail","insert","list","patch","stop","touch","trash","untrash","update","watch"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"applicationName":{"index":2,"kind":"parameter","displayName":"Application Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"Google drive application name. Example would be camel-google-drive/1.0"},"clientFactory":{"index":3,"kind":"parameter","displayName":"Client Factory","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.google.drive.GoogleDriveClientFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory"},"clientId":{"index":4,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"Client ID of the drive application"},"delegate":{"index":5,"kind":"parameter","displayName":"Delegate","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"Delegate for wide-domain service account"},"inBody":{"index":6,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"scopes":{"index":7,"kind":"parameter","displayName":"Scopes","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"Specifies the level of permissions you want a drive application to have to a user account. See https://developers.google.com/drive/web/scopes for more info."},"sendEmptyMessageWhenIdle":{"index":8,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":12,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":13,"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."},"backoffErrorThreshold":{"index":14,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":16,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":17,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":18,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":19,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":20,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":21,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":22,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":23,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":24,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":25,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":26,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":27,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":28,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."},"clientSecret":{"index":29,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"Client secret of the drive application"},"refreshToken":{"index":30,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."},"serviceAccountKey":{"index":31,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"Service account key in json format to authenticate an application as a service account. Accept base64 adding the prefix base64:"}},"apis":{"drive-changes":{"consumerOnly":false,"producerOnly":false,"description":"The changes collection of methods","methods":{"list":{"description":"Lists the changes for a user or shared drive","signatures":["com.google.api.services.drive.Drive$Changes$List list(String pageToken)"]},"watch":{"description":"Subscribes to changes for a user","signatures":["com.google.api.services.drive.Drive$Changes$Watch watch(String pageToken, com.google.api.services.drive.model.Channel content)"]}}},"drive-channels":{"consumerOnly":false,"producerOnly":false,"description":"The channels collection of methods","methods":{"stop":{"description":"Stops watching resources through this channel","signatures":["com.google.api.services.drive.Drive$Channels$Stop stop(com.google.api.services.drive.model.Channel content)"]}}},"drive-comments":{"consumerOnly":false,"producerOnly":false,"description":"The comments collection of methods","methods":{"create":{"description":"Creates a comment on a file","signatures":["com.google.api.services.drive.Drive$Comments$Create create(String fileId, com.google.api.services.drive.model.Comment content)"]},"delete":{"description":"Deletes a comment","signatures":["com.google.api.services.drive.Drive$Comments$Delete delete(String fileId, String commentId)"]},"get":{"description":"Gets a comment by ID","signatures":["com.google.api.services.drive.Drive$Comments$Get get(String fileId, String commentId)"]},"list":{"description":"Lists a file's comments","signatures":["com.google.api.services.drive.Drive$Comments$List list(String fileId)"]},"update":{"description":"Updates a comment with patch semantics","signatures":["com.google.api.services.drive.Drive$Comments$Update update(String fileId, String commentId, com.google.api.services.drive.model.Comment content)"]}}},"drive-drives":{"consumerOnly":false,"producerOnly":false,"description":"The drives collection of methods","methods":{"create":{"description":"Creates a shared drive","signatures":["com.google.api.services.drive.Drive$Drives$Create create(String requestId, com.google.api.services.drive.model.Drive content)"]},"delete":{"description":"Permanently deletes a shared drive for which the user is an organizer","signatures":["com.google.api.services.drive.Drive$Drives$Delete delete(String driveId)"]},"get":{"description":"Gets a shared drive's metadata by ID","signatures":["com.google.api.services.drive.Drive$Drives$Get get(String driveId)"]},"hide":{"description":"Hides a shared drive from the default view","signatures":["com.google.api.services.drive.Drive$Drives$Hide hide(String driveId)"]},"unhide":{"description":"Restores a shared drive to the default view","signatures":["com.google.api.services.drive.Drive$Drives$Unhide unhide(String driveId)"]},"update":{"description":"Updates the metadata for a shared drive","signatures":["com.google.api.services.drive.Drive$Drives$Update update(String driveId, com.google.api.services.drive.model.Drive content)"]}}},"drive-files":{"consumerOnly":false,"producerOnly":false,"description":"The files collection of methods","methods":{"copy":{"description":"Creates a copy of a file and applies any requested updates with patch semantics","signatures":["com.google.api.services.drive.Drive$Files$Copy copy(String fileId, com.google.api.services.drive.model.File content)"]},"create":{"description":"Creates a new file","signatures":["com.google.api.services.drive.Drive$Files$Create create(com.google.api.services.drive.model.File content)","com.google.api.services.drive.Drive$Files$Create create(com.google.api.services.drive.model.File content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]},"delete":{"description":"Permanently deletes a file owned by the user without moving it to the trash","signatures":["com.google.api.services.drive.Drive$Files$Delete delete(String fileId)"]},"export":{"description":"Exports a Google Workspace document to the requested MIME type and returns exported byte content","signatures":["com.google.api.services.drive.Drive$Files$Export export(String fileId, String mimeType)"]},"get":{"description":"Gets a file's metadata or content by ID","signatures":["com.google.api.services.drive.Drive$Files$Get get(String fileId)"]},"listLabels":{"description":"Lists the labels on a file","signatures":["com.google.api.services.drive.Drive$Files$ListLabels listLabels(String fileId)"]},"modifyLabels":{"description":"Modifies the set of labels applied to a file","signatures":["com.google.api.services.drive.Drive$Files$ModifyLabels modifyLabels(String fileId, com.google.api.services.drive.model.ModifyLabelsRequest content)"]},"update":{"description":"Updates a file's metadata and/or content","signatures":["com.google.api.services.drive.Drive$Files$Update update(String fileId, com.google.api.services.drive.model.File content)","com.google.api.services.drive.Drive$Files$Update update(String fileId, com.google.api.services.drive.model.File content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]},"watch":{"description":"Subscribes to changes to a file","signatures":["com.google.api.services.drive.Drive$Files$Watch watch(String fileId, com.google.api.services.drive.model.Channel content)"]}}},"drive-permissions":{"consumerOnly":false,"producerOnly":false,"description":"The permissions collection of methods","methods":{"create":{"description":"Creates a permission for a file or shared drive","signatures":["com.google.api.services.drive.Drive$Permissions$Create create(String fileId, com.google.api.services.drive.model.Permission content)"]},"delete":{"description":"Deletes a permission","signatures":["com.google.api.services.drive.Drive$Permissions$Delete delete(String fileId, String permissionId)"]},"get":{"description":"Gets a permission by ID","signatures":["com.google.api.services.drive.Drive$Permissions$Get get(String fileId, String permissionId)"]},"list":{"description":"Lists a file's or shared drive's permissions","signatures":["com.google.api.services.drive.Drive$Permissions$List list(String fileId)"]},"update":{"description":"Updates a permission with patch semantics","signatures":["com.google.api.services.drive.Drive$Permissions$Update update(String fileId, String permissionId, com.google.api.services.drive.model.Permission content)"]}}},"drive-replies":{"consumerOnly":false,"producerOnly":false,"description":"The replies collection of methods","methods":{"create":{"description":"Creates a reply to a comment","signatures":["com.google.api.services.drive.Drive$Replies$Create create(String fileId, String commentId, com.google.api.services.drive.model.Reply content)"]},"delete":{"description":"Deletes a reply","signatures":["com.google.api.services.drive.Drive$Replies$Delete delete(String fileId, String commentId, String replyId)"]},"get":{"description":"Gets a reply by ID","signatures":["com.google.api.services.drive.Drive$Replies$Get get(String fileId, String commentId, String replyId)"]},"list":{"description":"Lists a comment's replies","signatures":["com.google.api.services.drive.Drive$Replies$List list(String fileId, String commentId)"]},"update":{"description":"Updates a reply with patch semantics","signatures":["com.google.api.services.drive.Drive$Replies$Update update(String fileId, String commentId, String replyId, com.google.api.services.drive.model.Reply content)"]}}},"drive-revisions":{"consumerOnly":false,"producerOnly":false,"description":"The revisions collection of methods","methods":{"delete":{"description":"Permanently deletes a file version","signatures":["com.google.api.services.drive.Drive$Revisions$Delete delete(String fileId, String revisionId)"]},"get":{"description":"Gets a revision's metadata or content by ID","signatures":["com.google.api.services.drive.Drive$Revisions$Get get(String fileId, String revisionId)"]},"list":{"description":"Lists a file's revisions","signatures":["com.google.api.services.drive.Drive$Revisions$List list(String fileId)"]},"update":{"description":"Updates a revision with patch semantics","signatures":["com.google.api.services.drive.Drive$Revisions$Update update(String fileId, String revisionId, com.google.api.services.drive.model.Revision content)"]}}},"drive-teamdrives":{"consumerOnly":false,"producerOnly":false,"description":"The teamdrives collection of methods","methods":{"create":{"description":"Deprecated: Use drives","signatures":["com.google.api.services.drive.Drive$Teamdrives$Create create(String requestId, com.google.api.services.drive.model.TeamDrive content)"]},"delete":{"description":"Deprecated: Use drives","signatures":["com.google.api.services.drive.Drive$Teamdrives$Delete delete(String teamDriveId)"]},"get":{"description":"Deprecated: Use drives","signatures":["com.google.api.services.drive.Drive$Teamdrives$Get get(String teamDriveId)"]},"update":{"description":"Deprecated: Use drives","signatures":["com.google.api.services.drive.Drive$Teamdrives$Update update(String teamDriveId, com.google.api.services.drive.model.TeamDrive content)"]}}}},"apiProperties":{"drive-changes":{"methods":{"list":{"properties":{"pageToken":{"index":0,"kind":"parameter","displayName":"Page Token","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.","optional":false}}},"watch":{"properties":{"contentChannel":{"index":0,"kind":"parameter","displayName":"Content Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Channel","optional":false},"pageToken":{"index":1,"kind":"parameter","displayName":"Page Token","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.","optional":false}}}}},"drive-channels":{"methods":{"stop":{"properties":{"contentChannel":{"index":0,"kind":"parameter","displayName":"Content Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Channel","optional":false}}}}},"drive-comments":{"methods":{"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Comment","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Comment","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"delete":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"get":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"list":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"update":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Comment","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Comment","optional":false},"fileId":{"index":2,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}}}},"drive-drives":{"methods":{"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Drive","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Drive","optional":false},"requestId":{"index":1,"kind":"parameter","displayName":"Request Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.","optional":false}}},"delete":{"properties":{"driveId":{"index":0,"kind":"parameter","displayName":"Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the shared drive","optional":false}}},"get":{"properties":{"driveId":{"index":0,"kind":"parameter","displayName":"Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the shared drive","optional":false}}},"hide":{"properties":{"driveId":{"index":0,"kind":"parameter","displayName":"Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the shared drive","optional":false}}},"unhide":{"properties":{"driveId":{"index":0,"kind":"parameter","displayName":"Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the shared drive","optional":false}}},"update":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Drive","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Drive","optional":false},"driveId":{"index":1,"kind":"parameter","displayName":"Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the shared drive","optional":false}}}}},"drive-files":{"methods":{"copy":{"properties":{"file":{"index":0,"kind":"parameter","displayName":"File","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.File","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.File","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.File","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.File media metadata or null if none","optional":false},"mediaContent":{"index":1,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false}}},"delete":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"export":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"mimeType":{"index":1,"kind":"parameter","displayName":"Mime Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Required. The MIME type of the format requested for this export.","optional":false}}},"get":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"listLabels":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID for the file","optional":false}}},"modifyLabels":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file to which the labels belong","optional":false},"modifyLabelsRequest":{"index":1,"kind":"parameter","displayName":"Modify Labels Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.ModifyLabelsRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.ModifyLabelsRequest","optional":false}}},"update":{"properties":{"file":{"index":0,"kind":"parameter","displayName":"File","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.File","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.File media metadata or null if none","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"mediaContent":{"index":2,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false}}},"watch":{"properties":{"channel":{"index":0,"kind":"parameter","displayName":"Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Channel","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}}}},"drive-permissions":{"methods":{"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Permission","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Permission","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file or shared drive","optional":false}}},"delete":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file or shared drive","optional":false},"permissionId":{"index":1,"kind":"parameter","displayName":"Permission Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the permission","optional":false}}},"get":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"permissionId":{"index":1,"kind":"parameter","displayName":"Permission Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the permission","optional":false}}},"list":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file or shared drive","optional":false}}},"update":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Permission","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Permission","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file or shared drive","optional":false},"permissionId":{"index":2,"kind":"parameter","displayName":"Permission Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the permission","optional":false}}}}},"drive-replies":{"methods":{"create":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Reply","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Reply","optional":false},"fileId":{"index":2,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"delete":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"replyId":{"index":2,"kind":"parameter","displayName":"Reply Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the reply","optional":false}}},"get":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"replyId":{"index":2,"kind":"parameter","displayName":"Reply Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the reply","optional":false}}},"list":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"update":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Reply","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Reply","optional":false},"fileId":{"index":2,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"replyId":{"index":3,"kind":"parameter","displayName":"Reply Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the reply","optional":false}}}}},"drive-revisions":{"methods":{"delete":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"revisionId":{"index":1,"kind":"parameter","displayName":"Revision Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the revision","optional":false}}},"get":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"revisionId":{"index":1,"kind":"parameter","displayName":"Revision Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the revision","optional":false}}},"list":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"update":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Revision","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Revision","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"revisionId":{"index":2,"kind":"parameter","displayName":"Revision Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the revision","optional":false}}}}},"drive-teamdrives":{"methods":{"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.TeamDrive","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.TeamDrive","optional":false},"requestId":{"index":1,"kind":"parameter","displayName":"Request Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.","optional":false}}},"delete":{"properties":{"teamDriveId":{"index":0,"kind":"parameter","displayName":"Team Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the Team Drive","optional":false}}},"get":{"properties":{"teamDriveId":{"index":0,"kind":"parameter","displayName":"Team Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the Team Drive","optional":false}}},"update":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.TeamDrive","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.TeamDrive","optional":false},"teamDriveId":{"index":1,"kind":"parameter","displayName":"Team Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the Team Drive","optional":false}}}}}}} +{"component":{"kind":"component","name":"google-drive","title":"Google Drive","description":"Manage files in Google Drive.","deprecated":false,"firstVersion":"2.14.0","label":"file,cloud,api","javaType":"org.apache.camel.component.google.drive.GoogleDriveComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-drive","version":"4.8.2","scheme":"google-drive","extendsScheme":"","syntax":"google-drive:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.google.drive.internal.GoogleDriveApiName","enum":["DRIVE_ABOUT","DRIVE_CHANGES","DRIVE_CHANNELS","DRIVE_COMMENTS","DRIVE_DRIVES","DRIVE_FILES","DRIVE_PERMISSIONS","DRIVE_REPLIES","DRIVE_REVISIONS","DRIVE_TEAMDRIVES"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["copy","delete","get","getIdForEmail","insert","list","patch","stop","touch","trash","untrash","update","watch"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"applicationName":{"index":2,"kind":"parameter","displayName":"Application Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"Google drive application name. Example would be camel-google-drive/1.0"},"clientFactory":{"index":3,"kind":"parameter","displayName":"Client Factory","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.google.drive.GoogleDriveClientFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory"},"clientId":{"index":4,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"Client ID of the drive application"},"delegate":{"index":5,"kind":"parameter","displayName":"Delegate","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"Delegate for wide-domain service account"},"inBody":{"index":6,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"scopes":{"index":7,"kind":"parameter","displayName":"Scopes","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"Specifies the level of permissions you want a drive application to have to a user account. See https://developers.google.com/drive/web/scopes for more info."},"sendEmptyMessageWhenIdle":{"index":8,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":12,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":13,"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."},"backoffErrorThreshold":{"index":14,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":16,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":17,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":18,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":19,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":20,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":21,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":22,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":23,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":24,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":25,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":26,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":27,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":28,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."},"clientSecret":{"index":29,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"Client secret of the drive application"},"refreshToken":{"index":30,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."},"serviceAccountKey":{"index":31,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.drive.GoogleDriveConfiguration","configurationField":"configuration","description":"Service account key in json format to authenticate an application as a service account. Accept base64 adding the prefix base64:"}},"apis":{"drive-changes":{"consumerOnly":false,"producerOnly":false,"description":"The changes collection of methods","methods":{"list":{"description":"Lists the changes for a user or shared drive","signatures":["com.google.api.services.drive.Drive$Changes$List list(String pageToken)"]},"watch":{"description":"Subscribes to changes for a user","signatures":["com.google.api.services.drive.Drive$Changes$Watch watch(String pageToken, com.google.api.services.drive.model.Channel content)"]}}},"drive-channels":{"consumerOnly":false,"producerOnly":false,"description":"The channels collection of methods","methods":{"stop":{"description":"Stops watching resources through this channel","signatures":["com.google.api.services.drive.Drive$Channels$Stop stop(com.google.api.services.drive.model.Channel content)"]}}},"drive-comments":{"consumerOnly":false,"producerOnly":false,"description":"The comments collection of methods","methods":{"create":{"description":"Creates a comment on a file","signatures":["com.google.api.services.drive.Drive$Comments$Create create(String fileId, com.google.api.services.drive.model.Comment content)"]},"delete":{"description":"Deletes a comment","signatures":["com.google.api.services.drive.Drive$Comments$Delete delete(String fileId, String commentId)"]},"get":{"description":"Gets a comment by ID","signatures":["com.google.api.services.drive.Drive$Comments$Get get(String fileId, String commentId)"]},"list":{"description":"Lists a file's comments","signatures":["com.google.api.services.drive.Drive$Comments$List list(String fileId)"]},"update":{"description":"Updates a comment with patch semantics","signatures":["com.google.api.services.drive.Drive$Comments$Update update(String fileId, String commentId, com.google.api.services.drive.model.Comment content)"]}}},"drive-drives":{"consumerOnly":false,"producerOnly":false,"description":"The drives collection of methods","methods":{"create":{"description":"Creates a shared drive","signatures":["com.google.api.services.drive.Drive$Drives$Create create(String requestId, com.google.api.services.drive.model.Drive content)"]},"delete":{"description":"Permanently deletes a shared drive for which the user is an organizer","signatures":["com.google.api.services.drive.Drive$Drives$Delete delete(String driveId)"]},"get":{"description":"Gets a shared drive's metadata by ID","signatures":["com.google.api.services.drive.Drive$Drives$Get get(String driveId)"]},"hide":{"description":"Hides a shared drive from the default view","signatures":["com.google.api.services.drive.Drive$Drives$Hide hide(String driveId)"]},"unhide":{"description":"Restores a shared drive to the default view","signatures":["com.google.api.services.drive.Drive$Drives$Unhide unhide(String driveId)"]},"update":{"description":"Updates the metadata for a shared drive","signatures":["com.google.api.services.drive.Drive$Drives$Update update(String driveId, com.google.api.services.drive.model.Drive content)"]}}},"drive-files":{"consumerOnly":false,"producerOnly":false,"description":"The files collection of methods","methods":{"copy":{"description":"Creates a copy of a file and applies any requested updates with patch semantics","signatures":["com.google.api.services.drive.Drive$Files$Copy copy(String fileId, com.google.api.services.drive.model.File content)"]},"create":{"description":"Creates a new file","signatures":["com.google.api.services.drive.Drive$Files$Create create(com.google.api.services.drive.model.File content)","com.google.api.services.drive.Drive$Files$Create create(com.google.api.services.drive.model.File content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]},"delete":{"description":"Permanently deletes a file owned by the user without moving it to the trash","signatures":["com.google.api.services.drive.Drive$Files$Delete delete(String fileId)"]},"export":{"description":"Exports a Google Workspace document to the requested MIME type and returns exported byte content","signatures":["com.google.api.services.drive.Drive$Files$Export export(String fileId, String mimeType)"]},"get":{"description":"Gets a file's metadata or content by ID","signatures":["com.google.api.services.drive.Drive$Files$Get get(String fileId)"]},"listLabels":{"description":"Lists the labels on a file","signatures":["com.google.api.services.drive.Drive$Files$ListLabels listLabels(String fileId)"]},"modifyLabels":{"description":"Modifies the set of labels applied to a file","signatures":["com.google.api.services.drive.Drive$Files$ModifyLabels modifyLabels(String fileId, com.google.api.services.drive.model.ModifyLabelsRequest content)"]},"update":{"description":"Updates a file's metadata and/or content","signatures":["com.google.api.services.drive.Drive$Files$Update update(String fileId, com.google.api.services.drive.model.File content)","com.google.api.services.drive.Drive$Files$Update update(String fileId, com.google.api.services.drive.model.File content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]},"watch":{"description":"Subscribes to changes to a file","signatures":["com.google.api.services.drive.Drive$Files$Watch watch(String fileId, com.google.api.services.drive.model.Channel content)"]}}},"drive-permissions":{"consumerOnly":false,"producerOnly":false,"description":"The permissions collection of methods","methods":{"create":{"description":"Creates a permission for a file or shared drive","signatures":["com.google.api.services.drive.Drive$Permissions$Create create(String fileId, com.google.api.services.drive.model.Permission content)"]},"delete":{"description":"Deletes a permission","signatures":["com.google.api.services.drive.Drive$Permissions$Delete delete(String fileId, String permissionId)"]},"get":{"description":"Gets a permission by ID","signatures":["com.google.api.services.drive.Drive$Permissions$Get get(String fileId, String permissionId)"]},"list":{"description":"Lists a file's or shared drive's permissions","signatures":["com.google.api.services.drive.Drive$Permissions$List list(String fileId)"]},"update":{"description":"Updates a permission with patch semantics","signatures":["com.google.api.services.drive.Drive$Permissions$Update update(String fileId, String permissionId, com.google.api.services.drive.model.Permission content)"]}}},"drive-replies":{"consumerOnly":false,"producerOnly":false,"description":"The replies collection of methods","methods":{"create":{"description":"Creates a reply to a comment","signatures":["com.google.api.services.drive.Drive$Replies$Create create(String fileId, String commentId, com.google.api.services.drive.model.Reply content)"]},"delete":{"description":"Deletes a reply","signatures":["com.google.api.services.drive.Drive$Replies$Delete delete(String fileId, String commentId, String replyId)"]},"get":{"description":"Gets a reply by ID","signatures":["com.google.api.services.drive.Drive$Replies$Get get(String fileId, String commentId, String replyId)"]},"list":{"description":"Lists a comment's replies","signatures":["com.google.api.services.drive.Drive$Replies$List list(String fileId, String commentId)"]},"update":{"description":"Updates a reply with patch semantics","signatures":["com.google.api.services.drive.Drive$Replies$Update update(String fileId, String commentId, String replyId, com.google.api.services.drive.model.Reply content)"]}}},"drive-revisions":{"consumerOnly":false,"producerOnly":false,"description":"The revisions collection of methods","methods":{"delete":{"description":"Permanently deletes a file version","signatures":["com.google.api.services.drive.Drive$Revisions$Delete delete(String fileId, String revisionId)"]},"get":{"description":"Gets a revision's metadata or content by ID","signatures":["com.google.api.services.drive.Drive$Revisions$Get get(String fileId, String revisionId)"]},"list":{"description":"Lists a file's revisions","signatures":["com.google.api.services.drive.Drive$Revisions$List list(String fileId)"]},"update":{"description":"Updates a revision with patch semantics","signatures":["com.google.api.services.drive.Drive$Revisions$Update update(String fileId, String revisionId, com.google.api.services.drive.model.Revision content)"]}}},"drive-teamdrives":{"consumerOnly":false,"producerOnly":false,"description":"The teamdrives collection of methods","methods":{"create":{"description":"Deprecated: Use drives","signatures":["com.google.api.services.drive.Drive$Teamdrives$Create create(String requestId, com.google.api.services.drive.model.TeamDrive content)"]},"delete":{"description":"Deprecated: Use drives","signatures":["com.google.api.services.drive.Drive$Teamdrives$Delete delete(String teamDriveId)"]},"get":{"description":"Deprecated: Use drives","signatures":["com.google.api.services.drive.Drive$Teamdrives$Get get(String teamDriveId)"]},"update":{"description":"Deprecated: Use drives","signatures":["com.google.api.services.drive.Drive$Teamdrives$Update update(String teamDriveId, com.google.api.services.drive.model.TeamDrive content)"]}}}},"apiProperties":{"drive-changes":{"methods":{"list":{"properties":{"pageToken":{"index":0,"kind":"parameter","displayName":"Page Token","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.","optional":false}}},"watch":{"properties":{"contentChannel":{"index":0,"kind":"parameter","displayName":"Content Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Channel","optional":false},"pageToken":{"index":1,"kind":"parameter","displayName":"Page Token","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.","optional":false}}}}},"drive-channels":{"methods":{"stop":{"properties":{"contentChannel":{"index":0,"kind":"parameter","displayName":"Content Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Channel","optional":false}}}}},"drive-comments":{"methods":{"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Comment","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Comment","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"delete":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"get":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"list":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"update":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Comment","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Comment","optional":false},"fileId":{"index":2,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}}}},"drive-drives":{"methods":{"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Drive","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Drive","optional":false},"requestId":{"index":1,"kind":"parameter","displayName":"Request Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.","optional":false}}},"delete":{"properties":{"driveId":{"index":0,"kind":"parameter","displayName":"Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the shared drive","optional":false}}},"get":{"properties":{"driveId":{"index":0,"kind":"parameter","displayName":"Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the shared drive","optional":false}}},"hide":{"properties":{"driveId":{"index":0,"kind":"parameter","displayName":"Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the shared drive","optional":false}}},"unhide":{"properties":{"driveId":{"index":0,"kind":"parameter","displayName":"Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the shared drive","optional":false}}},"update":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Drive","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Drive","optional":false},"driveId":{"index":1,"kind":"parameter","displayName":"Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the shared drive","optional":false}}}}},"drive-files":{"methods":{"copy":{"properties":{"file":{"index":0,"kind":"parameter","displayName":"File","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.File","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.File","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.File","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.File media metadata or null if none","optional":false},"mediaContent":{"index":1,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false}}},"delete":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"export":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"mimeType":{"index":1,"kind":"parameter","displayName":"Mime Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Required. The MIME type of the format requested for this export.","optional":false}}},"get":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"listLabels":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID for the file","optional":false}}},"modifyLabels":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file to which the labels belong","optional":false},"modifyLabelsRequest":{"index":1,"kind":"parameter","displayName":"Modify Labels Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.ModifyLabelsRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.ModifyLabelsRequest","optional":false}}},"update":{"properties":{"file":{"index":0,"kind":"parameter","displayName":"File","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.File","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.File media metadata or null if none","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"mediaContent":{"index":2,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false}}},"watch":{"properties":{"channel":{"index":0,"kind":"parameter","displayName":"Channel","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Channel","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Channel","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}}}},"drive-permissions":{"methods":{"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Permission","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Permission","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file or shared drive","optional":false}}},"delete":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file or shared drive","optional":false},"permissionId":{"index":1,"kind":"parameter","displayName":"Permission Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the permission","optional":false}}},"get":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"permissionId":{"index":1,"kind":"parameter","displayName":"Permission Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the permission","optional":false}}},"list":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file or shared drive","optional":false}}},"update":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Permission","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Permission","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file or shared drive","optional":false},"permissionId":{"index":2,"kind":"parameter","displayName":"Permission Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the permission","optional":false}}}}},"drive-replies":{"methods":{"create":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Reply","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Reply","optional":false},"fileId":{"index":2,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"delete":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"replyId":{"index":2,"kind":"parameter","displayName":"Reply Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the reply","optional":false}}},"get":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"replyId":{"index":2,"kind":"parameter","displayName":"Reply Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the reply","optional":false}}},"list":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"update":{"properties":{"commentId":{"index":0,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the comment","optional":false},"content":{"index":1,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Reply","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Reply","optional":false},"fileId":{"index":2,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"replyId":{"index":3,"kind":"parameter","displayName":"Reply Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the reply","optional":false}}}}},"drive-revisions":{"methods":{"delete":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"revisionId":{"index":1,"kind":"parameter","displayName":"Revision Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the revision","optional":false}}},"get":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"revisionId":{"index":1,"kind":"parameter","displayName":"Revision Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the revision","optional":false}}},"list":{"properties":{"fileId":{"index":0,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false}}},"update":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.Revision","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.Revision","optional":false},"fileId":{"index":1,"kind":"parameter","displayName":"File Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the file","optional":false},"revisionId":{"index":2,"kind":"parameter","displayName":"Revision Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the revision","optional":false}}}}},"drive-teamdrives":{"methods":{"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.TeamDrive","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.TeamDrive","optional":false},"requestId":{"index":1,"kind":"parameter","displayName":"Request Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.","optional":false}}},"delete":{"properties":{"teamDriveId":{"index":0,"kind":"parameter","displayName":"Team Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the Team Drive","optional":false}}},"get":{"properties":{"teamDriveId":{"index":0,"kind":"parameter","displayName":"Team Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the Team Drive","optional":false}}},"update":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.drive.model.TeamDrive","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.drive.model.TeamDrive","optional":false},"teamDriveId":{"index":1,"kind":"parameter","displayName":"Team Drive Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the Team Drive","optional":false}}}}}}} , -{"component":{"kind":"component","name":"google-functions","title":"Google Cloud Functions","description":"Manage and invoke Google Cloud Functions","deprecated":false,"firstVersion":"3.9.0","label":"cloud","javaType":"org.apache.camel.component.google.functions.GoogleCloudFunctionsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-functions","version":"4.8.1","scheme":"google-functions","extendsScheme":"","syntax":"google-functions:functionName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"GoogleCloudFunctionsOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.google.functions.GoogleCloudFunctionsOperations","enum":["listFunctions","getFunction","callFunction","generateDownloadUrl","generateUploadUrl","createFunction","updateFunction","deleteFunction"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConstants#OPERATION"},"GoogleCloudFunctionsEntryPoint":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the function (as defined in source code) that will be executed. Used for createFunction operation","constantName":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConstants#ENTRY_POINT"},"GoogleCloudFunctionsRuntime":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The runtime in which to run the function. Possible values are: nodejs10 nodejs12 nodejs14 python37 python38 python39 go111 go113 java11 dotnet3 ruby26 nodejs6 nodejs8 Used for createFunction operation.","constantName":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConstants#RUNTIME"},"GoogleCloudFunctionsSourceArchiveUrl":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. Used for createFunction operation.","constantName":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConstants#SOURCE_ARCHIVE_URL"},"GoogleCloudFunctionsResponseObject":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response object resulting from the Google Functions Client invocation","constantName":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConstants#RESPONSE_OBJECT"}},"properties":{"functionName":{"index":0,"kind":"path","displayName":"Function Name","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConfiguration","configurationField":"configuration","description":"The user-defined name of the function"},"serviceAccountKey":{"index":1,"kind":"parameter","displayName":"Service Account Key","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConfiguration","configurationField":"configuration","description":"Service account key to authenticate an application as a service account"},"location":{"index":2,"kind":"parameter","displayName":"Location","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConfiguration","configurationField":"configuration","description":"The Google Cloud Location (Region) where the Function is located"},"operation":{"index":3,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.google.functions.GoogleCloudFunctionsOperations","enum":["listFunctions","getFunction","callFunction","generateDownloadUrl","generateUploadUrl","createFunction","updateFunction","deleteFunction"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConfiguration","configurationField":"configuration","description":"The operation to perform on the producer."},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConfiguration","configurationField":"configuration","description":"Specifies if the request is a pojo request"},"project":{"index":5,"kind":"parameter","displayName":"Project","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConfiguration","configurationField":"configuration","description":"The Google Cloud Project name where the Function is located"},"lazyStartProducer":{"index":6,"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."},"client":{"index":7,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.google.cloud.functions.v1.CloudFunctionsServiceClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConfiguration","configurationField":"configuration","description":"The client to use during service invocation."}}} +{"component":{"kind":"component","name":"google-functions","title":"Google Cloud Functions","description":"Manage and invoke Google Cloud Functions","deprecated":false,"firstVersion":"3.9.0","label":"cloud","javaType":"org.apache.camel.component.google.functions.GoogleCloudFunctionsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-functions","version":"4.8.2","scheme":"google-functions","extendsScheme":"","syntax":"google-functions:functionName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"GoogleCloudFunctionsOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.google.functions.GoogleCloudFunctionsOperations","enum":["listFunctions","getFunction","callFunction","generateDownloadUrl","generateUploadUrl","createFunction","updateFunction","deleteFunction"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConstants#OPERATION"},"GoogleCloudFunctionsEntryPoint":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the function (as defined in source code) that will be executed. Used for createFunction operation","constantName":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConstants#ENTRY_POINT"},"GoogleCloudFunctionsRuntime":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The runtime in which to run the function. Possible values are: nodejs10 nodejs12 nodejs14 python37 python38 python39 go111 go113 java11 dotnet3 ruby26 nodejs6 nodejs8 Used for createFunction operation.","constantName":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConstants#RUNTIME"},"GoogleCloudFunctionsSourceArchiveUrl":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. Used for createFunction operation.","constantName":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConstants#SOURCE_ARCHIVE_URL"},"GoogleCloudFunctionsResponseObject":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response object resulting from the Google Functions Client invocation","constantName":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConstants#RESPONSE_OBJECT"}},"properties":{"functionName":{"index":0,"kind":"path","displayName":"Function Name","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConfiguration","configurationField":"configuration","description":"The user-defined name of the function"},"serviceAccountKey":{"index":1,"kind":"parameter","displayName":"Service Account Key","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConfiguration","configurationField":"configuration","description":"Service account key to authenticate an application as a service account"},"location":{"index":2,"kind":"parameter","displayName":"Location","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConfiguration","configurationField":"configuration","description":"The Google Cloud Location (Region) where the Function is located"},"operation":{"index":3,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.google.functions.GoogleCloudFunctionsOperations","enum":["listFunctions","getFunction","callFunction","generateDownloadUrl","generateUploadUrl","createFunction","updateFunction","deleteFunction"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConfiguration","configurationField":"configuration","description":"The operation to perform on the producer."},"pojoRequest":{"index":4,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConfiguration","configurationField":"configuration","description":"Specifies if the request is a pojo request"},"project":{"index":5,"kind":"parameter","displayName":"Project","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConfiguration","configurationField":"configuration","description":"The Google Cloud Project name where the Function is located"},"lazyStartProducer":{"index":6,"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."},"client":{"index":7,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.google.cloud.functions.v1.CloudFunctionsServiceClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.google.functions.GoogleCloudFunctionsConfiguration","configurationField":"configuration","description":"The client to use during service invocation."}}} , -{"component":{"kind":"component","name":"google-mail","title":"Google Mail","description":"Manage messages in Google Mail.","deprecated":false,"firstVersion":"2.15.0","label":"cloud,api,mail","javaType":"org.apache.camel.component.google.mail.GoogleMailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-mail","version":"4.8.1","scheme":"google-mail","extendsScheme":"","syntax":"google-mail:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.google.mail.internal.GoogleMailApiName","enum":["THREADS","MESSAGES","ATTACHMENTS","LABELS","HISTORY","DRAFTS","USERS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["attachments","create","delete","get","getProfile","gmailImport","insert","list","modify","patch","send","stop","trash","untrash","update","watch"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"applicationName":{"index":2,"kind":"parameter","displayName":"Application Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"Google mail application name. Example would be camel-google-mail/1.0"},"clientId":{"index":3,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"Client ID of the mail application"},"delegate":{"index":4,"kind":"parameter","displayName":"Delegate","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"Delegate for wide-domain service account"},"inBody":{"index":5,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"scopes":{"index":6,"kind":"parameter","displayName":"Scopes","group":"common","label":"","required":false,"type":"array","javaType":"java.util.Collection","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"GMail scopes"},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":12,"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."},"backoffErrorThreshold":{"index":13,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":14,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":15,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":16,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":17,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":18,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":19,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":20,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":21,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":22,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":23,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":24,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":25,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":26,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":27,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."},"clientSecret":{"index":28,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"Client secret of the mail application"},"refreshToken":{"index":29,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."},"serviceAccountKey":{"index":30,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"Service account key in json format to authenticate an application as a service account. Accept base64 adding the prefix base64:"}},"apis":{"attachments":{"consumerOnly":false,"producerOnly":false,"description":"The attachments collection of methods","methods":{"get":{"description":"Gets the specified message attachment","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Attachments$Get get(String userId, String messageId, String id)"]}}},"drafts":{"consumerOnly":false,"producerOnly":false,"description":"The drafts collection of methods","methods":{"create":{"description":"Creates a new draft with the DRAFT label","signatures":["com.google.api.services.gmail.Gmail$Users$Drafts$Create create(String userId, com.google.api.services.gmail.model.Draft content)","com.google.api.services.gmail.Gmail$Users$Drafts$Create create(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]},"delete":{"description":"Immediately and permanently deletes the specified draft","signatures":["com.google.api.services.gmail.Gmail$Users$Drafts$Delete delete(String userId, String id)"]},"get":{"description":"Gets the specified draft","signatures":["com.google.api.services.gmail.Gmail$Users$Drafts$Get get(String userId, String id)"]},"list":{"description":"Lists the drafts in the user's mailbox","signatures":["com.google.api.services.gmail.Gmail$Users$Drafts$List list(String userId)"]},"send":{"description":"Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers","signatures":["com.google.api.services.gmail.Gmail$Users$Drafts$Send send(String userId, com.google.api.services.gmail.model.Draft content)","com.google.api.services.gmail.Gmail$Users$Drafts$Send send(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]},"update":{"description":"Replaces a draft's content","signatures":["com.google.api.services.gmail.Gmail$Users$Drafts$Update update(String userId, String id, com.google.api.services.gmail.model.Draft content)","com.google.api.services.gmail.Gmail$Users$Drafts$Update update(String userId, String id, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]}}},"history":{"consumerOnly":false,"producerOnly":false,"description":"The history collection of methods","methods":{"list":{"description":"Lists the history of all changes to the given mailbox","signatures":["com.google.api.services.gmail.Gmail$Users$History$List list(String userId)"]}}},"labels":{"consumerOnly":false,"producerOnly":false,"description":"The labels collection of methods","methods":{"create":{"description":"Creates a new label","signatures":["com.google.api.services.gmail.Gmail$Users$Labels$Create create(String userId, com.google.api.services.gmail.model.Label content)"]},"delete":{"description":"Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to","signatures":["com.google.api.services.gmail.Gmail$Users$Labels$Delete delete(String userId, String id)"]},"get":{"description":"Gets the specified label","signatures":["com.google.api.services.gmail.Gmail$Users$Labels$Get get(String userId, String id)"]},"list":{"description":"Lists all labels in the user's mailbox","signatures":["com.google.api.services.gmail.Gmail$Users$Labels$List list(String userId)"]},"patch":{"description":"Patch the specified label","signatures":["com.google.api.services.gmail.Gmail$Users$Labels$Patch patch(String userId, String id, com.google.api.services.gmail.model.Label content)"]},"update":{"description":"Updates the specified label","signatures":["com.google.api.services.gmail.Gmail$Users$Labels$Update update(String userId, String id, com.google.api.services.gmail.model.Label content)"]}}},"messages":{"consumerOnly":false,"producerOnly":false,"description":"The messages collection of methods","methods":{"batchDelete":{"description":"Deletes many messages by message ID","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$BatchDelete batchDelete(String userId, com.google.api.services.gmail.model.BatchDeleteMessagesRequest content)"]},"batchModify":{"description":"Modifies the labels on the specified messages","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$BatchModify batchModify(String userId, com.google.api.services.gmail.model.BatchModifyMessagesRequest content)"]},"delete":{"description":"Immediately and permanently deletes the specified message","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Delete delete(String userId, String id)"]},"get":{"description":"Gets the specified message","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Get get(String userId, String id)"]},"gmailImport":{"description":"Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content)","com.google.api.services.gmail.Gmail$Users$Messages$GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]},"insert":{"description":"Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Insert insert(String userId, com.google.api.services.gmail.model.Message content)","com.google.api.services.gmail.Gmail$Users$Messages$Insert insert(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]},"list":{"description":"Lists the messages in the user's mailbox","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$List list(String userId)"]},"modify":{"description":"Modifies the labels on the specified message","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyMessageRequest content)"]},"send":{"description":"Sends the specified message to the recipients in the To, Cc, and Bcc headers","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Send send(String userId, com.google.api.services.gmail.model.Message content)","com.google.api.services.gmail.Gmail$Users$Messages$Send send(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]},"trash":{"description":"Moves the specified message to the trash","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Trash trash(String userId, String id)"]},"untrash":{"description":"Removes the specified message from the trash","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Untrash untrash(String userId, String id)"]}}},"threads":{"consumerOnly":false,"producerOnly":false,"description":"The threads collection of methods","methods":{"delete":{"description":"Immediately and permanently deletes the specified thread","signatures":["com.google.api.services.gmail.Gmail$Users$Threads$Delete delete(String userId, String id)"]},"get":{"description":"Gets the specified thread","signatures":["com.google.api.services.gmail.Gmail$Users$Threads$Get get(String userId, String id)"]},"list":{"description":"Lists the threads in the user's mailbox","signatures":["com.google.api.services.gmail.Gmail$Users$Threads$List list(String userId)"]},"modify":{"description":"Modifies the labels applied to the thread","signatures":["com.google.api.services.gmail.Gmail$Users$Threads$Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyThreadRequest content)"]},"trash":{"description":"Moves the specified thread to the trash","signatures":["com.google.api.services.gmail.Gmail$Users$Threads$Trash trash(String userId, String id)"]},"untrash":{"description":"Removes the specified thread from the trash","signatures":["com.google.api.services.gmail.Gmail$Users$Threads$Untrash untrash(String userId, String id)"]}}},"users":{"consumerOnly":false,"producerOnly":false,"description":"The users collection of methods","methods":{"getProfile":{"description":"Gets the current user's Gmail profile","signatures":["com.google.api.services.gmail.Gmail$Users$GetProfile getProfile(String userId)"]},"stop":{"description":"Stop receiving push notifications for the given user mailbox","signatures":["com.google.api.services.gmail.Gmail$Users$Stop stop(String userId)"]},"watch":{"description":"Set up or update a push notification watch on the given user mailbox","signatures":["com.google.api.services.gmail.Gmail$Users$Watch watch(String userId, com.google.api.services.gmail.model.WatchRequest content)"]}}}},"apiProperties":{"attachments":{"methods":{"get":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the attachment","optional":false},"messageId":{"index":1,"kind":"parameter","displayName":"Message Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the message containing the attachment","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}}}},"drafts":{"methods":{"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Draft","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Draft media metadata or null if none","optional":false},"mediaContent":{"index":1,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false},"userId":{"index":3,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"delete":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the draft to delete","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"get":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the draft to retrieve","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"list":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"send":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Draft","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Draft media metadata or null if none","optional":false},"mediaContent":{"index":1,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false},"userId":{"index":3,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"update":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Draft","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Draft media metadata or null if none","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"mediaContent":{"index":2,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false},"userId":{"index":4,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}}}},"history":{"methods":{"list":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}}}},"labels":{"methods":{"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Label","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Label","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"delete":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the label to delete","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"get":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the label to retrieve","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"list":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"patch":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Label","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Label","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the label to update","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"update":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Label","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Label","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the label to update","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}}}},"messages":{"methods":{"batchDelete":{"properties":{"batchDeleteMessagesRequest":{"index":0,"kind":"parameter","displayName":"Batch Delete Messages Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.BatchDeleteMessagesRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.BatchDeleteMessagesRequest","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"batchModify":{"properties":{"batchModifyMessagesRequest":{"index":0,"kind":"parameter","displayName":"Batch Modify Messages Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.BatchModifyMessagesRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.BatchModifyMessagesRequest","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"delete":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the message to delete","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"get":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the message to retrieve. This ID is usually retrieved using messages.list. The ID is also contained in the result when a message is inserted (messages.insert) or imported (messages.import).","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"gmailImport":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Message","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Message media metadata or null if none","optional":false},"mediaContent":{"index":1,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"insert":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Message","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Message media metadata or null if none","optional":false},"mediaContent":{"index":1,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"list":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"modify":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the message to modify","optional":false},"modifyMessageRequest":{"index":1,"kind":"parameter","displayName":"Modify Message Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.ModifyMessageRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.ModifyMessageRequest","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"send":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Message","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Message media metadata or null if none","optional":false},"mediaContent":{"index":1,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"trash":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the message to Trash","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"untrash":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the message to remove from Trash","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}}}},"threads":{"methods":{"delete":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"ID of the Thread to delete","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"get":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the thread to retrieve","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"list":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"modify":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.ModifyThreadRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.ModifyThreadRequest","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the thread to modify","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"trash":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the thread to Trash","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"untrash":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the thread to remove from Trash","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}}}},"users":{"methods":{"getProfile":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"stop":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"watch":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.WatchRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.WatchRequest","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}}}}}} +{"component":{"kind":"component","name":"google-mail","title":"Google Mail","description":"Manage messages in Google Mail.","deprecated":false,"firstVersion":"2.15.0","label":"cloud,api,mail","javaType":"org.apache.camel.component.google.mail.GoogleMailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-mail","version":"4.8.2","scheme":"google-mail","extendsScheme":"","syntax":"google-mail:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.google.mail.internal.GoogleMailApiName","enum":["THREADS","MESSAGES","ATTACHMENTS","LABELS","HISTORY","DRAFTS","USERS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["attachments","create","delete","get","getProfile","gmailImport","insert","list","modify","patch","send","stop","trash","untrash","update","watch"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"applicationName":{"index":2,"kind":"parameter","displayName":"Application Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"Google mail application name. Example would be camel-google-mail/1.0"},"clientId":{"index":3,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"Client ID of the mail application"},"delegate":{"index":4,"kind":"parameter","displayName":"Delegate","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"Delegate for wide-domain service account"},"inBody":{"index":5,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"scopes":{"index":6,"kind":"parameter","displayName":"Scopes","group":"common","label":"","required":false,"type":"array","javaType":"java.util.Collection","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"GMail scopes"},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":12,"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."},"backoffErrorThreshold":{"index":13,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":14,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":15,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":16,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":17,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":18,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":19,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":20,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":21,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":22,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":23,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":24,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":25,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":26,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":27,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."},"clientSecret":{"index":28,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"Client secret of the mail application"},"refreshToken":{"index":29,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."},"serviceAccountKey":{"index":30,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.GoogleMailConfiguration","configurationField":"configuration","description":"Service account key in json format to authenticate an application as a service account. Accept base64 adding the prefix base64:"}},"apis":{"attachments":{"consumerOnly":false,"producerOnly":false,"description":"The attachments collection of methods","methods":{"get":{"description":"Gets the specified message attachment","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Attachments$Get get(String userId, String messageId, String id)"]}}},"drafts":{"consumerOnly":false,"producerOnly":false,"description":"The drafts collection of methods","methods":{"create":{"description":"Creates a new draft with the DRAFT label","signatures":["com.google.api.services.gmail.Gmail$Users$Drafts$Create create(String userId, com.google.api.services.gmail.model.Draft content)","com.google.api.services.gmail.Gmail$Users$Drafts$Create create(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]},"delete":{"description":"Immediately and permanently deletes the specified draft","signatures":["com.google.api.services.gmail.Gmail$Users$Drafts$Delete delete(String userId, String id)"]},"get":{"description":"Gets the specified draft","signatures":["com.google.api.services.gmail.Gmail$Users$Drafts$Get get(String userId, String id)"]},"list":{"description":"Lists the drafts in the user's mailbox","signatures":["com.google.api.services.gmail.Gmail$Users$Drafts$List list(String userId)"]},"send":{"description":"Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers","signatures":["com.google.api.services.gmail.Gmail$Users$Drafts$Send send(String userId, com.google.api.services.gmail.model.Draft content)","com.google.api.services.gmail.Gmail$Users$Drafts$Send send(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]},"update":{"description":"Replaces a draft's content","signatures":["com.google.api.services.gmail.Gmail$Users$Drafts$Update update(String userId, String id, com.google.api.services.gmail.model.Draft content)","com.google.api.services.gmail.Gmail$Users$Drafts$Update update(String userId, String id, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]}}},"history":{"consumerOnly":false,"producerOnly":false,"description":"The history collection of methods","methods":{"list":{"description":"Lists the history of all changes to the given mailbox","signatures":["com.google.api.services.gmail.Gmail$Users$History$List list(String userId)"]}}},"labels":{"consumerOnly":false,"producerOnly":false,"description":"The labels collection of methods","methods":{"create":{"description":"Creates a new label","signatures":["com.google.api.services.gmail.Gmail$Users$Labels$Create create(String userId, com.google.api.services.gmail.model.Label content)"]},"delete":{"description":"Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to","signatures":["com.google.api.services.gmail.Gmail$Users$Labels$Delete delete(String userId, String id)"]},"get":{"description":"Gets the specified label","signatures":["com.google.api.services.gmail.Gmail$Users$Labels$Get get(String userId, String id)"]},"list":{"description":"Lists all labels in the user's mailbox","signatures":["com.google.api.services.gmail.Gmail$Users$Labels$List list(String userId)"]},"patch":{"description":"Patch the specified label","signatures":["com.google.api.services.gmail.Gmail$Users$Labels$Patch patch(String userId, String id, com.google.api.services.gmail.model.Label content)"]},"update":{"description":"Updates the specified label","signatures":["com.google.api.services.gmail.Gmail$Users$Labels$Update update(String userId, String id, com.google.api.services.gmail.model.Label content)"]}}},"messages":{"consumerOnly":false,"producerOnly":false,"description":"The messages collection of methods","methods":{"batchDelete":{"description":"Deletes many messages by message ID","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$BatchDelete batchDelete(String userId, com.google.api.services.gmail.model.BatchDeleteMessagesRequest content)"]},"batchModify":{"description":"Modifies the labels on the specified messages","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$BatchModify batchModify(String userId, com.google.api.services.gmail.model.BatchModifyMessagesRequest content)"]},"delete":{"description":"Immediately and permanently deletes the specified message","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Delete delete(String userId, String id)"]},"get":{"description":"Gets the specified message","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Get get(String userId, String id)"]},"gmailImport":{"description":"Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content)","com.google.api.services.gmail.Gmail$Users$Messages$GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]},"insert":{"description":"Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Insert insert(String userId, com.google.api.services.gmail.model.Message content)","com.google.api.services.gmail.Gmail$Users$Messages$Insert insert(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]},"list":{"description":"Lists the messages in the user's mailbox","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$List list(String userId)"]},"modify":{"description":"Modifies the labels on the specified message","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyMessageRequest content)"]},"send":{"description":"Sends the specified message to the recipients in the To, Cc, and Bcc headers","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Send send(String userId, com.google.api.services.gmail.model.Message content)","com.google.api.services.gmail.Gmail$Users$Messages$Send send(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent)"]},"trash":{"description":"Moves the specified message to the trash","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Trash trash(String userId, String id)"]},"untrash":{"description":"Removes the specified message from the trash","signatures":["com.google.api.services.gmail.Gmail$Users$Messages$Untrash untrash(String userId, String id)"]}}},"threads":{"consumerOnly":false,"producerOnly":false,"description":"The threads collection of methods","methods":{"delete":{"description":"Immediately and permanently deletes the specified thread","signatures":["com.google.api.services.gmail.Gmail$Users$Threads$Delete delete(String userId, String id)"]},"get":{"description":"Gets the specified thread","signatures":["com.google.api.services.gmail.Gmail$Users$Threads$Get get(String userId, String id)"]},"list":{"description":"Lists the threads in the user's mailbox","signatures":["com.google.api.services.gmail.Gmail$Users$Threads$List list(String userId)"]},"modify":{"description":"Modifies the labels applied to the thread","signatures":["com.google.api.services.gmail.Gmail$Users$Threads$Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyThreadRequest content)"]},"trash":{"description":"Moves the specified thread to the trash","signatures":["com.google.api.services.gmail.Gmail$Users$Threads$Trash trash(String userId, String id)"]},"untrash":{"description":"Removes the specified thread from the trash","signatures":["com.google.api.services.gmail.Gmail$Users$Threads$Untrash untrash(String userId, String id)"]}}},"users":{"consumerOnly":false,"producerOnly":false,"description":"The users collection of methods","methods":{"getProfile":{"description":"Gets the current user's Gmail profile","signatures":["com.google.api.services.gmail.Gmail$Users$GetProfile getProfile(String userId)"]},"stop":{"description":"Stop receiving push notifications for the given user mailbox","signatures":["com.google.api.services.gmail.Gmail$Users$Stop stop(String userId)"]},"watch":{"description":"Set up or update a push notification watch on the given user mailbox","signatures":["com.google.api.services.gmail.Gmail$Users$Watch watch(String userId, com.google.api.services.gmail.model.WatchRequest content)"]}}}},"apiProperties":{"attachments":{"methods":{"get":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the attachment","optional":false},"messageId":{"index":1,"kind":"parameter","displayName":"Message Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the message containing the attachment","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}}}},"drafts":{"methods":{"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Draft","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Draft media metadata or null if none","optional":false},"mediaContent":{"index":1,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false},"userId":{"index":3,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"delete":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the draft to delete","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"get":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the draft to retrieve","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"list":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"send":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Draft","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Draft media metadata or null if none","optional":false},"mediaContent":{"index":1,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false},"userId":{"index":3,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"update":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Draft","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Draft media metadata or null if none","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"mediaContent":{"index":2,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false},"userId":{"index":4,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}}}},"history":{"methods":{"list":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}}}},"labels":{"methods":{"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Label","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Label","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"delete":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the label to delete","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"get":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the label to retrieve","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"list":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"patch":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Label","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Label","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the label to update","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"update":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Label","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Label","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the label to update","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}}}},"messages":{"methods":{"batchDelete":{"properties":{"batchDeleteMessagesRequest":{"index":0,"kind":"parameter","displayName":"Batch Delete Messages Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.BatchDeleteMessagesRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.BatchDeleteMessagesRequest","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"batchModify":{"properties":{"batchModifyMessagesRequest":{"index":0,"kind":"parameter","displayName":"Batch Modify Messages Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.BatchModifyMessagesRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.BatchModifyMessagesRequest","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"delete":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the message to delete","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"get":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the message to retrieve. This ID is usually retrieved using messages.list. The ID is also contained in the result when a message is inserted (messages.insert) or imported (messages.import).","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"gmailImport":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Message","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Message media metadata or null if none","optional":false},"mediaContent":{"index":1,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"insert":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Message","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Message media metadata or null if none","optional":false},"mediaContent":{"index":1,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"list":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"modify":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the message to modify","optional":false},"modifyMessageRequest":{"index":1,"kind":"parameter","displayName":"Modify Message Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.ModifyMessageRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.ModifyMessageRequest","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"send":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.Message","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.Message media metadata or null if none","optional":false},"mediaContent":{"index":1,"kind":"parameter","displayName":"Media Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.client.http.AbstractInputStreamContent","deprecated":false,"autowired":false,"secret":false,"description":"The media HTTP content","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"trash":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the message to Trash","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"untrash":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the message to remove from Trash","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}}}},"threads":{"methods":{"delete":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"ID of the Thread to delete","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"get":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the thread to retrieve","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"list":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"modify":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.ModifyThreadRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.ModifyThreadRequest","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the thread to modify","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"trash":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the thread to Trash","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"untrash":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the thread to remove from Trash","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}}}},"users":{"methods":{"getProfile":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"stop":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}},"watch":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.gmail.model.WatchRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.gmail.model.WatchRequest","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The user's email address. The special value me can be used to indicate the authenticated user. default: me","optional":false}}}}}}} , -{"component":{"kind":"component","name":"google-mail-stream","title":"Google Mail Stream","description":"Poll for incoming messages in Google Mail.","deprecated":false,"firstVersion":"2.22.0","label":"cloud,mail","javaType":"org.apache.camel.component.google.mail.stream.GoogleMailStreamComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-mail","version":"4.8.1","scheme":"google-mail-stream","extendsScheme":"","syntax":"google-mail-stream:index","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelGoogleMailStreamTo":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The recipient of the message","constantName":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConstants#MAIL_TO"},"CamelGoogleMailStreamFrom":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The emitter of the message","constantName":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConstants#MAIL_FROM"},"CamelGoogleMailStreamCc":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The carbon copy of the message","constantName":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConstants#MAIL_CC"},"CamelGoogleMailStreamBcc":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The blind carbon cpoy of the message","constantName":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConstants#MAIL_BCC"},"CamelGoogleMailStreamSubject":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The subject of the message","constantName":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConstants#MAIL_SUBJECT"},"CamelGoogleMailId":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of the message","constantName":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConstants#MAIL_ID"}},"properties":{"index":{"index":0,"kind":"path","displayName":"Index","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Currently not in use"},"applicationName":{"index":1,"kind":"parameter","displayName":"Application Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Google mail application name. Example would be camel-google-mail/1.0"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Client ID of the mail application"},"delegate":{"index":3,"kind":"parameter","displayName":"Delegate","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Delegate for wide-domain service account"},"labels":{"index":4,"kind":"parameter","displayName":"Labels","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Comma separated list of labels to take into account"},"markAsRead":{"index":5,"kind":"parameter","displayName":"Mark As Read","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Mark the message as read once it has been consumed"},"maxResults":{"index":6,"kind":"parameter","displayName":"Max Results","group":"consumer","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Max results to be returned"},"query":{"index":7,"kind":"parameter","displayName":"Query","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"is:unread","configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"The query to execute on gmail box"},"raw":{"index":8,"kind":"parameter","displayName":"Raw","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Whether to store the entire email message in an RFC 2822 formatted and base64url encoded string (in JSon format), in the Camel message body."},"scopes":{"index":9,"kind":"parameter","displayName":"Scopes","group":"consumer","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"GMail scopes"},"sendEmptyMessageWhenIdle":{"index":10,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":11,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":12,"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":{"index":13,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":14,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"backoffErrorThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":17,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":18,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":19,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":20,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":21,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":22,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":23,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":24,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":25,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":26,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":27,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":28,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":29,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."},"clientSecret":{"index":30,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Client secret of the mail application"},"refreshToken":{"index":31,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."},"serviceAccountKey":{"index":32,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Sets .json file with credentials for Service account"}}} +{"component":{"kind":"component","name":"google-mail-stream","title":"Google Mail Stream","description":"Poll for incoming messages in Google Mail.","deprecated":false,"firstVersion":"2.22.0","label":"cloud,mail","javaType":"org.apache.camel.component.google.mail.stream.GoogleMailStreamComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-mail","version":"4.8.2","scheme":"google-mail-stream","extendsScheme":"","syntax":"google-mail-stream:index","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelGoogleMailStreamTo":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The recipient of the message","constantName":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConstants#MAIL_TO"},"CamelGoogleMailStreamFrom":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The emitter of the message","constantName":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConstants#MAIL_FROM"},"CamelGoogleMailStreamCc":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The carbon copy of the message","constantName":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConstants#MAIL_CC"},"CamelGoogleMailStreamBcc":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The blind carbon cpoy of the message","constantName":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConstants#MAIL_BCC"},"CamelGoogleMailStreamSubject":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The subject of the message","constantName":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConstants#MAIL_SUBJECT"},"CamelGoogleMailId":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of the message","constantName":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConstants#MAIL_ID"}},"properties":{"index":{"index":0,"kind":"path","displayName":"Index","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Currently not in use"},"applicationName":{"index":1,"kind":"parameter","displayName":"Application Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Google mail application name. Example would be camel-google-mail/1.0"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Client ID of the mail application"},"delegate":{"index":3,"kind":"parameter","displayName":"Delegate","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Delegate for wide-domain service account"},"labels":{"index":4,"kind":"parameter","displayName":"Labels","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Comma separated list of labels to take into account"},"markAsRead":{"index":5,"kind":"parameter","displayName":"Mark As Read","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Mark the message as read once it has been consumed"},"maxResults":{"index":6,"kind":"parameter","displayName":"Max Results","group":"consumer","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Max results to be returned"},"query":{"index":7,"kind":"parameter","displayName":"Query","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"is:unread","configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"The query to execute on gmail box"},"raw":{"index":8,"kind":"parameter","displayName":"Raw","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Whether to store the entire email message in an RFC 2822 formatted and base64url encoded string (in JSon format), in the Camel message body."},"scopes":{"index":9,"kind":"parameter","displayName":"Scopes","group":"consumer","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"GMail scopes"},"sendEmptyMessageWhenIdle":{"index":10,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":11,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":12,"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":{"index":13,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":14,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"backoffErrorThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":17,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":18,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":19,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":20,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":21,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":22,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":23,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":24,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":25,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":26,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":27,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":28,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":29,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."},"clientSecret":{"index":30,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Client secret of the mail application"},"refreshToken":{"index":31,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."},"serviceAccountKey":{"index":32,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration","configurationField":"configuration","description":"Sets .json file with credentials for Service account"}}} , -{"component":{"kind":"component","name":"google-pubsub","title":"Google Pubsub","description":"Send and receive messages to/from Google Cloud Platform PubSub Service.","deprecated":false,"firstVersion":"2.19.0","label":"cloud,messaging","javaType":"org.apache.camel.component.google.pubsub.GooglePubsubComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-pubsub","version":"4.8.1","scheme":"google-pubsub","extendsScheme":"","syntax":"google-pubsub:projectId:destinationName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelGooglePubsubMessageId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of the message, assigned by the server when the message is published.","constantName":"org.apache.camel.component.google.pubsub.GooglePubsubConstants#MESSAGE_ID"},"CamelGooglePubsubMsgAckId":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID used to acknowledge the received message.","constantName":"org.apache.camel.component.google.pubsub.GooglePubsubConstants#ACK_ID"},"CamelGooglePubsubPublishTime":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.google.protobuf.Timestamp","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time at which the message was published","constantName":"org.apache.camel.component.google.pubsub.GooglePubsubConstants#PUBLISH_TIME"},"CamelGooglePubsubAttributes":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The attributes of the message.","constantName":"org.apache.camel.component.google.pubsub.GooglePubsubConstants#ATTRIBUTES"},"CamelGooglePubsubOrderingKey":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If non-empty, identifies related messages for which publish order should be respected.","constantName":"org.apache.camel.component.google.pubsub.GooglePubsubConstants#ORDERING_KEY"},"CamelGooglePubsubAcknowledge":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.google.pubsub.consumer.GooglePubsubAcknowledge","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Can be used to manually acknowledge or negative-acknowledge a message when ackMode=NONE.","constantName":"org.apache.camel.component.google.pubsub.GooglePubsubConstants#GOOGLE_PUBSUB_ACKNOWLEDGE"}},"properties":{"projectId":{"index":0,"kind":"path","displayName":"Project Id","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Google Cloud PubSub Project Id"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Destination Name. For the consumer this will be the subscription name, while for the producer this will be the topic name."},"authenticate":{"index":2,"kind":"parameter","displayName":"Authenticate","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Use Credentials when interacting with PubSub service (no authentication is required when using emulator)."},"loggerId":{"index":3,"kind":"parameter","displayName":"Logger Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Logger ID to use when a match to the parent route required"},"serviceAccountKey":{"index":4,"kind":"parameter","displayName":"Service Account Key","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Service account key that can be used as credentials for the PubSub publisher/subscriber. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"ackMode":{"index":5,"kind":"parameter","displayName":"Ack Mode","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.google.pubsub.GooglePubsubConstants.AckMode","enum":["AUTO","NONE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO","description":"AUTO = exchange gets ack'ed/nack'ed on completion. NONE = downstream process has to ack/nack explicitly"},"concurrentConsumers":{"index":6,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","description":"The number of parallel streams consuming from the subscription"},"maxAckExtensionPeriod":{"index":7,"kind":"parameter","displayName":"Max Ack Extension Period","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":3600,"description":"Set the maximum period a message ack deadline will be extended. Value in seconds"},"maxMessagesPerPoll":{"index":8,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","description":"The max number of messages to receive from the server in a single API call"},"synchronousPull":{"index":9,"kind":"parameter","displayName":"Synchronous Pull","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Synchronously pull batches of messages"},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":13,"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."},"messageOrderingEnabled":{"index":14,"kind":"parameter","displayName":"Message Ordering Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Should message ordering be enabled"},"pubsubEndpoint":{"index":15,"kind":"parameter","displayName":"Pubsub Endpoint","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Pub/Sub endpoint to use. Required when using message ordering, and ensures that messages are received in order even when multiple publishers are used"},"serializer":{"index":16,"kind":"parameter","displayName":"Serializer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.google.pubsub.serializer.GooglePubsubSerializer","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"description":"A custom GooglePubsubSerializer to use for serializing message payloads in the producer"}}} +{"component":{"kind":"component","name":"google-pubsub","title":"Google Pubsub","description":"Send and receive messages to/from Google Cloud Platform PubSub Service.","deprecated":false,"firstVersion":"2.19.0","label":"cloud,messaging","javaType":"org.apache.camel.component.google.pubsub.GooglePubsubComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-pubsub","version":"4.8.2","scheme":"google-pubsub","extendsScheme":"","syntax":"google-pubsub:projectId:destinationName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelGooglePubsubMessageId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of the message, assigned by the server when the message is published.","constantName":"org.apache.camel.component.google.pubsub.GooglePubsubConstants#MESSAGE_ID"},"CamelGooglePubsubMsgAckId":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID used to acknowledge the received message.","constantName":"org.apache.camel.component.google.pubsub.GooglePubsubConstants#ACK_ID"},"CamelGooglePubsubPublishTime":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.google.protobuf.Timestamp","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time at which the message was published","constantName":"org.apache.camel.component.google.pubsub.GooglePubsubConstants#PUBLISH_TIME"},"CamelGooglePubsubAttributes":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The attributes of the message.","constantName":"org.apache.camel.component.google.pubsub.GooglePubsubConstants#ATTRIBUTES"},"CamelGooglePubsubOrderingKey":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If non-empty, identifies related messages for which publish order should be respected.","constantName":"org.apache.camel.component.google.pubsub.GooglePubsubConstants#ORDERING_KEY"},"CamelGooglePubsubAcknowledge":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.google.pubsub.consumer.GooglePubsubAcknowledge","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Can be used to manually acknowledge or negative-acknowledge a message when ackMode=NONE.","constantName":"org.apache.camel.component.google.pubsub.GooglePubsubConstants#GOOGLE_PUBSUB_ACKNOWLEDGE"}},"properties":{"projectId":{"index":0,"kind":"path","displayName":"Project Id","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Google Cloud PubSub Project Id"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Destination Name. For the consumer this will be the subscription name, while for the producer this will be the topic name."},"authenticate":{"index":2,"kind":"parameter","displayName":"Authenticate","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Use Credentials when interacting with PubSub service (no authentication is required when using emulator)."},"loggerId":{"index":3,"kind":"parameter","displayName":"Logger Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Logger ID to use when a match to the parent route required"},"serviceAccountKey":{"index":4,"kind":"parameter","displayName":"Service Account Key","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Service account key that can be used as credentials for the PubSub publisher/subscriber. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"ackMode":{"index":5,"kind":"parameter","displayName":"Ack Mode","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.google.pubsub.GooglePubsubConstants.AckMode","enum":["AUTO","NONE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO","description":"AUTO = exchange gets ack'ed/nack'ed on completion. NONE = downstream process has to ack/nack explicitly"},"concurrentConsumers":{"index":6,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","description":"The number of parallel streams consuming from the subscription"},"maxAckExtensionPeriod":{"index":7,"kind":"parameter","displayName":"Max Ack Extension Period","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":3600,"description":"Set the maximum period a message ack deadline will be extended. Value in seconds"},"maxMessagesPerPoll":{"index":8,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","description":"The max number of messages to receive from the server in a single API call"},"synchronousPull":{"index":9,"kind":"parameter","displayName":"Synchronous Pull","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Synchronously pull batches of messages"},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":13,"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."},"messageOrderingEnabled":{"index":14,"kind":"parameter","displayName":"Message Ordering Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Should message ordering be enabled"},"pubsubEndpoint":{"index":15,"kind":"parameter","displayName":"Pubsub Endpoint","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Pub/Sub endpoint to use. Required when using message ordering, and ensures that messages are received in order even when multiple publishers are used"},"serializer":{"index":16,"kind":"parameter","displayName":"Serializer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.google.pubsub.serializer.GooglePubsubSerializer","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"description":"A custom GooglePubsubSerializer to use for serializing message payloads in the producer"}}} , -{"component":{"kind":"component","name":"google-pubsub-lite","title":"Google PubSub Lite","description":"Send and receive messages to/from Google Cloud Platform PubSub Lite Service.","deprecated":false,"firstVersion":"4.6.0","label":"cloud,messaging","javaType":"org.apache.camel.component.google.pubsublite.GooglePubsubLiteComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-pubsub-lite","version":"4.8.1","scheme":"google-pubsub-lite","extendsScheme":"","syntax":"google-pubsub-lite:projectId:location:destinationName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelGooglePubsubMessageId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of the message, assigned by the server when the message is published.","constantName":"org.apache.camel.component.google.pubsublite.GooglePubsubLiteConstants#MESSAGE_ID"},"CamelGooglePubsubMsgAckId":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID used to acknowledge the received message.","constantName":"org.apache.camel.component.google.pubsublite.GooglePubsubLiteConstants#ACK_ID"},"CamelGooglePubsubPublishTime":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.google.protobuf.Timestamp","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time at which the message was published","constantName":"org.apache.camel.component.google.pubsublite.GooglePubsubLiteConstants#PUBLISH_TIME"},"CamelGooglePubsubAttributes":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The attributes of the message.","constantName":"org.apache.camel.component.google.pubsublite.GooglePubsubLiteConstants#ATTRIBUTES"},"CamelGooglePubsubOrderingKey":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If non-empty, identifies related messages for which publish order should be respected.","constantName":"org.apache.camel.component.google.pubsublite.GooglePubsubLiteConstants#ORDERING_KEY"}},"properties":{"projectId":{"index":0,"kind":"path","displayName":"Project Id","group":"common","label":"common","required":true,"type":"integer","javaType":"java.lang.Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Google Cloud PubSub Lite Project Id"},"location":{"index":1,"kind":"path","displayName":"Location","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Google Cloud PubSub Lite location"},"destinationName":{"index":2,"kind":"path","displayName":"Destination Name","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Destination Name. For the consumer this will be the subscription name, while for the producer this will be the topic name."},"loggerId":{"index":3,"kind":"parameter","displayName":"Logger Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Logger ID to use when a match to the parent route required"},"ackMode":{"index":4,"kind":"parameter","displayName":"Ack Mode","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.google.pubsublite.GooglePubsubLiteConstants.AckMode","enum":["AUTO","NONE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO","description":"AUTO = exchange gets ack'ed/nack'ed on completion. NONE = downstream process has to ack/nack explicitly"},"concurrentConsumers":{"index":5,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","description":"The number of parallel streams consuming from the subscription"},"maxAckExtensionPeriod":{"index":6,"kind":"parameter","displayName":"Max Ack Extension Period","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":3600,"description":"Set the maximum period a message ack deadline will be extended. Value in seconds"},"maxMessagesPerPoll":{"index":7,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","description":"The max number of messages to receive from the server in a single API call"},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":11,"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."},"pubsubEndpoint":{"index":12,"kind":"parameter","displayName":"Pubsub Endpoint","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Pub/Sub endpoint to use. Required when using message ordering, and ensures that messages are received in order even when multiple publishers are used"},"serializer":{"index":13,"kind":"parameter","displayName":"Serializer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.google.pubsublite.serializer.GooglePubsubSerializer","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"description":"A custom GooglePubsubLiteSerializer to use for serializing message payloads in the producer"},"serviceAccountKey":{"index":14,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Service account key that can be used as credentials for the PubSub publisher/subscriber. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."}}} +{"component":{"kind":"component","name":"google-pubsub-lite","title":"Google PubSub Lite","description":"Send and receive messages to/from Google Cloud Platform PubSub Lite Service.","deprecated":false,"firstVersion":"4.6.0","label":"cloud,messaging","javaType":"org.apache.camel.component.google.pubsublite.GooglePubsubLiteComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-pubsub-lite","version":"4.8.2","scheme":"google-pubsub-lite","extendsScheme":"","syntax":"google-pubsub-lite:projectId:location:destinationName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelGooglePubsubMessageId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of the message, assigned by the server when the message is published.","constantName":"org.apache.camel.component.google.pubsublite.GooglePubsubLiteConstants#MESSAGE_ID"},"CamelGooglePubsubMsgAckId":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID used to acknowledge the received message.","constantName":"org.apache.camel.component.google.pubsublite.GooglePubsubLiteConstants#ACK_ID"},"CamelGooglePubsubPublishTime":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.google.protobuf.Timestamp","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time at which the message was published","constantName":"org.apache.camel.component.google.pubsublite.GooglePubsubLiteConstants#PUBLISH_TIME"},"CamelGooglePubsubAttributes":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The attributes of the message.","constantName":"org.apache.camel.component.google.pubsublite.GooglePubsubLiteConstants#ATTRIBUTES"},"CamelGooglePubsubOrderingKey":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If non-empty, identifies related messages for which publish order should be respected.","constantName":"org.apache.camel.component.google.pubsublite.GooglePubsubLiteConstants#ORDERING_KEY"}},"properties":{"projectId":{"index":0,"kind":"path","displayName":"Project Id","group":"common","label":"common","required":true,"type":"integer","javaType":"java.lang.Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Google Cloud PubSub Lite Project Id"},"location":{"index":1,"kind":"path","displayName":"Location","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Google Cloud PubSub Lite location"},"destinationName":{"index":2,"kind":"path","displayName":"Destination Name","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Destination Name. For the consumer this will be the subscription name, while for the producer this will be the topic name."},"loggerId":{"index":3,"kind":"parameter","displayName":"Logger Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Logger ID to use when a match to the parent route required"},"ackMode":{"index":4,"kind":"parameter","displayName":"Ack Mode","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.google.pubsublite.GooglePubsubLiteConstants.AckMode","enum":["AUTO","NONE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO","description":"AUTO = exchange gets ack'ed/nack'ed on completion. NONE = downstream process has to ack/nack explicitly"},"concurrentConsumers":{"index":5,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","description":"The number of parallel streams consuming from the subscription"},"maxAckExtensionPeriod":{"index":6,"kind":"parameter","displayName":"Max Ack Extension Period","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":3600,"description":"Set the maximum period a message ack deadline will be extended. Value in seconds"},"maxMessagesPerPoll":{"index":7,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","description":"The max number of messages to receive from the server in a single API call"},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":11,"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."},"pubsubEndpoint":{"index":12,"kind":"parameter","displayName":"Pubsub Endpoint","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Pub/Sub endpoint to use. Required when using message ordering, and ensures that messages are received in order even when multiple publishers are used"},"serializer":{"index":13,"kind":"parameter","displayName":"Serializer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.google.pubsublite.serializer.GooglePubsubSerializer","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"description":"A custom GooglePubsubLiteSerializer to use for serializing message payloads in the producer"},"serviceAccountKey":{"index":14,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Service account key that can be used as credentials for the PubSub publisher/subscriber. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."}}} , -{"component":{"kind":"component","name":"google-secret-manager","title":"Google Secret Manager","description":"Manage Google Secret Manager Secrets","deprecated":false,"firstVersion":"3.16.0","label":"cloud","javaType":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerComponent","supportLevel":"Stable","metadata":{"vault":"google-secret-manager"},"groupId":"org.apache.camel","artifactId":"camel-google-secret-manager","version":"4.8.1","scheme":"google-secret-manager","extendsScheme":"","syntax":"google-secret-manager:project","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"GoogleSecretManagerOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerOperations","enum":["createSecret","getSecretVersion","deleteSecret","listSecrets"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConstants#OPERATION"},"CamelGoogleSecretManagerSecretId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the secret","constantName":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConstants#SECRET_ID"},"CamelGoogleSecretManagerVersionId":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"latest","description":"The version of the secret","constantName":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConstants#VERSION_ID"}},"properties":{"project":{"index":0,"kind":"path","displayName":"Project","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConfiguration","configurationField":"configuration","description":"The Google Cloud Project Id name related to the Secret Manager"},"serviceAccountKey":{"index":1,"kind":"parameter","displayName":"Service Account Key","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConfiguration","configurationField":"configuration","description":"Service account key to authenticate an application as a service account"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerOperations","enum":["createSecret"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConfiguration","configurationField":"configuration","description":"The operation to perform on the producer."},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConfiguration","configurationField":"configuration","description":"Specifies if the request is a pojo request"},"lazyStartProducer":{"index":4,"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."},"client":{"index":5,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.google.cloud.secretmanager.v1.SecretManagerServiceClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConfiguration","configurationField":"configuration","description":"The client to use during service invocation."}}} +{"component":{"kind":"component","name":"google-secret-manager","title":"Google Secret Manager","description":"Manage Google Secret Manager Secrets","deprecated":false,"firstVersion":"3.16.0","label":"cloud","javaType":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerComponent","supportLevel":"Stable","metadata":{"vault":"google-secret-manager"},"groupId":"org.apache.camel","artifactId":"camel-google-secret-manager","version":"4.8.2","scheme":"google-secret-manager","extendsScheme":"","syntax":"google-secret-manager:project","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"GoogleSecretManagerOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerOperations","enum":["createSecret","getSecretVersion","deleteSecret","listSecrets"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConstants#OPERATION"},"CamelGoogleSecretManagerSecretId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the secret","constantName":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConstants#SECRET_ID"},"CamelGoogleSecretManagerVersionId":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"latest","description":"The version of the secret","constantName":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConstants#VERSION_ID"}},"properties":{"project":{"index":0,"kind":"path","displayName":"Project","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConfiguration","configurationField":"configuration","description":"The Google Cloud Project Id name related to the Secret Manager"},"serviceAccountKey":{"index":1,"kind":"parameter","displayName":"Service Account Key","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConfiguration","configurationField":"configuration","description":"Service account key to authenticate an application as a service account"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerOperations","enum":["createSecret"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConfiguration","configurationField":"configuration","description":"The operation to perform on the producer."},"pojoRequest":{"index":3,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConfiguration","configurationField":"configuration","description":"Specifies if the request is a pojo request"},"lazyStartProducer":{"index":4,"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."},"client":{"index":5,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.google.cloud.secretmanager.v1.SecretManagerServiceClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.google.secret.manager.GoogleSecretManagerConfiguration","configurationField":"configuration","description":"The client to use during service invocation."}}} , -{"component":{"kind":"component","name":"google-sheets","title":"Google Sheets","description":"Manage spreadsheets in Google Sheets.","deprecated":false,"firstVersion":"2.23.0","label":"cloud,document","javaType":"org.apache.camel.component.google.sheets.GoogleSheetsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-sheets","version":"4.8.1","scheme":"google-sheets","extendsScheme":"","syntax":"google-sheets:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true,"verifiers":"parameters,connectivity"},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.google.sheets.internal.GoogleSheetsApiName","enum":["SPREADSHEETS","DATA"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["create","get","update","append","batchUpdate","clear"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"applicationName":{"index":2,"kind":"parameter","displayName":"Application Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"Google Sheets application name. Example would be camel-google-sheets/1.0"},"clientId":{"index":3,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"Client ID of the sheets application"},"delegate":{"index":4,"kind":"parameter","displayName":"Delegate","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"Delegate for wide-domain service account"},"inBody":{"index":5,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"scopes":{"index":6,"kind":"parameter","displayName":"Scopes","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"Specifies the level of permissions you want a sheets application to have to a user account. See https://developers.google.com/identity/protocols/googlescopes for more info. Multiple scopes can be separated by comma."},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"splitResult":{"index":8,"kind":"parameter","displayName":"Split Result","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"When consumer return an array or collection this will generate one exchange per element, and their routes will be executed once for each exchange. Set this value to false to use a single exchange for the entire list or array."},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":12,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":13,"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."},"backoffErrorThreshold":{"index":14,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":16,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":17,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":18,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":19,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":20,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":21,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":22,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":23,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":24,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":25,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":26,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":27,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":28,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."},"clientSecret":{"index":29,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"Client secret of the sheets application"},"refreshToken":{"index":30,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"OAuth 2 refresh token. Using this, the Google Sheets component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."},"serviceAccountKey":{"index":31,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"Sets .json file with credentials for Service account"}},"apis":{"data":{"consumerOnly":false,"producerOnly":false,"description":"The values collection of methods","methods":{"append":{"description":"Appends values to a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Append append(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ValueRange content)"]},"batchClear":{"description":"Clears one or more ranges of values from a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchClear batchClear(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchClearValuesRequest content)"]},"batchClearByDataFilter":{"description":"Clears one or more ranges of values from a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchClearByDataFilter batchClearByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchClearValuesByDataFilterRequest content)"]},"batchGet":{"description":"Returns one or more ranges of values from a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchGet batchGet(String spreadsheetId)"]},"batchGetByDataFilter":{"description":"Returns one or more ranges of values that match the specified data filters","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchGetByDataFilter batchGetByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchGetValuesByDataFilterRequest content)"]},"batchUpdate":{"description":"Sets values in one or more ranges of a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchUpdate batchUpdate(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest content)"]},"batchUpdateByDataFilter":{"description":"Sets values in one or more ranges of a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchUpdateByDataFilter batchUpdateByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateValuesByDataFilterRequest content)"]},"clear":{"description":"Clears values from a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Clear clear(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ClearValuesRequest content)"]},"get":{"description":"Returns a range of values from a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Get get(String spreadsheetId, String range)"]},"update":{"description":"Sets values in a range of a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Update update(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ValueRange content)"]}}},"spreadsheets":{"consumerOnly":false,"producerOnly":false,"description":"The spreadsheets collection of methods","methods":{"batchUpdate":{"description":"Applies one or more updates to the spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$BatchUpdate batchUpdate(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest content)"]},"create":{"description":"Creates a spreadsheet, returning the newly created spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Create create(com.google.api.services.sheets.v4.model.Spreadsheet content)"]},"get":{"description":"Returns the spreadsheet at the given ID","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Get get(String spreadsheetId)"]},"getByDataFilter":{"description":"Returns the spreadsheet at the given ID","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$GetByDataFilter getByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.GetSpreadsheetByDataFilterRequest content)"]}}}},"apiProperties":{"data":{"methods":{"append":{"properties":{"range":{"index":0,"kind":"parameter","displayName":"Range","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The A1 notation(/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table.","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to update","optional":false},"values":{"index":2,"kind":"parameter","displayName":"Values","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.ValueRange","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.ValueRange","optional":false}}},"batchClear":{"properties":{"batchClearValuesRequest":{"index":0,"kind":"parameter","displayName":"Batch Clear Values Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.BatchClearValuesRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.BatchClearValuesRequest","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to update","optional":false}}},"batchClearByDataFilter":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.BatchClearValuesByDataFilterRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.BatchClearValuesByDataFilterRequest","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to update","optional":false}}},"batchGet":{"properties":{"spreadsheetId":{"index":0,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to retrieve data from","optional":false}}},"batchGetByDataFilter":{"properties":{"batchGetValuesByDataFilterRequest":{"index":0,"kind":"parameter","displayName":"Batch Get Values By Data Filter Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.BatchGetValuesByDataFilterRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.BatchGetValuesByDataFilterRequest","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to retrieve data from","optional":false}}},"batchUpdate":{"properties":{"batchUpdateValuesRequest":{"index":0,"kind":"parameter","displayName":"Batch Update Values Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to update","optional":false}}},"batchUpdateByDataFilter":{"properties":{"batchUpdateValuesByDataFilterRequest":{"index":0,"kind":"parameter","displayName":"Batch Update Values By Data Filter Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.BatchUpdateValuesByDataFilterRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.BatchUpdateValuesByDataFilterRequest","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to update","optional":false}}},"clear":{"properties":{"clearValuesRequest":{"index":0,"kind":"parameter","displayName":"Clear Values Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.ClearValuesRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.ClearValuesRequest","optional":false},"range":{"index":1,"kind":"parameter","displayName":"Range","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The A1 notation or R1C1 notation(/sheets/api/guides/concepts#cell) of the values to clear.","optional":false},"spreadsheetId":{"index":2,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to update","optional":false}}},"get":{"properties":{"range":{"index":0,"kind":"parameter","displayName":"Range","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The A1 notation or R1C1 notation(/sheets/api/guides/concepts#cell) of the range to retrieve values from.","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to retrieve data from","optional":false}}},"update":{"properties":{"range":{"index":0,"kind":"parameter","displayName":"Range","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The A1 notation(/sheets/api/guides/concepts#cell) of the values to update.","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to update","optional":false},"values":{"index":2,"kind":"parameter","displayName":"Values","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.ValueRange","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.ValueRange","optional":false}}}}},"spreadsheets":{"methods":{"batchUpdate":{"properties":{"batchUpdateSpreadsheetRequest":{"index":0,"kind":"parameter","displayName":"Batch Update Spreadsheet Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The spreadsheet to apply the updates to","optional":false}}},"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.Spreadsheet","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.Spreadsheet","optional":false}}},"get":{"properties":{"spreadsheetId":{"index":0,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The spreadsheet to request","optional":false}}},"getByDataFilter":{"properties":{"getSpreadsheetByDataFilterRequest":{"index":0,"kind":"parameter","displayName":"Get Spreadsheet By Data Filter Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.GetSpreadsheetByDataFilterRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.GetSpreadsheetByDataFilterRequest","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The spreadsheet to request","optional":false}}}}}}} +{"component":{"kind":"component","name":"google-sheets","title":"Google Sheets","description":"Manage spreadsheets in Google Sheets.","deprecated":false,"firstVersion":"2.23.0","label":"cloud,document","javaType":"org.apache.camel.component.google.sheets.GoogleSheetsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-sheets","version":"4.8.2","scheme":"google-sheets","extendsScheme":"","syntax":"google-sheets:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true,"verifiers":"parameters,connectivity"},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.google.sheets.internal.GoogleSheetsApiName","enum":["SPREADSHEETS","DATA"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["create","get","update","append","batchUpdate","clear"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"applicationName":{"index":2,"kind":"parameter","displayName":"Application Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"Google Sheets application name. Example would be camel-google-sheets/1.0"},"clientId":{"index":3,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"Client ID of the sheets application"},"delegate":{"index":4,"kind":"parameter","displayName":"Delegate","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"Delegate for wide-domain service account"},"inBody":{"index":5,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"scopes":{"index":6,"kind":"parameter","displayName":"Scopes","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"Specifies the level of permissions you want a sheets application to have to a user account. See https://developers.google.com/identity/protocols/googlescopes for more info. Multiple scopes can be separated by comma."},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"splitResult":{"index":8,"kind":"parameter","displayName":"Split Result","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"When consumer return an array or collection this will generate one exchange per element, and their routes will be executed once for each exchange. Set this value to false to use a single exchange for the entire list or array."},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":12,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":13,"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."},"backoffErrorThreshold":{"index":14,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":16,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":17,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":18,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":19,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":20,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":21,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":22,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":23,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":24,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":25,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":26,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":27,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":28,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."},"clientSecret":{"index":29,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"Client secret of the sheets application"},"refreshToken":{"index":30,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"OAuth 2 refresh token. Using this, the Google Sheets component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."},"serviceAccountKey":{"index":31,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.GoogleSheetsConfiguration","configurationField":"configuration","description":"Sets .json file with credentials for Service account"}},"apis":{"data":{"consumerOnly":false,"producerOnly":false,"description":"The values collection of methods","methods":{"append":{"description":"Appends values to a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Append append(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ValueRange content)"]},"batchClear":{"description":"Clears one or more ranges of values from a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchClear batchClear(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchClearValuesRequest content)"]},"batchClearByDataFilter":{"description":"Clears one or more ranges of values from a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchClearByDataFilter batchClearByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchClearValuesByDataFilterRequest content)"]},"batchGet":{"description":"Returns one or more ranges of values from a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchGet batchGet(String spreadsheetId)"]},"batchGetByDataFilter":{"description":"Returns one or more ranges of values that match the specified data filters","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchGetByDataFilter batchGetByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchGetValuesByDataFilterRequest content)"]},"batchUpdate":{"description":"Sets values in one or more ranges of a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchUpdate batchUpdate(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest content)"]},"batchUpdateByDataFilter":{"description":"Sets values in one or more ranges of a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchUpdateByDataFilter batchUpdateByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateValuesByDataFilterRequest content)"]},"clear":{"description":"Clears values from a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Clear clear(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ClearValuesRequest content)"]},"get":{"description":"Returns a range of values from a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Get get(String spreadsheetId, String range)"]},"update":{"description":"Sets values in a range of a spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Update update(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ValueRange content)"]}}},"spreadsheets":{"consumerOnly":false,"producerOnly":false,"description":"The spreadsheets collection of methods","methods":{"batchUpdate":{"description":"Applies one or more updates to the spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$BatchUpdate batchUpdate(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest content)"]},"create":{"description":"Creates a spreadsheet, returning the newly created spreadsheet","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Create create(com.google.api.services.sheets.v4.model.Spreadsheet content)"]},"get":{"description":"Returns the spreadsheet at the given ID","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$Get get(String spreadsheetId)"]},"getByDataFilter":{"description":"Returns the spreadsheet at the given ID","signatures":["com.google.api.services.sheets.v4.Sheets$Spreadsheets$GetByDataFilter getByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.GetSpreadsheetByDataFilterRequest content)"]}}}},"apiProperties":{"data":{"methods":{"append":{"properties":{"range":{"index":0,"kind":"parameter","displayName":"Range","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The A1 notation(/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table.","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to update","optional":false},"values":{"index":2,"kind":"parameter","displayName":"Values","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.ValueRange","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.ValueRange","optional":false}}},"batchClear":{"properties":{"batchClearValuesRequest":{"index":0,"kind":"parameter","displayName":"Batch Clear Values Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.BatchClearValuesRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.BatchClearValuesRequest","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to update","optional":false}}},"batchClearByDataFilter":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.BatchClearValuesByDataFilterRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.BatchClearValuesByDataFilterRequest","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to update","optional":false}}},"batchGet":{"properties":{"spreadsheetId":{"index":0,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to retrieve data from","optional":false}}},"batchGetByDataFilter":{"properties":{"batchGetValuesByDataFilterRequest":{"index":0,"kind":"parameter","displayName":"Batch Get Values By Data Filter Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.BatchGetValuesByDataFilterRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.BatchGetValuesByDataFilterRequest","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to retrieve data from","optional":false}}},"batchUpdate":{"properties":{"batchUpdateValuesRequest":{"index":0,"kind":"parameter","displayName":"Batch Update Values Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to update","optional":false}}},"batchUpdateByDataFilter":{"properties":{"batchUpdateValuesByDataFilterRequest":{"index":0,"kind":"parameter","displayName":"Batch Update Values By Data Filter Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.BatchUpdateValuesByDataFilterRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.BatchUpdateValuesByDataFilterRequest","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to update","optional":false}}},"clear":{"properties":{"clearValuesRequest":{"index":0,"kind":"parameter","displayName":"Clear Values Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.ClearValuesRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.ClearValuesRequest","optional":false},"range":{"index":1,"kind":"parameter","displayName":"Range","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The A1 notation or R1C1 notation(/sheets/api/guides/concepts#cell) of the values to clear.","optional":false},"spreadsheetId":{"index":2,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to update","optional":false}}},"get":{"properties":{"range":{"index":0,"kind":"parameter","displayName":"Range","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The A1 notation or R1C1 notation(/sheets/api/guides/concepts#cell) of the range to retrieve values from.","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to retrieve data from","optional":false}}},"update":{"properties":{"range":{"index":0,"kind":"parameter","displayName":"Range","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The A1 notation(/sheets/api/guides/concepts#cell) of the values to update.","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The ID of the spreadsheet to update","optional":false},"values":{"index":2,"kind":"parameter","displayName":"Values","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.ValueRange","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.ValueRange","optional":false}}}}},"spreadsheets":{"methods":{"batchUpdate":{"properties":{"batchUpdateSpreadsheetRequest":{"index":0,"kind":"parameter","displayName":"Batch Update Spreadsheet Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The spreadsheet to apply the updates to","optional":false}}},"create":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.Spreadsheet","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.Spreadsheet","optional":false}}},"get":{"properties":{"spreadsheetId":{"index":0,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The spreadsheet to request","optional":false}}},"getByDataFilter":{"properties":{"getSpreadsheetByDataFilterRequest":{"index":0,"kind":"parameter","displayName":"Get Spreadsheet By Data Filter Request","group":"common","label":"","required":false,"type":"object","javaType":"com.google.api.services.sheets.v4.model.GetSpreadsheetByDataFilterRequest","deprecated":false,"autowired":false,"secret":false,"description":"The com.google.api.services.sheets.v4.model.GetSpreadsheetByDataFilterRequest","optional":false},"spreadsheetId":{"index":1,"kind":"parameter","displayName":"Spreadsheet Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The spreadsheet to request","optional":false}}}}}}} , -{"component":{"kind":"component","name":"google-sheets-stream","title":"Google Sheets Stream","description":"Poll for changes in Google Sheets.","deprecated":false,"firstVersion":"2.23.0","label":"cloud,document","javaType":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-sheets","version":"4.8.1","scheme":"google-sheets-stream","extendsScheme":"","syntax":"google-sheets-stream:spreadsheetId","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"CamelGoogleSheetsSpreadsheetId":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the spreadsheet identifier that is used to identify the target to obtain.","constantName":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConstants#SPREADSHEET_ID"},"CamelGoogleSheetsSpreadsheetUrl":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The URL of the spreadsheet.","constantName":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConstants#SPREADSHEET_URL"},"CamelGoogleSheetsMajorDimension":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The major dimension of the values","constantName":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConstants#MAJOR_DIMENSION"},"CamelGoogleSheetsRange":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The range the values cover, in A1 notation.","constantName":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConstants#RANGE"},"CamelGoogleSheetsRangeIndex":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index of the range","constantName":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConstants#RANGE_INDEX"},"CamelGoogleSheetsValueIndex":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index of the value","constantName":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConstants#VALUE_INDEX"}},"properties":{"spreadsheetId":{"index":0,"kind":"path","displayName":"Spreadsheet Id","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Specifies the spreadsheet identifier that is used to identify the target to obtain."},"applicationName":{"index":1,"kind":"parameter","displayName":"Application Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Google Sheets application name. Example would be camel-google-sheets/1.0"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Client ID of the sheets application"},"delegate":{"index":3,"kind":"parameter","displayName":"Delegate","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Delegate for wide-domain service account"},"includeGridData":{"index":4,"kind":"parameter","displayName":"Include Grid Data","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"True if grid data should be returned."},"majorDimension":{"index":5,"kind":"parameter","displayName":"Major Dimension","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ROWS","COLUMNS","DIMENSION_UNSPECIFIED"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ROWS","configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Specifies the major dimension that results should use.."},"maxResults":{"index":6,"kind":"parameter","displayName":"Max Results","group":"consumer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Specify the maximum number of returned results. This will limit the number of rows in a returned value range data set or the number of returned value ranges in a batch request."},"range":{"index":7,"kind":"parameter","displayName":"Range","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Specifies the range of rows and columns in a sheet to get data from."},"scopes":{"index":8,"kind":"parameter","displayName":"Scopes","group":"consumer","label":"","required":false,"type":"array","javaType":"java.util.Collection","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Specifies the level of permissions you want a sheets application to have to a user account. See https://developers.google.com/identity/protocols/googlescopes for more info."},"sendEmptyMessageWhenIdle":{"index":9,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"splitResults":{"index":10,"kind":"parameter","displayName":"Split Results","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"True if value range result should be split into rows or columns to process each of them individually. When true each row or column is represented with a separate exchange in batch processing. Otherwise value range object is used as exchange junk size."},"valueRenderOption":{"index":11,"kind":"parameter","displayName":"Value Render Option","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"FORMATTED_VALUE","configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Determines how values should be rendered in the output."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":15,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"backoffErrorThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":17,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":18,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":19,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":20,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":21,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":22,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":23,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":24,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":25,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":26,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":27,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":28,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":29,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":30,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."},"clientSecret":{"index":31,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Client secret of the sheets application"},"refreshToken":{"index":32,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"OAuth 2 refresh token. Using this, the Google Sheets component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."},"serviceAccountKey":{"index":33,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Sets .json file with credentials for Service account"}}} +{"component":{"kind":"component","name":"google-sheets-stream","title":"Google Sheets Stream","description":"Poll for changes in Google Sheets.","deprecated":false,"firstVersion":"2.23.0","label":"cloud,document","javaType":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-sheets","version":"4.8.2","scheme":"google-sheets-stream","extendsScheme":"","syntax":"google-sheets-stream:spreadsheetId","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"CamelGoogleSheetsSpreadsheetId":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the spreadsheet identifier that is used to identify the target to obtain.","constantName":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConstants#SPREADSHEET_ID"},"CamelGoogleSheetsSpreadsheetUrl":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The URL of the spreadsheet.","constantName":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConstants#SPREADSHEET_URL"},"CamelGoogleSheetsMajorDimension":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The major dimension of the values","constantName":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConstants#MAJOR_DIMENSION"},"CamelGoogleSheetsRange":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The range the values cover, in A1 notation.","constantName":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConstants#RANGE"},"CamelGoogleSheetsRangeIndex":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index of the range","constantName":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConstants#RANGE_INDEX"},"CamelGoogleSheetsValueIndex":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index of the value","constantName":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConstants#VALUE_INDEX"}},"properties":{"spreadsheetId":{"index":0,"kind":"path","displayName":"Spreadsheet Id","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Specifies the spreadsheet identifier that is used to identify the target to obtain."},"applicationName":{"index":1,"kind":"parameter","displayName":"Application Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Google Sheets application name. Example would be camel-google-sheets/1.0"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Client ID of the sheets application"},"delegate":{"index":3,"kind":"parameter","displayName":"Delegate","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Delegate for wide-domain service account"},"includeGridData":{"index":4,"kind":"parameter","displayName":"Include Grid Data","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"True if grid data should be returned."},"majorDimension":{"index":5,"kind":"parameter","displayName":"Major Dimension","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["ROWS","COLUMNS","DIMENSION_UNSPECIFIED"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ROWS","configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Specifies the major dimension that results should use.."},"maxResults":{"index":6,"kind":"parameter","displayName":"Max Results","group":"consumer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Specify the maximum number of returned results. This will limit the number of rows in a returned value range data set or the number of returned value ranges in a batch request."},"range":{"index":7,"kind":"parameter","displayName":"Range","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Specifies the range of rows and columns in a sheet to get data from."},"scopes":{"index":8,"kind":"parameter","displayName":"Scopes","group":"consumer","label":"","required":false,"type":"array","javaType":"java.util.Collection","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Specifies the level of permissions you want a sheets application to have to a user account. See https://developers.google.com/identity/protocols/googlescopes for more info."},"sendEmptyMessageWhenIdle":{"index":9,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"splitResults":{"index":10,"kind":"parameter","displayName":"Split Results","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"True if value range result should be split into rows or columns to process each of them individually. When true each row or column is represented with a separate exchange in batch processing. Otherwise value range object is used as exchange junk size."},"valueRenderOption":{"index":11,"kind":"parameter","displayName":"Value Render Option","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"FORMATTED_VALUE","configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Determines how values should be rendered in the output."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":15,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"backoffErrorThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":17,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":18,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":19,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":20,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":21,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":22,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":23,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":24,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":25,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":26,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":27,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":28,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":29,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":30,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."},"clientSecret":{"index":31,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Client secret of the sheets application"},"refreshToken":{"index":32,"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"OAuth 2 refresh token. Using this, the Google Sheets component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."},"serviceAccountKey":{"index":33,"kind":"parameter","displayName":"Service Account Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration","configurationField":"configuration","description":"Sets .json file with credentials for Service account"}}} , -{"component":{"kind":"component","name":"google-storage","title":"Google Storage","description":"Store and retrieve objects from Google Cloud Storage Service using the google-cloud-storage library.","deprecated":false,"firstVersion":"3.9.0","label":"cloud","javaType":"org.apache.camel.component.google.storage.GoogleCloudStorageComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-storage","version":"4.8.1","scheme":"google-storage","extendsScheme":"","syntax":"google-storage:bucketName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelGoogleCloudStorageOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.google.storage.GoogleCloudStorageOperations","enum":["copyObject","listObjects","deleteObject","deleteBucket","listBuckets","getObject","createDownloadLink"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#OPERATION"},"CamelGoogleCloudStorageBucketName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bucket Name which this object will be stored or which will be used for the current operation","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#BUCKET_NAME"},"CamelGoogleCloudStorageObjectName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object Name which will be used for the current operation","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#OBJECT_NAME"},"CamelGoogleCloudStorageDestinationObjectName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object Destination Name which will be used for the current operation","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#DESTINATION_OBJECT_NAME"},"CamelGoogleCloudStorageDestinationBucketName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bucket Destination Name which will be used for the current operation","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#DESTINATION_BUCKET_NAME"},"CamelGoogleCloudStorageDownloadLinkExpirationTime":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"300000","description":"The time in millisecond the download link will be valid.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#DOWNLOAD_LINK_EXPIRATION_TIME"},"CamelGoogleCloudStorageContentLength":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content length of this object.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#CONTENT_LENGTH"},"CamelGoogleCloudStorageContentType":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type of this object.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#CONTENT_TYPE"},"CamelGoogleCloudStorageCacheControl":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Cache-Control metadata can specify two different aspects of how data is served from Cloud Storage: whether the data can be cached and whether the data can be transformed","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#CACHE_CONTROL"},"CamelGoogleCloudStorageContentDisposition":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content disposition of this object.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#CONTENT_DISPOSITION"},"CamelGoogleCloudStorageContentEncoding":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content encoding of this object.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#CONTENT_ENCODING"},"CamelGoogleCloudStorageContentMd5":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The md5 checksum of this object.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#CONTENT_MD5"},"CamelFileName":{"index":12,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the blob","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#FILE_NAME"},"CamelGoogleCloudStorageComponentCount":{"index":13,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The component count of this object","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_COMPONENT_COUNT"},"CamelGoogleCloudStorageContentLanguage":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Content-Language metadata indicates the language(s) that the object is intended for.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_CONTENT_LANGUAGE"},"CamelGoogleCloudStorageCustomTime":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Custom-Time metadata is a user-specified date and time represented in the RFC 3339 format YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z' when milliseconds are zero. This metadata is typically set in order to use the DaysSinceCustomTime condition in Object Lifecycle Management.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_CUSTOM_TIME"},"CamelGoogleCloudStorageCrc32cHex":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CRC32c of the object","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_CRC32C_HEX"},"CamelGoogleCloudStorageETag":{"index":17,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ETag for the Object.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_ETAG"},"CamelGoogleCloudStorageGeneration":{"index":18,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is the generation number of the object for which you are retrieving information.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_GENERATION"},"CamelGoogleCloudStorageBlobId":{"index":19,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.google.cloud.storage.BlobId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The blob id of the object","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_BLOB_ID"},"CamelGoogleCloudStorageKmsKeyName":{"index":20,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The KMS key name","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_KMS_KEY_NAME"},"CamelGoogleCloudStorageMediaLink":{"index":21,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The media link","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_MEDIA_LINK"},"CamelGoogleCloudStorageMetageneration":{"index":22,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metageneration of the object","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_METAGENERATION"},"CamelGoogleCloudStorageStorageClass":{"index":23,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.google.cloud.storage.StorageClass","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The storage class of the object","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_STORAGE_CLASS"},"CamelGoogleCloudStorageCreateTime":{"index":24,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The creation time of the object","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_CREATE_TIME"},"CamelGoogleCloudStorageLastUpdate":{"index":25,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The last update of the object","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_LAST_UPDATE"}},"properties":{"bucketName":{"index":0,"kind":"path","displayName":"Bucket Name","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"Bucket name or ARN"},"autoCreateBucket":{"index":1,"kind":"parameter","displayName":"Auto Create Bucket","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"Setting the autocreation of the bucket bucketName."},"serviceAccountKey":{"index":2,"kind":"parameter","displayName":"Service Account Key","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"The Service account key that can be used as credentials for the Storage client. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"storageClass":{"index":3,"kind":"parameter","displayName":"Storage Class","group":"common","label":"common","required":false,"type":"object","javaType":"com.google.cloud.storage.StorageClass","deprecated":false,"autowired":false,"secret":false,"defaultValue":"STANDARD","configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"The Cloud Storage class to use when creating the new buckets"},"storageClient":{"index":4,"kind":"parameter","displayName":"Storage Client","group":"common","label":"","required":false,"type":"object","javaType":"com.google.cloud.storage.Storage","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"The storage client"},"storageLocation":{"index":5,"kind":"parameter","displayName":"Storage Location","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"US-EAST1","configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"The Cloud Storage location to use when creating the new buckets"},"deleteAfterRead":{"index":6,"kind":"parameter","displayName":"Delete After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"Delete objects from the bucket after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieve over and over again on the polls."},"destinationBucket":{"index":7,"kind":"parameter","displayName":"Destination Bucket","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"Define the destination bucket where an object must be moved when moveAfterRead is set to true."},"downloadFileName":{"index":8,"kind":"parameter","displayName":"Download File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"The folder or filename to use when downloading the blob. By default, this specifies the folder name, and the name of the file is the blob name. For example, setting this to mydownload will be the same as setting mydownload/${file:name}. You can use dynamic expressions for fine-grained control. For example, you can specify ${date:now:yyyyMMdd}/${file:name} to store the blob in sub folders based on today's day. Only ${file:name} and ${file:name.noext} is supported as dynamic tokens for the blob name."},"filter":{"index":9,"kind":"parameter","displayName":"Filter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"A regular expression to include only blobs with name matching it."},"includeBody":{"index":10,"kind":"parameter","displayName":"Include Body","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"If it is true, the Object exchange will be consumed and put into the body. If false the Object stream will be put raw into the body and the headers will be set with the object metadata."},"includeFolders":{"index":11,"kind":"parameter","displayName":"Include Folders","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those"},"moveAfterRead":{"index":12,"kind":"parameter","displayName":"Move After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"Move objects from the origin bucket to a different bucket after they have been retrieved. To accomplish the operation the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved."},"sendEmptyMessageWhenIdle":{"index":13,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":17,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"objectName":{"index":18,"kind":"parameter","displayName":"Object Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"The Object name inside the bucket"},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.google.storage.GoogleCloudStorageOperations","enum":["copyObject","listObjects","deleteObject","deleteBucket","listBuckets","getObject","createDownloadLink"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"Set the operation for the producer"},"lazyStartProducer":{"index":20,"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."},"backoffErrorThreshold":{"index":21,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":22,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":23,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":24,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":25,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":26,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":27,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":28,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":29,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":30,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":31,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":32,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":33,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":34,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} +{"component":{"kind":"component","name":"google-storage","title":"Google Storage","description":"Store and retrieve objects from Google Cloud Storage Service using the google-cloud-storage library.","deprecated":false,"firstVersion":"3.9.0","label":"cloud","javaType":"org.apache.camel.component.google.storage.GoogleCloudStorageComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-google-storage","version":"4.8.2","scheme":"google-storage","extendsScheme":"","syntax":"google-storage:bucketName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelGoogleCloudStorageOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.google.storage.GoogleCloudStorageOperations","enum":["copyObject","listObjects","deleteObject","deleteBucket","listBuckets","getObject","createDownloadLink"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#OPERATION"},"CamelGoogleCloudStorageBucketName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bucket Name which this object will be stored or which will be used for the current operation","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#BUCKET_NAME"},"CamelGoogleCloudStorageObjectName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object Name which will be used for the current operation","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#OBJECT_NAME"},"CamelGoogleCloudStorageDestinationObjectName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object Destination Name which will be used for the current operation","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#DESTINATION_OBJECT_NAME"},"CamelGoogleCloudStorageDestinationBucketName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bucket Destination Name which will be used for the current operation","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#DESTINATION_BUCKET_NAME"},"CamelGoogleCloudStorageDownloadLinkExpirationTime":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"300000","description":"The time in millisecond the download link will be valid.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#DOWNLOAD_LINK_EXPIRATION_TIME"},"CamelGoogleCloudStorageContentLength":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content length of this object.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#CONTENT_LENGTH"},"CamelGoogleCloudStorageContentType":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type of this object.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#CONTENT_TYPE"},"CamelGoogleCloudStorageCacheControl":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Cache-Control metadata can specify two different aspects of how data is served from Cloud Storage: whether the data can be cached and whether the data can be transformed","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#CACHE_CONTROL"},"CamelGoogleCloudStorageContentDisposition":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content disposition of this object.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#CONTENT_DISPOSITION"},"CamelGoogleCloudStorageContentEncoding":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content encoding of this object.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#CONTENT_ENCODING"},"CamelGoogleCloudStorageContentMd5":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The md5 checksum of this object.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#CONTENT_MD5"},"CamelFileName":{"index":12,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the blob","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#FILE_NAME"},"CamelGoogleCloudStorageComponentCount":{"index":13,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The component count of this object","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_COMPONENT_COUNT"},"CamelGoogleCloudStorageContentLanguage":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Content-Language metadata indicates the language(s) that the object is intended for.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_CONTENT_LANGUAGE"},"CamelGoogleCloudStorageCustomTime":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Custom-Time metadata is a user-specified date and time represented in the RFC 3339 format YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z' when milliseconds are zero. This metadata is typically set in order to use the DaysSinceCustomTime condition in Object Lifecycle Management.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_CUSTOM_TIME"},"CamelGoogleCloudStorageCrc32cHex":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CRC32c of the object","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_CRC32C_HEX"},"CamelGoogleCloudStorageETag":{"index":17,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ETag for the Object.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_ETAG"},"CamelGoogleCloudStorageGeneration":{"index":18,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is the generation number of the object for which you are retrieving information.","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_GENERATION"},"CamelGoogleCloudStorageBlobId":{"index":19,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.google.cloud.storage.BlobId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The blob id of the object","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_BLOB_ID"},"CamelGoogleCloudStorageKmsKeyName":{"index":20,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The KMS key name","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_KMS_KEY_NAME"},"CamelGoogleCloudStorageMediaLink":{"index":21,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The media link","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_MEDIA_LINK"},"CamelGoogleCloudStorageMetageneration":{"index":22,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metageneration of the object","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_METAGENERATION"},"CamelGoogleCloudStorageStorageClass":{"index":23,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.google.cloud.storage.StorageClass","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The storage class of the object","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_STORAGE_CLASS"},"CamelGoogleCloudStorageCreateTime":{"index":24,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The creation time of the object","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_CREATE_TIME"},"CamelGoogleCloudStorageLastUpdate":{"index":25,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The last update of the object","constantName":"org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_LAST_UPDATE"}},"properties":{"bucketName":{"index":0,"kind":"path","displayName":"Bucket Name","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"Bucket name or ARN"},"autoCreateBucket":{"index":1,"kind":"parameter","displayName":"Auto Create Bucket","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"Setting the autocreation of the bucket bucketName."},"serviceAccountKey":{"index":2,"kind":"parameter","displayName":"Service Account Key","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"The Service account key that can be used as credentials for the Storage client. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"storageClass":{"index":3,"kind":"parameter","displayName":"Storage Class","group":"common","label":"common","required":false,"type":"object","javaType":"com.google.cloud.storage.StorageClass","deprecated":false,"autowired":false,"secret":false,"defaultValue":"STANDARD","configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"The Cloud Storage class to use when creating the new buckets"},"storageClient":{"index":4,"kind":"parameter","displayName":"Storage Client","group":"common","label":"","required":false,"type":"object","javaType":"com.google.cloud.storage.Storage","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"The storage client"},"storageLocation":{"index":5,"kind":"parameter","displayName":"Storage Location","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"US-EAST1","configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"The Cloud Storage location to use when creating the new buckets"},"deleteAfterRead":{"index":6,"kind":"parameter","displayName":"Delete After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"Delete objects from the bucket after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieve over and over again on the polls."},"destinationBucket":{"index":7,"kind":"parameter","displayName":"Destination Bucket","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"Define the destination bucket where an object must be moved when moveAfterRead is set to true."},"downloadFileName":{"index":8,"kind":"parameter","displayName":"Download File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"The folder or filename to use when downloading the blob. By default, this specifies the folder name, and the name of the file is the blob name. For example, setting this to mydownload will be the same as setting mydownload/${file:name}. You can use dynamic expressions for fine-grained control. For example, you can specify ${date:now:yyyyMMdd}/${file:name} to store the blob in sub folders based on today's day. Only ${file:name} and ${file:name.noext} is supported as dynamic tokens for the blob name."},"filter":{"index":9,"kind":"parameter","displayName":"Filter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"A regular expression to include only blobs with name matching it."},"includeBody":{"index":10,"kind":"parameter","displayName":"Include Body","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"If it is true, the Object exchange will be consumed and put into the body. If false the Object stream will be put raw into the body and the headers will be set with the object metadata."},"includeFolders":{"index":11,"kind":"parameter","displayName":"Include Folders","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those"},"moveAfterRead":{"index":12,"kind":"parameter","displayName":"Move After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"Move objects from the origin bucket to a different bucket after they have been retrieved. To accomplish the operation the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved."},"sendEmptyMessageWhenIdle":{"index":13,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":17,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"objectName":{"index":18,"kind":"parameter","displayName":"Object Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"The Object name inside the bucket"},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.google.storage.GoogleCloudStorageOperations","enum":["copyObject","listObjects","deleteObject","deleteBucket","listBuckets","getObject","createDownloadLink"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration","configurationField":"configuration","description":"Set the operation for the producer"},"lazyStartProducer":{"index":20,"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."},"backoffErrorThreshold":{"index":21,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":22,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":23,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":24,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":25,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":26,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":27,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":28,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":29,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":30,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":31,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":32,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":33,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":34,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} , -{"component":{"kind":"component","name":"graphql","title":"GraphQL","description":"Send GraphQL queries and mutations to external systems.","deprecated":false,"firstVersion":"3.0.0","label":"api","javaType":"org.apache.camel.component.graphql.GraphqlComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-graphql","version":"4.8.1","scheme":"graphql","extendsScheme":"","syntax":"graphql:httpUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"remote":true},"properties":{"httpUri":{"index":0,"kind":"path","displayName":"Http Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The GraphQL server URI."},"operationName":{"index":1,"kind":"parameter","displayName":"Operation Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The query or mutation name."},"proxyHost":{"index":2,"kind":"parameter","displayName":"Proxy Host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The proxy host in the format hostname:port."},"query":{"index":3,"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The query text."},"queryFile":{"index":4,"kind":"parameter","displayName":"Query File","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The query file name located in the classpath."},"queryHeader":{"index":5,"kind":"parameter","displayName":"Query Header","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of a header containing the GraphQL query."},"variables":{"index":6,"kind":"parameter","displayName":"Variables","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.util.json.JsonObject","deprecated":false,"autowired":false,"secret":false,"description":"The JsonObject instance containing the operation variables."},"variablesHeader":{"index":7,"kind":"parameter","displayName":"Variables Header","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of a header containing a JsonObject instance containing the operation variables."},"lazyStartProducer":{"index":8,"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."},"accessToken":{"index":9,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The access token sent in the Authorization header."},"jwtAuthorizationType":{"index":10,"kind":"parameter","displayName":"Jwt Authorization Type","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Bearer","description":"The JWT Authorization type. Default is Bearer."},"password":{"index":11,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The password for Basic authentication."},"username":{"index":12,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The username for Basic authentication."}}} +{"component":{"kind":"component","name":"graphql","title":"GraphQL","description":"Send GraphQL queries and mutations to external systems.","deprecated":false,"firstVersion":"3.0.0","label":"api","javaType":"org.apache.camel.component.graphql.GraphqlComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-graphql","version":"4.8.2","scheme":"graphql","extendsScheme":"","syntax":"graphql:httpUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"remote":true},"properties":{"httpUri":{"index":0,"kind":"path","displayName":"Http Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The GraphQL server URI."},"operationName":{"index":1,"kind":"parameter","displayName":"Operation Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The query or mutation name."},"proxyHost":{"index":2,"kind":"parameter","displayName":"Proxy Host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The proxy host in the format hostname:port."},"query":{"index":3,"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The query text."},"queryFile":{"index":4,"kind":"parameter","displayName":"Query File","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The query file name located in the classpath."},"queryHeader":{"index":5,"kind":"parameter","displayName":"Query Header","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of a header containing the GraphQL query."},"variables":{"index":6,"kind":"parameter","displayName":"Variables","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.util.json.JsonObject","deprecated":false,"autowired":false,"secret":false,"description":"The JsonObject instance containing the operation variables."},"variablesHeader":{"index":7,"kind":"parameter","displayName":"Variables Header","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of a header containing a JsonObject instance containing the operation variables."},"lazyStartProducer":{"index":8,"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."},"accessToken":{"index":9,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The access token sent in the Authorization header."},"jwtAuthorizationType":{"index":10,"kind":"parameter","displayName":"Jwt Authorization Type","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Bearer","description":"The JWT Authorization type. Default is Bearer."},"password":{"index":11,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The password for Basic authentication."},"username":{"index":12,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The username for Basic authentication."}}} , -{"component":{"kind":"component","name":"grpc","title":"gRPC","description":"Expose gRPC endpoints and access external gRPC endpoints.","deprecated":false,"firstVersion":"2.19.0","label":"rpc","javaType":"org.apache.camel.component.grpc.GrpcComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-grpc","version":"4.8.1","scheme":"grpc","extendsScheme":"","syntax":"grpc:host:port/service","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelGrpcMethodName":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Method name handled by the consumer service","constantName":"org.apache.camel.component.grpc.GrpcConstants#GRPC_METHOD_NAME_HEADER"},"CamelGrpcUserAgent":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If provided, the given agent will prepend the gRPC library's user agent information","constantName":"org.apache.camel.component.grpc.GrpcConstants#GRPC_USER_AGENT_HEADER"},"CamelGrpcEventType":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Received event type from the sent request. Possible values: onNext onCompleted onError","constantName":"org.apache.camel.component.grpc.GrpcConstants#GRPC_EVENT_TYPE_HEADER"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The gRPC server host name. This is localhost or 0.0.0.0 when being a consumer or remote server host name when using producer."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The gRPC local or remote server port"},"service":{"index":2,"kind":"path","displayName":"Service","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Fully qualified service name from the protocol buffer descriptor file (package dot service definition name)"},"flowControlWindow":{"index":3,"kind":"parameter","displayName":"Flow Control Window","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1048576,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The HTTP/2 flow control window size (MiB)"},"maxMessageSize":{"index":4,"kind":"parameter","displayName":"Max Message Size","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":4194304,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The maximum message size allowed to be received/sent (MiB)"},"autoDiscoverServerInterceptors":{"index":5,"kind":"parameter","displayName":"Auto Discover Server Interceptors","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Setting the autoDiscoverServerInterceptors mechanism, if true, the component will look for a ServerInterceptor instance in the registry automatically otherwise it will skip that checking."},"consumerStrategy":{"index":6,"kind":"parameter","displayName":"Consumer Strategy","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.grpc.GrpcConsumerStrategy","enum":["AGGREGATION","PROPAGATION","DELEGATION"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PROPAGATION","configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"This option specifies the top-level strategy for processing service requests and responses in streaming mode. If an aggregation strategy is selected, all requests will be accumulated in the list, then transferred to the flow, and the accumulated responses will be sent to the sender. If a propagation strategy is selected, request is sent to the stream, and the response will be immediately sent back to the sender. If a delegation strategy is selected, request is sent to the stream, but no response generated under the assumption that all necessary responses will be sent at another part of route. Delegation strategy always comes with routeControlledStreamObserver=true to be able to achieve the assumption."},"forwardOnCompleted":{"index":7,"kind":"parameter","displayName":"Forward On Completed","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Determines if onCompleted events should be pushed to the Camel route."},"forwardOnError":{"index":8,"kind":"parameter","displayName":"Forward On Error","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body."},"initialFlowControlWindow":{"index":9,"kind":"parameter","displayName":"Initial Flow Control Window","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1048576,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets the initial flow control window in bytes."},"keepAliveTime":{"index":10,"kind":"parameter","displayName":"Keep Alive Time","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":7200000,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets a custom keepalive time in milliseconds, the delay time for sending next keepalive ping. A value of Long.MAX_VALUE or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE will disable keepalive."},"keepAliveTimeout":{"index":11,"kind":"parameter","displayName":"Keep Alive Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":20000,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets a custom keepalive timeout in milliseconds, the timeout for keepalive ping requests."},"maxConcurrentCallsPerConnection":{"index":12,"kind":"parameter","displayName":"Max Concurrent Calls Per Connection","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The maximum number of concurrent calls permitted for each incoming server connection. Defaults to no limit."},"maxConnectionAge":{"index":13,"kind":"parameter","displayName":"Max Connection Age","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":9223372036854775807,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets a custom max connection age in milliseconds. Connections lasting longer than which will be gracefully terminated. A random jitter of /-10% will be added to the value. A value of Long.MAX_VALUE (the default) or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE will disable max connection age."},"maxConnectionAgeGrace":{"index":14,"kind":"parameter","displayName":"Max Connection Age Grace","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":9223372036854775807,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets a custom grace time in milliseconds for the graceful connection termination. A value of Long.MAX_VALUE (the default) or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE is considered infinite."},"maxConnectionIdle":{"index":15,"kind":"parameter","displayName":"Max Connection Idle","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":9223372036854775807,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets a custom max connection idle time in milliseconds. Connection being idle for longer than which will be gracefully terminated. A value of Long.MAX_VALUE (the default) or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE will disable max connection idle"},"maxInboundMetadataSize":{"index":16,"kind":"parameter","displayName":"Max Inbound Metadata Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets the maximum size of metadata allowed to be received. The default is 8 KiB."},"maxRstFramesPerWindow":{"index":17,"kind":"parameter","displayName":"Max Rst Frames Per Window","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Limits the rate of incoming RST_STREAM frames per connection to maxRstFramesPerWindow per maxRstPeriodSeconds. This option MUST be used in conjunction with maxRstPeriodSeconds for it to be effective."},"maxRstPeriodSeconds":{"index":18,"kind":"parameter","displayName":"Max Rst Period Seconds","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Limits the rate of incoming RST_STREAM frames per maxRstPeriodSeconds. This option MUST be used in conjunction with maxRstFramesPerWindow for it to be effective."},"permitKeepAliveTime":{"index":19,"kind":"parameter","displayName":"Permit Keep Alive Time","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":300000,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets the most aggressive keep-alive time in milliseconds that clients are permitted to configure. The server will try to detect clients exceeding this rate and will forcefully close the connection."},"permitKeepAliveWithoutCalls":{"index":20,"kind":"parameter","displayName":"Permit Keep Alive Without Calls","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets whether to allow clients to send keep-alive HTTP/ 2 PINGs even if there are no outstanding RPCs on the connection."},"routeControlledStreamObserver":{"index":21,"kind":"parameter","displayName":"Route Controlled Stream Observer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Lets the route to take control over stream observer. If this value is set to true, then the response observer of gRPC call will be set with the name GrpcConstants.GRPC_RESPONSE_OBSERVER in the Exchange object. Please note that the stream observer's onNext(), onError(), onCompleted() methods should be called in the route."},"bridgeErrorHandler":{"index":22,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":23,"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":{"index":24,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"autoDiscoverClientInterceptors":{"index":25,"kind":"parameter","displayName":"Auto Discover Client Interceptors","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Setting the autoDiscoverClientInterceptors mechanism, if true, the component will look for a ClientInterceptor instance in the registry automatically otherwise it will skip that checking."},"inheritExchangePropertiesForReplies":{"index":26,"kind":"parameter","displayName":"Inherit Exchange Properties For Replies","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Copies exchange properties from original exchange to all exchanges created for route defined by streamRepliesTo."},"method":{"index":27,"kind":"parameter","displayName":"Method","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"gRPC method name"},"producerStrategy":{"index":28,"kind":"parameter","displayName":"Producer Strategy","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.grpc.GrpcProducerStrategy","enum":["SIMPLE","STREAMING"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SIMPLE","configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The mode used to communicate with a remote gRPC server. In SIMPLE mode a single exchange is translated into a remote procedure call. In STREAMING mode all exchanges will be sent within the same request (input and output of the recipient gRPC service must be of type 'stream')."},"streamRepliesTo":{"index":29,"kind":"parameter","displayName":"Stream Replies To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"When using STREAMING client mode, it indicates the endpoint where responses should be forwarded."},"toRouteControlledStreamObserver":{"index":30,"kind":"parameter","displayName":"To Route Controlled Stream Observer","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Expects that exchange property GrpcConstants.GRPC_RESPONSE_OBSERVER is set. Takes its value and calls onNext, onError and onComplete on that StreamObserver. All other gRPC parameters are ignored."},"userAgent":{"index":31,"kind":"parameter","displayName":"User Agent","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The user agent header passed to the server"},"lazyStartProducer":{"index":32,"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."},"synchronous":{"index":33,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used"},"authenticationType":{"index":34,"kind":"parameter","displayName":"Authentication Type","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.grpc.GrpcAuthType","enum":["NONE","GOOGLE","JWT"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"NONE","configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Authentication method type in advance to the SSL/TLS negotiation"},"jwtAlgorithm":{"index":35,"kind":"parameter","displayName":"Jwt Algorithm","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.grpc.auth.jwt.JwtAlgorithm","enum":["HMAC256","HMAC384","HMAC512"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HMAC256","configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"JSON Web Token sign algorithm"},"jwtIssuer":{"index":36,"kind":"parameter","displayName":"Jwt Issuer","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"JSON Web Token issuer"},"jwtSecret":{"index":37,"kind":"parameter","displayName":"Jwt Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"JSON Web Token secret"},"jwtSubject":{"index":38,"kind":"parameter","displayName":"Jwt Subject","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"JSON Web Token subject"},"keyCertChainResource":{"index":39,"kind":"parameter","displayName":"Key Cert Chain Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The X.509 certificate chain file resource in PEM format link"},"keyPassword":{"index":40,"kind":"parameter","displayName":"Key Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The PKCS#8 private key file password"},"keyResource":{"index":41,"kind":"parameter","displayName":"Key Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The PKCS#8 private key file resource in PEM format link"},"negotiationType":{"index":42,"kind":"parameter","displayName":"Negotiation Type","group":"security","label":"security","required":false,"type":"object","javaType":"io.grpc.netty.NegotiationType","enum":["TLS","PLAINTEXT_UPGRADE","PLAINTEXT"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PLAINTEXT","configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Identifies the security negotiation type used for HTTP/2 communication"},"serviceAccountResource":{"index":43,"kind":"parameter","displayName":"Service Account Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Service Account key file in JSON format resource link supported by the Google Cloud SDK"},"trustCertCollectionResource":{"index":44,"kind":"parameter","displayName":"Trust Cert Collection Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The trusted certificates collection file resource in PEM format for verifying the remote endpoint's certificate"}}} +{"component":{"kind":"component","name":"grpc","title":"gRPC","description":"Expose gRPC endpoints and access external gRPC endpoints.","deprecated":false,"firstVersion":"2.19.0","label":"rpc","javaType":"org.apache.camel.component.grpc.GrpcComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-grpc","version":"4.8.2","scheme":"grpc","extendsScheme":"","syntax":"grpc:host:port/service","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelGrpcMethodName":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Method name handled by the consumer service","constantName":"org.apache.camel.component.grpc.GrpcConstants#GRPC_METHOD_NAME_HEADER"},"CamelGrpcUserAgent":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If provided, the given agent will prepend the gRPC library's user agent information","constantName":"org.apache.camel.component.grpc.GrpcConstants#GRPC_USER_AGENT_HEADER"},"CamelGrpcEventType":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Received event type from the sent request. Possible values: onNext onCompleted onError","constantName":"org.apache.camel.component.grpc.GrpcConstants#GRPC_EVENT_TYPE_HEADER"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The gRPC server host name. This is localhost or 0.0.0.0 when being a consumer or remote server host name when using producer."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The gRPC local or remote server port"},"service":{"index":2,"kind":"path","displayName":"Service","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Fully qualified service name from the protocol buffer descriptor file (package dot service definition name)"},"flowControlWindow":{"index":3,"kind":"parameter","displayName":"Flow Control Window","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1048576,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The HTTP/2 flow control window size (MiB)"},"maxMessageSize":{"index":4,"kind":"parameter","displayName":"Max Message Size","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":4194304,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The maximum message size allowed to be received/sent (MiB)"},"autoDiscoverServerInterceptors":{"index":5,"kind":"parameter","displayName":"Auto Discover Server Interceptors","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Setting the autoDiscoverServerInterceptors mechanism, if true, the component will look for a ServerInterceptor instance in the registry automatically otherwise it will skip that checking."},"consumerStrategy":{"index":6,"kind":"parameter","displayName":"Consumer Strategy","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.grpc.GrpcConsumerStrategy","enum":["AGGREGATION","PROPAGATION","DELEGATION"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PROPAGATION","configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"This option specifies the top-level strategy for processing service requests and responses in streaming mode. If an aggregation strategy is selected, all requests will be accumulated in the list, then transferred to the flow, and the accumulated responses will be sent to the sender. If a propagation strategy is selected, request is sent to the stream, and the response will be immediately sent back to the sender. If a delegation strategy is selected, request is sent to the stream, but no response generated under the assumption that all necessary responses will be sent at another part of route. Delegation strategy always comes with routeControlledStreamObserver=true to be able to achieve the assumption."},"forwardOnCompleted":{"index":7,"kind":"parameter","displayName":"Forward On Completed","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Determines if onCompleted events should be pushed to the Camel route."},"forwardOnError":{"index":8,"kind":"parameter","displayName":"Forward On Error","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body."},"initialFlowControlWindow":{"index":9,"kind":"parameter","displayName":"Initial Flow Control Window","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1048576,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets the initial flow control window in bytes."},"keepAliveTime":{"index":10,"kind":"parameter","displayName":"Keep Alive Time","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":7200000,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets a custom keepalive time in milliseconds, the delay time for sending next keepalive ping. A value of Long.MAX_VALUE or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE will disable keepalive."},"keepAliveTimeout":{"index":11,"kind":"parameter","displayName":"Keep Alive Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":20000,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets a custom keepalive timeout in milliseconds, the timeout for keepalive ping requests."},"maxConcurrentCallsPerConnection":{"index":12,"kind":"parameter","displayName":"Max Concurrent Calls Per Connection","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The maximum number of concurrent calls permitted for each incoming server connection. Defaults to no limit."},"maxConnectionAge":{"index":13,"kind":"parameter","displayName":"Max Connection Age","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":9223372036854775807,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets a custom max connection age in milliseconds. Connections lasting longer than which will be gracefully terminated. A random jitter of /-10% will be added to the value. A value of Long.MAX_VALUE (the default) or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE will disable max connection age."},"maxConnectionAgeGrace":{"index":14,"kind":"parameter","displayName":"Max Connection Age Grace","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":9223372036854775807,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets a custom grace time in milliseconds for the graceful connection termination. A value of Long.MAX_VALUE (the default) or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE is considered infinite."},"maxConnectionIdle":{"index":15,"kind":"parameter","displayName":"Max Connection Idle","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":9223372036854775807,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets a custom max connection idle time in milliseconds. Connection being idle for longer than which will be gracefully terminated. A value of Long.MAX_VALUE (the default) or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE will disable max connection idle"},"maxInboundMetadataSize":{"index":16,"kind":"parameter","displayName":"Max Inbound Metadata Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets the maximum size of metadata allowed to be received. The default is 8 KiB."},"maxRstFramesPerWindow":{"index":17,"kind":"parameter","displayName":"Max Rst Frames Per Window","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Limits the rate of incoming RST_STREAM frames per connection to maxRstFramesPerWindow per maxRstPeriodSeconds. This option MUST be used in conjunction with maxRstPeriodSeconds for it to be effective."},"maxRstPeriodSeconds":{"index":18,"kind":"parameter","displayName":"Max Rst Period Seconds","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Limits the rate of incoming RST_STREAM frames per maxRstPeriodSeconds. This option MUST be used in conjunction with maxRstFramesPerWindow for it to be effective."},"permitKeepAliveTime":{"index":19,"kind":"parameter","displayName":"Permit Keep Alive Time","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":300000,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets the most aggressive keep-alive time in milliseconds that clients are permitted to configure. The server will try to detect clients exceeding this rate and will forcefully close the connection."},"permitKeepAliveWithoutCalls":{"index":20,"kind":"parameter","displayName":"Permit Keep Alive Without Calls","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets whether to allow clients to send keep-alive HTTP/ 2 PINGs even if there are no outstanding RPCs on the connection."},"routeControlledStreamObserver":{"index":21,"kind":"parameter","displayName":"Route Controlled Stream Observer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Lets the route to take control over stream observer. If this value is set to true, then the response observer of gRPC call will be set with the name GrpcConstants.GRPC_RESPONSE_OBSERVER in the Exchange object. Please note that the stream observer's onNext(), onError(), onCompleted() methods should be called in the route."},"bridgeErrorHandler":{"index":22,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":23,"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":{"index":24,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"autoDiscoverClientInterceptors":{"index":25,"kind":"parameter","displayName":"Auto Discover Client Interceptors","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Setting the autoDiscoverClientInterceptors mechanism, if true, the component will look for a ClientInterceptor instance in the registry automatically otherwise it will skip that checking."},"inheritExchangePropertiesForReplies":{"index":26,"kind":"parameter","displayName":"Inherit Exchange Properties For Replies","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Copies exchange properties from original exchange to all exchanges created for route defined by streamRepliesTo."},"method":{"index":27,"kind":"parameter","displayName":"Method","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"gRPC method name"},"producerStrategy":{"index":28,"kind":"parameter","displayName":"Producer Strategy","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.grpc.GrpcProducerStrategy","enum":["SIMPLE","STREAMING"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SIMPLE","configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The mode used to communicate with a remote gRPC server. In SIMPLE mode a single exchange is translated into a remote procedure call. In STREAMING mode all exchanges will be sent within the same request (input and output of the recipient gRPC service must be of type 'stream')."},"streamRepliesTo":{"index":29,"kind":"parameter","displayName":"Stream Replies To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"When using STREAMING client mode, it indicates the endpoint where responses should be forwarded."},"toRouteControlledStreamObserver":{"index":30,"kind":"parameter","displayName":"To Route Controlled Stream Observer","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Expects that exchange property GrpcConstants.GRPC_RESPONSE_OBSERVER is set. Takes its value and calls onNext, onError and onComplete on that StreamObserver. All other gRPC parameters are ignored."},"userAgent":{"index":31,"kind":"parameter","displayName":"User Agent","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The user agent header passed to the server"},"lazyStartProducer":{"index":32,"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."},"synchronous":{"index":33,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used"},"authenticationType":{"index":34,"kind":"parameter","displayName":"Authentication Type","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.grpc.GrpcAuthType","enum":["NONE","GOOGLE","JWT"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"NONE","configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Authentication method type in advance to the SSL/TLS negotiation"},"jwtAlgorithm":{"index":35,"kind":"parameter","displayName":"Jwt Algorithm","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.grpc.auth.jwt.JwtAlgorithm","enum":["HMAC256","HMAC384","HMAC512"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HMAC256","configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"JSON Web Token sign algorithm"},"jwtIssuer":{"index":36,"kind":"parameter","displayName":"Jwt Issuer","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"JSON Web Token issuer"},"jwtSecret":{"index":37,"kind":"parameter","displayName":"Jwt Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"JSON Web Token secret"},"jwtSubject":{"index":38,"kind":"parameter","displayName":"Jwt Subject","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"JSON Web Token subject"},"keyCertChainResource":{"index":39,"kind":"parameter","displayName":"Key Cert Chain Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The X.509 certificate chain file resource in PEM format link"},"keyPassword":{"index":40,"kind":"parameter","displayName":"Key Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The PKCS#8 private key file password"},"keyResource":{"index":41,"kind":"parameter","displayName":"Key Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The PKCS#8 private key file resource in PEM format link"},"negotiationType":{"index":42,"kind":"parameter","displayName":"Negotiation Type","group":"security","label":"security","required":false,"type":"object","javaType":"io.grpc.netty.NegotiationType","enum":["TLS","PLAINTEXT_UPGRADE","PLAINTEXT"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PLAINTEXT","configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Identifies the security negotiation type used for HTTP/2 communication"},"serviceAccountResource":{"index":43,"kind":"parameter","displayName":"Service Account Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"Service Account key file in JSON format resource link supported by the Google Cloud SDK"},"trustCertCollectionResource":{"index":44,"kind":"parameter","displayName":"Trust Cert Collection Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.grpc.GrpcConfiguration","configurationField":"configuration","description":"The trusted certificates collection file resource in PEM format for verifying the remote endpoint's certificate"}}} , -{"component":{"kind":"component","name":"hashicorp-vault","title":"Hashicorp Vault","description":"Manage secrets in Hashicorp Vault Service","deprecated":false,"firstVersion":"3.18.0","label":"cloud,cloud","javaType":"org.apache.camel.component.hashicorp.vault.HashicorpVaultComponent","supportLevel":"Stable","metadata":{"vault":"hashicorp-vault"},"groupId":"org.apache.camel","artifactId":"camel-hashicorp-vault","version":"4.8.1","scheme":"hashicorp-vault","extendsScheme":"","syntax":"hashicorp-vault:secretsEngine","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelHashicorpVaultProducerOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Overrides the desired operation to be used in the producer.","constantName":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConstants#OPERATION"},"CamelHashicorpVaultSecretPath":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set the desired secret path as header.","constantName":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConstants#SECRET_PATH"},"CamelHashicorpVaultSecretVersion":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set the desired secret version as header.","constantName":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConstants#SECRET_VERSION"}},"properties":{"secretsEngine":{"index":0,"kind":"path","displayName":"Secrets Engine","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Vault Name to be used"},"host":{"index":1,"kind":"parameter","displayName":"Host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Hashicorp Vault instance host to be used"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.hashicorp.vault.HashicorpVaultOperation","enum":["createSecret","getSecret","deleteSecret","listSecrets"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Operation to be performed"},"port":{"index":3,"kind":"parameter","displayName":"Port","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"8200","configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Hashicorp Vault instance port to be used"},"scheme":{"index":4,"kind":"parameter","displayName":"Scheme","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https","configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Hashicorp Vault instance scheme to be used"},"secretPath":{"index":5,"kind":"parameter","displayName":"Secret Path","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Hashicorp Vault instance secret Path to be used"},"vaultTemplate":{"index":6,"kind":"parameter","displayName":"Vault Template","group":"producer","label":"","required":false,"type":"object","javaType":"org.springframework.vault.core.VaultTemplate","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Instance of Vault template"},"lazyStartProducer":{"index":7,"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."},"token":{"index":8,"kind":"parameter","displayName":"Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Token to be used"}}} +{"component":{"kind":"component","name":"hashicorp-vault","title":"Hashicorp Vault","description":"Manage secrets in Hashicorp Vault Service","deprecated":false,"firstVersion":"3.18.0","label":"cloud,cloud","javaType":"org.apache.camel.component.hashicorp.vault.HashicorpVaultComponent","supportLevel":"Stable","metadata":{"vault":"hashicorp-vault"},"groupId":"org.apache.camel","artifactId":"camel-hashicorp-vault","version":"4.8.2","scheme":"hashicorp-vault","extendsScheme":"","syntax":"hashicorp-vault:secretsEngine","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelHashicorpVaultProducerOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Overrides the desired operation to be used in the producer.","constantName":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConstants#OPERATION"},"CamelHashicorpVaultSecretPath":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set the desired secret path as header.","constantName":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConstants#SECRET_PATH"},"CamelHashicorpVaultSecretVersion":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set the desired secret version as header.","constantName":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConstants#SECRET_VERSION"}},"properties":{"secretsEngine":{"index":0,"kind":"path","displayName":"Secrets Engine","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Vault Name to be used"},"host":{"index":1,"kind":"parameter","displayName":"Host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Hashicorp Vault instance host to be used"},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.hashicorp.vault.HashicorpVaultOperation","enum":["createSecret","getSecret","deleteSecret","listSecrets"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Operation to be performed"},"port":{"index":3,"kind":"parameter","displayName":"Port","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"8200","configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Hashicorp Vault instance port to be used"},"scheme":{"index":4,"kind":"parameter","displayName":"Scheme","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https","configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Hashicorp Vault instance scheme to be used"},"secretPath":{"index":5,"kind":"parameter","displayName":"Secret Path","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Hashicorp Vault instance secret Path to be used"},"vaultTemplate":{"index":6,"kind":"parameter","displayName":"Vault Template","group":"producer","label":"","required":false,"type":"object","javaType":"org.springframework.vault.core.VaultTemplate","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Instance of Vault template"},"lazyStartProducer":{"index":7,"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."},"token":{"index":8,"kind":"parameter","displayName":"Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.hashicorp.vault.HashicorpVaultConfiguration","configurationField":"configuration","description":"Token to be used"}}} , -{"component":{"kind":"component","name":"hazelcast-atomicvalue","title":"Hazelcast Atomic Number","description":"Increment, decrement, set, etc. Hazelcast atomic number (a grid wide number).","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.atomicnumber.HazelcastAtomicnumberComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.1","scheme":"hazelcast-atomicvalue","extendsScheme":"","syntax":"hazelcast-atomicvalue:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastOperationType":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"producer","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"lazyStartProducer":{"index":5,"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."}}} +{"component":{"kind":"component","name":"hazelcast-atomicvalue","title":"Hazelcast Atomic Number","description":"Increment, decrement, set, etc. Hazelcast atomic number (a grid wide number).","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.atomicnumber.HazelcastAtomicnumberComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.2","scheme":"hazelcast-atomicvalue","extendsScheme":"","syntax":"hazelcast-atomicvalue:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastOperationType":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"producer","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"lazyStartProducer":{"index":5,"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."}}} , -{"component":{"kind":"component","name":"hazelcast-instance","title":"Hazelcast Instance","description":"Consume join/leave events of a cache instance in a Hazelcast cluster.","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.instance.HazelcastInstanceComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.1","scheme":"hazelcast-instance","extendsScheme":"","syntax":"hazelcast-instance:cacheName","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastListenerAction":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastInstanceHost":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The host name of the instance","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#INSTANCE_HOST"},"CamelHazelcastInstancePort":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The port number of the instance","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#INSTANCE_PORT"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"consumer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"consumer","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} +{"component":{"kind":"component","name":"hazelcast-instance","title":"Hazelcast Instance","description":"Consume join/leave events of a cache instance in a Hazelcast cluster.","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.instance.HazelcastInstanceComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.2","scheme":"hazelcast-instance","extendsScheme":"","syntax":"hazelcast-instance:cacheName","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastListenerAction":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastInstanceHost":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The host name of the instance","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#INSTANCE_HOST"},"CamelHazelcastInstancePort":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The port number of the instance","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#INSTANCE_PORT"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"consumer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"consumer","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} , -{"component":{"kind":"component","name":"hazelcast-list","title":"Hazelcast List","description":"Perform operations on Hazelcast distributed list.","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.list.HazelcastListComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.1","scheme":"hazelcast-list","extendsScheme":"","syntax":"hazelcast-list:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastObjectId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastObjectIndex":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index of the object","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_POS"},"CamelHazelcastListenerAction":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastOperationType":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."}}} +{"component":{"kind":"component","name":"hazelcast-list","title":"Hazelcast List","description":"Perform operations on Hazelcast distributed list.","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.list.HazelcastListComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.2","scheme":"hazelcast-list","extendsScheme":"","syntax":"hazelcast-list:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastObjectId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastObjectIndex":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index of the object","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_POS"},"CamelHazelcastListenerAction":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastOperationType":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."}}} , -{"component":{"kind":"component","name":"hazelcast-map","title":"Hazelcast Map","description":"Perform operations on Hazelcast distributed map.","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.map.HazelcastMapComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.1","scheme":"hazelcast-map","extendsScheme":"","syntax":"hazelcast-map:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastObjectId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastObjectValue":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_VALUE"},"CamelHazelcastObjectTtlValue":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of the TTL","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#TTL_VALUE"},"CamelHazelcastObjectTtlUnit":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of time unit ( DAYS / HOURS / MINUTES / ....","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#TTL_UNIT"},"CamelHazelcastQuery":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query to execute against the map with a sql like syntax (see http://www.hazelcast.com/)","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#QUERY"},"CamelHazelcastListenerAction":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastOperationType":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."}}} +{"component":{"kind":"component","name":"hazelcast-map","title":"Hazelcast Map","description":"Perform operations on Hazelcast distributed map.","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.map.HazelcastMapComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.2","scheme":"hazelcast-map","extendsScheme":"","syntax":"hazelcast-map:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastObjectId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastObjectValue":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_VALUE"},"CamelHazelcastObjectTtlValue":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of the TTL","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#TTL_VALUE"},"CamelHazelcastObjectTtlUnit":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of time unit ( DAYS / HOURS / MINUTES / ....","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#TTL_UNIT"},"CamelHazelcastQuery":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query to execute against the map with a sql like syntax (see http://www.hazelcast.com/)","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#QUERY"},"CamelHazelcastListenerAction":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastOperationType":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."}}} , -{"component":{"kind":"component","name":"hazelcast-multimap","title":"Hazelcast Multimap","description":"Perform operations on Hazelcast distributed multimap.","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.multimap.HazelcastMultimapComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.1","scheme":"hazelcast-multimap","extendsScheme":"","syntax":"hazelcast-multimap:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastObjectId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastListenerAction":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastCacheType":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the cache - here multimap","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_TYPE"},"CamelHazelcastOperationType":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."}}} +{"component":{"kind":"component","name":"hazelcast-multimap","title":"Hazelcast Multimap","description":"Perform operations on Hazelcast distributed multimap.","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.multimap.HazelcastMultimapComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.2","scheme":"hazelcast-multimap","extendsScheme":"","syntax":"hazelcast-multimap:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastObjectId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastListenerAction":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastCacheType":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the cache - here multimap","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_TYPE"},"CamelHazelcastOperationType":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."}}} , -{"component":{"kind":"component","name":"hazelcast-queue","title":"Hazelcast Queue","description":"Perform operations on Hazelcast distributed queue.","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering,messaging","javaType":"org.apache.camel.component.hazelcast.queue.HazelcastQueueComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.1","scheme":"hazelcast-queue","extendsScheme":"","syntax":"hazelcast-queue:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastObjectId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastDrainToCollection":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection to transfer elements into","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#DRAIN_TO_COLLECTION"},"CamelHazelcastListenerAction":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastOperationType":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"pollingTimeout":{"index":5,"kind":"parameter","displayName":"Polling Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.hazelcast.queue.HazelcastQueueConfiguration","configurationField":"configuration","description":"Define the polling timeout of the Queue consumer in Poll mode"},"poolSize":{"index":6,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.hazelcast.queue.HazelcastQueueConfiguration","configurationField":"configuration","description":"Define the Pool size for Queue Consumer Executor"},"queueConsumerMode":{"index":7,"kind":"parameter","displayName":"Queue Consumer Mode","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.queue.HazelcastQueueConsumerMode","enum":["listen","poll"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Listen","configurationClass":"org.apache.camel.component.hazelcast.queue.HazelcastQueueConfiguration","configurationField":"configuration","description":"Define the Queue Consumer mode: Listen or Poll"},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":11,"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."}}} +{"component":{"kind":"component","name":"hazelcast-queue","title":"Hazelcast Queue","description":"Perform operations on Hazelcast distributed queue.","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering,messaging","javaType":"org.apache.camel.component.hazelcast.queue.HazelcastQueueComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.2","scheme":"hazelcast-queue","extendsScheme":"","syntax":"hazelcast-queue:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastObjectId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastDrainToCollection":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection to transfer elements into","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#DRAIN_TO_COLLECTION"},"CamelHazelcastListenerAction":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastOperationType":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"pollingTimeout":{"index":5,"kind":"parameter","displayName":"Polling Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.hazelcast.queue.HazelcastQueueConfiguration","configurationField":"configuration","description":"Define the polling timeout of the Queue consumer in Poll mode"},"poolSize":{"index":6,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.hazelcast.queue.HazelcastQueueConfiguration","configurationField":"configuration","description":"Define the Pool size for Queue Consumer Executor"},"queueConsumerMode":{"index":7,"kind":"parameter","displayName":"Queue Consumer Mode","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.queue.HazelcastQueueConsumerMode","enum":["listen","poll"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Listen","configurationClass":"org.apache.camel.component.hazelcast.queue.HazelcastQueueConfiguration","configurationField":"configuration","description":"Define the Queue Consumer mode: Listen or Poll"},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":11,"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."}}} , -{"component":{"kind":"component","name":"hazelcast-replicatedmap","title":"Hazelcast Replicated Map","description":"Perform operations on Hazelcast replicated map.","deprecated":false,"firstVersion":"2.16.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.replicatedmap.HazelcastReplicatedmapComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.1","scheme":"hazelcast-replicatedmap","extendsScheme":"","syntax":"hazelcast-replicatedmap:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastObjectId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastListenerAction":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastOperationType":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."}}} +{"component":{"kind":"component","name":"hazelcast-replicatedmap","title":"Hazelcast Replicated Map","description":"Perform operations on Hazelcast replicated map.","deprecated":false,"firstVersion":"2.16.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.replicatedmap.HazelcastReplicatedmapComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.2","scheme":"hazelcast-replicatedmap","extendsScheme":"","syntax":"hazelcast-replicatedmap:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastObjectId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastListenerAction":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastOperationType":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."}}} , -{"component":{"kind":"component","name":"hazelcast-ringbuffer","title":"Hazelcast Ringbuffer","description":"Perform operations on Hazelcast distributed ringbuffer.","deprecated":false,"firstVersion":"2.16.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.ringbuffer.HazelcastRingbufferComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.1","scheme":"hazelcast-ringbuffer","extendsScheme":"","syntax":"hazelcast-ringbuffer:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastOperationType":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"producer","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"lazyStartProducer":{"index":5,"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."}}} +{"component":{"kind":"component","name":"hazelcast-ringbuffer","title":"Hazelcast Ringbuffer","description":"Perform operations on Hazelcast distributed ringbuffer.","deprecated":false,"firstVersion":"2.16.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.ringbuffer.HazelcastRingbufferComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.2","scheme":"hazelcast-ringbuffer","extendsScheme":"","syntax":"hazelcast-ringbuffer:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastOperationType":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"producer","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"lazyStartProducer":{"index":5,"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."}}} , -{"component":{"kind":"component","name":"hazelcast-seda","title":"Hazelcast SEDA","description":"Asynchronously send/receive Exchanges between Camel routes running on potentially distinct JVMs/hosts backed by Hazelcast BlockingQueue.","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.seda.HazelcastSedaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.1","scheme":"hazelcast-seda","extendsScheme":"","syntax":"hazelcast-seda:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."},"concurrentConsumers":{"index":9,"kind":"parameter","displayName":"Concurrent Consumers","group":"seda","label":"seda","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.hazelcast.seda.HazelcastSedaConfiguration","configurationField":"configuration","description":"To use concurrent consumers polling from the SEDA queue."},"onErrorDelay":{"index":10,"kind":"parameter","displayName":"On Error Delay","group":"seda","label":"seda","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.hazelcast.seda.HazelcastSedaConfiguration","configurationField":"configuration","description":"Milliseconds before consumer continues polling after an error has occurred."},"pollTimeout":{"index":11,"kind":"parameter","displayName":"Poll Timeout","group":"seda","label":"seda","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.hazelcast.seda.HazelcastSedaConfiguration","configurationField":"configuration","description":"The timeout used when consuming from the SEDA queue. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."},"transacted":{"index":12,"kind":"parameter","displayName":"Transacted","group":"seda","label":"seda","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.hazelcast.seda.HazelcastSedaConfiguration","configurationField":"configuration","description":"If set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete."},"transferExchange":{"index":13,"kind":"parameter","displayName":"Transfer Exchange","group":"seda","label":"seda","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.hazelcast.seda.HazelcastSedaConfiguration","configurationField":"configuration","description":"If set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped."}}} +{"component":{"kind":"component","name":"hazelcast-seda","title":"Hazelcast SEDA","description":"Asynchronously send/receive Exchanges between Camel routes running on potentially distinct JVMs/hosts backed by Hazelcast BlockingQueue.","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.seda.HazelcastSedaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.2","scheme":"hazelcast-seda","extendsScheme":"","syntax":"hazelcast-seda:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."},"concurrentConsumers":{"index":9,"kind":"parameter","displayName":"Concurrent Consumers","group":"seda","label":"seda","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.hazelcast.seda.HazelcastSedaConfiguration","configurationField":"configuration","description":"To use concurrent consumers polling from the SEDA queue."},"onErrorDelay":{"index":10,"kind":"parameter","displayName":"On Error Delay","group":"seda","label":"seda","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.hazelcast.seda.HazelcastSedaConfiguration","configurationField":"configuration","description":"Milliseconds before consumer continues polling after an error has occurred."},"pollTimeout":{"index":11,"kind":"parameter","displayName":"Poll Timeout","group":"seda","label":"seda","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.hazelcast.seda.HazelcastSedaConfiguration","configurationField":"configuration","description":"The timeout used when consuming from the SEDA queue. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."},"transacted":{"index":12,"kind":"parameter","displayName":"Transacted","group":"seda","label":"seda","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.hazelcast.seda.HazelcastSedaConfiguration","configurationField":"configuration","description":"If set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete."},"transferExchange":{"index":13,"kind":"parameter","displayName":"Transfer Exchange","group":"seda","label":"seda","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.hazelcast.seda.HazelcastSedaConfiguration","configurationField":"configuration","description":"If set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped."}}} , -{"component":{"kind":"component","name":"hazelcast-set","title":"Hazelcast Set","description":"Perform operations on Hazelcast distributed set.","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.set.HazelcastSetComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.1","scheme":"hazelcast-set","extendsScheme":"","syntax":"hazelcast-set:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastObjectId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastListenerAction":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastOperationType":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."}}} +{"component":{"kind":"component","name":"hazelcast-set","title":"Hazelcast Set","description":"Perform operations on Hazelcast distributed set.","deprecated":false,"firstVersion":"2.7.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.set.HazelcastSetComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.2","scheme":"hazelcast-set","extendsScheme":"","syntax":"hazelcast-set:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastObjectId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastListenerAction":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastOperationType":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."}}} , -{"component":{"kind":"component","name":"hazelcast-topic","title":"Hazelcast Topic","description":"Send and receive messages to/from Hazelcast distributed topic.","deprecated":false,"firstVersion":"2.15.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.topic.HazelcastTopicComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.1","scheme":"hazelcast-topic","extendsScheme":"","syntax":"hazelcast-topic:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastObjectId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastListenerAction":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastOperationType":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"reliable":{"index":5,"kind":"parameter","displayName":"Reliable","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.hazelcast.topic.HazelcastTopicConfiguration","configurationField":"configuration","description":"Define if the endpoint will use a reliable Topic struct or not."},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":9,"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."}}} +{"component":{"kind":"component","name":"hazelcast-topic","title":"Hazelcast Topic","description":"Send and receive messages to/from Hazelcast distributed topic.","deprecated":false,"firstVersion":"2.15.0","label":"cache,clustering","javaType":"org.apache.camel.component.hazelcast.topic.HazelcastTopicComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"4.8.2","scheme":"hazelcast-topic","extendsScheme":"","syntax":"hazelcast-topic:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHazelcastObjectId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastListenerAction":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastOperationType":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"index":1,"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastConfigUri":{"index":2,"kind":"parameter","displayName":"Hazelcast Config Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Hazelcast configuration file."},"hazelcastInstance":{"index":3,"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"index":4,"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"reliable":{"index":5,"kind":"parameter","displayName":"Reliable","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.hazelcast.topic.HazelcastTopicConfiguration","configurationField":"configuration","description":"Define if the endpoint will use a reliable Topic struct or not."},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":9,"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."}}} , -{"component":{"kind":"component","name":"http","title":"HTTP","description":"Send requests to external HTTP servers using Apache HTTP Client 5.x.","deprecated":false,"firstVersion":"2.3.0","label":"http","javaType":"org.apache.camel.component.http.HttpComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-http","version":"4.8.1","scheme":"http","extendsScheme":"","alternativeSchemes":"http,https","syntax":"http://httpUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"Content-Encoding":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP content encoding. Is set on both the IN and OUT message to provide a content encoding, such as gzip.","constantName":"org.apache.camel.component.http.HttpConstants#CONTENT_ENCODING"},"CamelHttpResponseCode":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP response code from the external server. Is 200 for OK.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RESPONSE_CODE"},"CamelHttpResponseText":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP response text from the external server.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RESPONSE_TEXT"},"CamelHttpQuery":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URI parameters. Will override existing URI parameters set directly on the endpoint.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_QUERY"},"CamelHttpProtocolVersion":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The version of the http protocol used.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_PROTOCOL_VERSION"},"Host":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The target host.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_HEADER_HOST"},"CamelRestHttpUri":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The rest http URI.","constantName":"org.apache.camel.component.http.HttpConstants#REST_HTTP_URI"},"CamelHttpUri":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URI to call. Will override existing URI set directly on the endpoint. This uri is the uri of the http server to call. Its not the same as the Camel endpoint uri, where you can configure endpoint options such as security etc. This header does not support that, its only the uri of the http server.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_URI"},"CamelHttpPath":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Request URI's path, the header will be used to build the request URI with the HTTP_URI.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_PATH"},"CamelRestHttpQuery":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The rest http query.","constantName":"org.apache.camel.component.http.HttpConstants#REST_HTTP_QUERY"},"CamelHttpRawQuery":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http raw query.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RAW_QUERY"},"CamelHttpMethod":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.http.HttpMethods","enum":["GET","PATCH","POST","PUT","DELETE","HEAD","OPTIONS","TRACE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http method to use.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_METHOD"},"CamelHttpCharacterEncoding":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The character encoding.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_CHARACTER_ENCODING"},"Content-Type":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP content type. Is set on both the IN and OUT message to provide a content type, such as text/html.","constantName":"org.apache.camel.component.http.HttpConstants#CONTENT_TYPE"}},"properties":{"httpUri":{"index":0,"kind":"path","displayName":"Http Uri","group":"common","label":"common","required":true,"type":"string","javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The url of the HTTP endpoint to call."},"disableStreamCache":{"index":1,"kind":"parameter","displayName":"Disable Stream Cache","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The producer (camel-http) will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is (the stream can only be read once) as the message body."},"headerFilterStrategy":{"index":2,"kind":"parameter","displayName":"Header Filter Strategy","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"bridgeEndpoint":{"index":3,"kind":"parameter","displayName":"Bridge Endpoint","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back."},"connectionClose":{"index":4,"kind":"parameter","displayName":"Connection Close","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false."},"httpMethod":{"index":5,"kind":"parameter","displayName":"Http Method","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.http.common.HttpMethods","enum":["GET","POST","PUT","DELETE","HEAD","OPTIONS","TRACE","PATCH"],"deprecated":false,"autowired":false,"secret":false,"description":"Configure the HTTP method to use. The HttpMethod header cannot override this option if set."},"skipRequestHeaders":{"index":6,"kind":"parameter","displayName":"Skip Request Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to skip mapping all the Camel headers as HTTP request headers. If there are no data from Camel headers needed to be included in the HTTP request then this can avoid parsing overhead with many object allocations for the JVM garbage collector."},"skipResponseHeaders":{"index":7,"kind":"parameter","displayName":"Skip Response Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to skip mapping all the HTTP response headers to Camel headers. If there are no data needed from HTTP headers then this can avoid parsing overhead with many object allocations for the JVM garbage collector."},"throwExceptionOnFailure":{"index":8,"kind":"parameter","displayName":"Throw Exception On Failure","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code."},"clearExpiredCookies":{"index":9,"kind":"parameter","displayName":"Clear Expired Cookies","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired. If the component has disabled cookie management then this option is disabled too."},"cookieHandler":{"index":10,"kind":"parameter","displayName":"Cookie Handler","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.http.base.cookie.CookieHandler","deprecated":false,"autowired":false,"secret":false,"description":"Configure a cookie handler to maintain a HTTP session"},"cookieStore":{"index":11,"kind":"parameter","displayName":"Cookie Store","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.cookie.CookieStore","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom CookieStore. By default the BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler."},"copyHeaders":{"index":12,"kind":"parameter","displayName":"Copy Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers)."},"customHostHeader":{"index":13,"kind":"parameter","displayName":"Custom Host Header","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use custom host header for producer. When not set in query will be ignored. When set will override host header derived from url."},"deleteWithBody":{"index":14,"kind":"parameter","displayName":"Delete With Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP body. However in some rare cases users may need to be able to include the message body."},"followRedirects":{"index":15,"kind":"parameter","displayName":"Follow Redirects","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to the HTTP request should follow redirects. By default the HTTP request does not follow redirects"},"getWithBody":{"index":16,"kind":"parameter","displayName":"Get With Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the HTTP GET should include the message body or not. By default HTTP GET do not include any HTTP body. However in some rare cases users may need to be able to include the message body."},"ignoreResponseBody":{"index":17,"kind":"parameter","displayName":"Ignore Response Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If this option is true, The http producer won't read response body and cache the input stream"},"lazyStartProducer":{"index":18,"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."},"okStatusCodeRange":{"index":19,"kind":"parameter","displayName":"Ok Status Code Range","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"200-299","description":"The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included."},"preserveHostHeader":{"index":20,"kind":"parameter","displayName":"Preserve Host Header","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service"},"userAgent":{"index":21,"kind":"parameter","displayName":"User Agent","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To set a custom HTTP User-Agent request header"},"clientBuilder":{"index":22,"kind":"parameter","displayName":"Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.impl.classic.HttpClientBuilder","deprecated":false,"autowired":false,"secret":false,"description":"Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint."},"clientConnectionManager":{"index":23,"kind":"parameter","displayName":"Client Connection Manager","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.io.HttpClientConnectionManager","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpClientConnectionManager to manage connections"},"connectionsPerRoute":{"index":24,"kind":"parameter","displayName":"Connections Per Route","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20,"description":"The maximum number of connections per route."},"httpClient":{"index":25,"kind":"parameter","displayName":"Http Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.classic.HttpClient","deprecated":false,"autowired":false,"secret":false,"description":"Sets a custom HttpClient to be used by the producer"},"httpClientConfigurer":{"index":26,"kind":"parameter","displayName":"Http Client Configurer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.http.HttpClientConfigurer","deprecated":false,"autowired":false,"secret":false,"description":"Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc."},"httpClientOptions":{"index":27,"kind":"parameter","displayName":"Http Client Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"httpClient.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure the HttpClient using the key/values from the Map."},"httpConnectionOptions":{"index":28,"kind":"parameter","displayName":"Http Connection Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"httpConnection.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure the connection and the socket using the key/values from the Map."},"httpContext":{"index":29,"kind":"parameter","displayName":"Http Context","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.core5.http.protocol.HttpContext","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpContext instance"},"maxTotalConnections":{"index":30,"kind":"parameter","displayName":"Max Total Connections","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":200,"description":"The maximum number of connections."},"useSystemProperties":{"index":31,"kind":"parameter","displayName":"Use System Properties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To use System Properties as fallback for configuration"},"proxyAuthDomain":{"index":32,"kind":"parameter","displayName":"Proxy Auth Domain","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication domain to use with NTML"},"proxyAuthHost":{"index":33,"kind":"parameter","displayName":"Proxy Auth Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication host"},"proxyAuthMethod":{"index":34,"kind":"parameter","displayName":"Proxy Auth Method","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","enum":["Basic","Digest","NTLM"],"deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication method to use"},"proxyAuthNtHost":{"index":35,"kind":"parameter","displayName":"Proxy Auth Nt Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication domain (workstation name) to use with NTML"},"proxyAuthPassword":{"index":36,"kind":"parameter","displayName":"Proxy Auth Password","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyAuthPort":{"index":37,"kind":"parameter","displayName":"Proxy Auth Port","group":"proxy","label":"producer,proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication port"},"proxyAuthScheme":{"index":38,"kind":"parameter","displayName":"Proxy Auth Scheme","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","enum":["http","https"],"deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication scheme to use"},"proxyAuthUsername":{"index":39,"kind":"parameter","displayName":"Proxy Auth Username","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Proxy authentication username"},"proxyHost":{"index":40,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy hostname to use"},"proxyPort":{"index":41,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"producer,proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Proxy port to use"},"authDomain":{"index":42,"kind":"parameter","displayName":"Auth Domain","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication domain to use with NTML"},"authenticationPreemptive":{"index":43,"kind":"parameter","displayName":"Authentication Preemptive","group":"security","label":"producer,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If this option is true, camel-http sends preemptive basic authentication to the server."},"authHost":{"index":44,"kind":"parameter","displayName":"Auth Host","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication host to use with NTML"},"authMethod":{"index":45,"kind":"parameter","displayName":"Auth Method","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM."},"authMethodPriority":{"index":46,"kind":"parameter","displayName":"Auth Method Priority","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","enum":["Basic","Digest","NTLM"],"deprecated":false,"autowired":false,"secret":false,"description":"Which authentication method to prioritize to use, either as Basic, Digest or NTLM."},"authPassword":{"index":47,"kind":"parameter","displayName":"Auth Password","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Authentication password"},"authUsername":{"index":48,"kind":"parameter","displayName":"Auth Username","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Authentication username"},"oauth2ClientId":{"index":49,"kind":"parameter","displayName":"Oauth2 Client Id","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"OAuth2 client id"},"oauth2ClientSecret":{"index":50,"kind":"parameter","displayName":"Oauth2 Client Secret","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"OAuth2 client secret"},"oauth2Scope":{"index":51,"kind":"parameter","displayName":"Oauth2 Scope","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OAuth2 scope"},"oauth2TokenEndpoint":{"index":52,"kind":"parameter","displayName":"Oauth2 Token Endpoint","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OAuth2 Token endpoint"},"sslContextParameters":{"index":53,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need."},"x509HostnameVerifier":{"index":54,"kind":"parameter","displayName":"X509 Hostname Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier"}}} +{"component":{"kind":"component","name":"http","title":"HTTP","description":"Send requests to external HTTP servers using Apache HTTP Client 5.x.","deprecated":false,"firstVersion":"2.3.0","label":"http","javaType":"org.apache.camel.component.http.HttpComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-http","version":"4.8.2","scheme":"http","extendsScheme":"","alternativeSchemes":"http,https","syntax":"http://httpUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"Content-Encoding":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP content encoding. Is set on both the IN and OUT message to provide a content encoding, such as gzip.","constantName":"org.apache.camel.component.http.HttpConstants#CONTENT_ENCODING"},"CamelHttpResponseCode":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP response code from the external server. Is 200 for OK.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RESPONSE_CODE"},"CamelHttpResponseText":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP response text from the external server.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RESPONSE_TEXT"},"CamelHttpQuery":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URI parameters. Will override existing URI parameters set directly on the endpoint.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_QUERY"},"CamelHttpProtocolVersion":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The version of the http protocol used.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_PROTOCOL_VERSION"},"Host":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The target host.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_HEADER_HOST"},"CamelRestHttpUri":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The rest http URI.","constantName":"org.apache.camel.component.http.HttpConstants#REST_HTTP_URI"},"CamelHttpUri":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URI to call. Will override existing URI set directly on the endpoint. This uri is the uri of the http server to call. Its not the same as the Camel endpoint uri, where you can configure endpoint options such as security etc. This header does not support that, its only the uri of the http server.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_URI"},"CamelHttpPath":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Request URI's path, the header will be used to build the request URI with the HTTP_URI.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_PATH"},"CamelRestHttpQuery":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The rest http query.","constantName":"org.apache.camel.component.http.HttpConstants#REST_HTTP_QUERY"},"CamelHttpRawQuery":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http raw query.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RAW_QUERY"},"CamelHttpMethod":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.http.HttpMethods","enum":["GET","PATCH","POST","PUT","DELETE","HEAD","OPTIONS","TRACE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http method to use.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_METHOD"},"CamelHttpCharacterEncoding":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The character encoding.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_CHARACTER_ENCODING"},"Content-Type":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP content type. Is set on both the IN and OUT message to provide a content type, such as text/html.","constantName":"org.apache.camel.component.http.HttpConstants#CONTENT_TYPE"}},"properties":{"httpUri":{"index":0,"kind":"path","displayName":"Http Uri","group":"common","label":"common","required":true,"type":"string","javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The url of the HTTP endpoint to call."},"disableStreamCache":{"index":1,"kind":"parameter","displayName":"Disable Stream Cache","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The producer (camel-http) will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is (the stream can only be read once) as the message body."},"headerFilterStrategy":{"index":2,"kind":"parameter","displayName":"Header Filter Strategy","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"bridgeEndpoint":{"index":3,"kind":"parameter","displayName":"Bridge Endpoint","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back."},"connectionClose":{"index":4,"kind":"parameter","displayName":"Connection Close","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false."},"httpMethod":{"index":5,"kind":"parameter","displayName":"Http Method","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.http.common.HttpMethods","enum":["GET","POST","PUT","DELETE","HEAD","OPTIONS","TRACE","PATCH"],"deprecated":false,"autowired":false,"secret":false,"description":"Configure the HTTP method to use. The HttpMethod header cannot override this option if set."},"skipRequestHeaders":{"index":6,"kind":"parameter","displayName":"Skip Request Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to skip mapping all the Camel headers as HTTP request headers. If there are no data from Camel headers needed to be included in the HTTP request then this can avoid parsing overhead with many object allocations for the JVM garbage collector."},"skipResponseHeaders":{"index":7,"kind":"parameter","displayName":"Skip Response Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to skip mapping all the HTTP response headers to Camel headers. If there are no data needed from HTTP headers then this can avoid parsing overhead with many object allocations for the JVM garbage collector."},"throwExceptionOnFailure":{"index":8,"kind":"parameter","displayName":"Throw Exception On Failure","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code."},"clearExpiredCookies":{"index":9,"kind":"parameter","displayName":"Clear Expired Cookies","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired. If the component has disabled cookie management then this option is disabled too."},"cookieHandler":{"index":10,"kind":"parameter","displayName":"Cookie Handler","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.http.base.cookie.CookieHandler","deprecated":false,"autowired":false,"secret":false,"description":"Configure a cookie handler to maintain a HTTP session"},"cookieStore":{"index":11,"kind":"parameter","displayName":"Cookie Store","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.cookie.CookieStore","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom CookieStore. By default the BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler."},"copyHeaders":{"index":12,"kind":"parameter","displayName":"Copy Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers)."},"customHostHeader":{"index":13,"kind":"parameter","displayName":"Custom Host Header","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use custom host header for producer. When not set in query will be ignored. When set will override host header derived from url."},"deleteWithBody":{"index":14,"kind":"parameter","displayName":"Delete With Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP body. However in some rare cases users may need to be able to include the message body."},"followRedirects":{"index":15,"kind":"parameter","displayName":"Follow Redirects","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to the HTTP request should follow redirects. By default the HTTP request does not follow redirects"},"getWithBody":{"index":16,"kind":"parameter","displayName":"Get With Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the HTTP GET should include the message body or not. By default HTTP GET do not include any HTTP body. However in some rare cases users may need to be able to include the message body."},"ignoreResponseBody":{"index":17,"kind":"parameter","displayName":"Ignore Response Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If this option is true, The http producer won't read response body and cache the input stream"},"lazyStartProducer":{"index":18,"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."},"okStatusCodeRange":{"index":19,"kind":"parameter","displayName":"Ok Status Code Range","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"200-299","description":"The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included."},"preserveHostHeader":{"index":20,"kind":"parameter","displayName":"Preserve Host Header","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service"},"userAgent":{"index":21,"kind":"parameter","displayName":"User Agent","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To set a custom HTTP User-Agent request header"},"clientBuilder":{"index":22,"kind":"parameter","displayName":"Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.impl.classic.HttpClientBuilder","deprecated":false,"autowired":false,"secret":false,"description":"Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint."},"clientConnectionManager":{"index":23,"kind":"parameter","displayName":"Client Connection Manager","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.io.HttpClientConnectionManager","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpClientConnectionManager to manage connections"},"connectionsPerRoute":{"index":24,"kind":"parameter","displayName":"Connections Per Route","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20,"description":"The maximum number of connections per route."},"httpClient":{"index":25,"kind":"parameter","displayName":"Http Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.classic.HttpClient","deprecated":false,"autowired":false,"secret":false,"description":"Sets a custom HttpClient to be used by the producer"},"httpClientConfigurer":{"index":26,"kind":"parameter","displayName":"Http Client Configurer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.http.HttpClientConfigurer","deprecated":false,"autowired":false,"secret":false,"description":"Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc."},"httpClientOptions":{"index":27,"kind":"parameter","displayName":"Http Client Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"httpClient.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure the HttpClient using the key/values from the Map."},"httpConnectionOptions":{"index":28,"kind":"parameter","displayName":"Http Connection Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"httpConnection.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure the connection and the socket using the key/values from the Map."},"httpContext":{"index":29,"kind":"parameter","displayName":"Http Context","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.core5.http.protocol.HttpContext","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpContext instance"},"maxTotalConnections":{"index":30,"kind":"parameter","displayName":"Max Total Connections","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":200,"description":"The maximum number of connections."},"useSystemProperties":{"index":31,"kind":"parameter","displayName":"Use System Properties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To use System Properties as fallback for configuration"},"proxyAuthDomain":{"index":32,"kind":"parameter","displayName":"Proxy Auth Domain","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication domain to use with NTML"},"proxyAuthHost":{"index":33,"kind":"parameter","displayName":"Proxy Auth Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication host"},"proxyAuthMethod":{"index":34,"kind":"parameter","displayName":"Proxy Auth Method","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","enum":["Basic","Digest","NTLM"],"deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication method to use"},"proxyAuthNtHost":{"index":35,"kind":"parameter","displayName":"Proxy Auth Nt Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication domain (workstation name) to use with NTML"},"proxyAuthPassword":{"index":36,"kind":"parameter","displayName":"Proxy Auth Password","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyAuthPort":{"index":37,"kind":"parameter","displayName":"Proxy Auth Port","group":"proxy","label":"producer,proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication port"},"proxyAuthScheme":{"index":38,"kind":"parameter","displayName":"Proxy Auth Scheme","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","enum":["http","https"],"deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication scheme to use"},"proxyAuthUsername":{"index":39,"kind":"parameter","displayName":"Proxy Auth Username","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Proxy authentication username"},"proxyHost":{"index":40,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy hostname to use"},"proxyPort":{"index":41,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"producer,proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Proxy port to use"},"authDomain":{"index":42,"kind":"parameter","displayName":"Auth Domain","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication domain to use with NTML"},"authenticationPreemptive":{"index":43,"kind":"parameter","displayName":"Authentication Preemptive","group":"security","label":"producer,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If this option is true, camel-http sends preemptive basic authentication to the server."},"authHost":{"index":44,"kind":"parameter","displayName":"Auth Host","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication host to use with NTML"},"authMethod":{"index":45,"kind":"parameter","displayName":"Auth Method","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM."},"authMethodPriority":{"index":46,"kind":"parameter","displayName":"Auth Method Priority","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","enum":["Basic","Digest","NTLM"],"deprecated":false,"autowired":false,"secret":false,"description":"Which authentication method to prioritize to use, either as Basic, Digest or NTLM."},"authPassword":{"index":47,"kind":"parameter","displayName":"Auth Password","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Authentication password"},"authUsername":{"index":48,"kind":"parameter","displayName":"Auth Username","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Authentication username"},"oauth2ClientId":{"index":49,"kind":"parameter","displayName":"Oauth2 Client Id","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"OAuth2 client id"},"oauth2ClientSecret":{"index":50,"kind":"parameter","displayName":"Oauth2 Client Secret","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"OAuth2 client secret"},"oauth2Scope":{"index":51,"kind":"parameter","displayName":"Oauth2 Scope","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OAuth2 scope"},"oauth2TokenEndpoint":{"index":52,"kind":"parameter","displayName":"Oauth2 Token Endpoint","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OAuth2 Token endpoint"},"sslContextParameters":{"index":53,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need."},"x509HostnameVerifier":{"index":54,"kind":"parameter","displayName":"X509 Hostname Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier"}}} , -{"component":{"kind":"component","name":"https","title":"HTTPS (Secure)","description":"Send requests to external HTTP servers using Apache HTTP Client 5.x.","deprecated":false,"firstVersion":"2.3.0","label":"http","javaType":"org.apache.camel.component.http.HttpComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-http","version":"4.8.1","scheme":"https","extendsScheme":"","alternativeSchemes":"http,https","syntax":"https://httpUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"Content-Encoding":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP content encoding. Is set on both the IN and OUT message to provide a content encoding, such as gzip.","constantName":"org.apache.camel.component.http.HttpConstants#CONTENT_ENCODING"},"CamelHttpResponseCode":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP response code from the external server. Is 200 for OK.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RESPONSE_CODE"},"CamelHttpResponseText":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP response text from the external server.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RESPONSE_TEXT"},"CamelHttpQuery":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URI parameters. Will override existing URI parameters set directly on the endpoint.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_QUERY"},"CamelHttpProtocolVersion":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The version of the http protocol used.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_PROTOCOL_VERSION"},"Host":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The target host.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_HEADER_HOST"},"CamelRestHttpUri":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The rest http URI.","constantName":"org.apache.camel.component.http.HttpConstants#REST_HTTP_URI"},"CamelHttpUri":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URI to call. Will override existing URI set directly on the endpoint. This uri is the uri of the http server to call. Its not the same as the Camel endpoint uri, where you can configure endpoint options such as security etc. This header does not support that, its only the uri of the http server.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_URI"},"CamelHttpPath":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Request URI's path, the header will be used to build the request URI with the HTTP_URI.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_PATH"},"CamelRestHttpQuery":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The rest http query.","constantName":"org.apache.camel.component.http.HttpConstants#REST_HTTP_QUERY"},"CamelHttpRawQuery":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http raw query.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RAW_QUERY"},"CamelHttpMethod":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.http.HttpMethods","enum":["GET","PATCH","POST","PUT","DELETE","HEAD","OPTIONS","TRACE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http method to use.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_METHOD"},"CamelHttpCharacterEncoding":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The character encoding.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_CHARACTER_ENCODING"},"Content-Type":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP content type. Is set on both the IN and OUT message to provide a content type, such as text/html.","constantName":"org.apache.camel.component.http.HttpConstants#CONTENT_TYPE"}},"properties":{"httpUri":{"index":0,"kind":"path","displayName":"Http Uri","group":"common","label":"common","required":true,"type":"string","javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The url of the HTTP endpoint to call."},"disableStreamCache":{"index":1,"kind":"parameter","displayName":"Disable Stream Cache","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The producer (camel-http) will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is (the stream can only be read once) as the message body."},"headerFilterStrategy":{"index":2,"kind":"parameter","displayName":"Header Filter Strategy","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"bridgeEndpoint":{"index":3,"kind":"parameter","displayName":"Bridge Endpoint","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back."},"connectionClose":{"index":4,"kind":"parameter","displayName":"Connection Close","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false."},"httpMethod":{"index":5,"kind":"parameter","displayName":"Http Method","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.http.common.HttpMethods","enum":["GET","POST","PUT","DELETE","HEAD","OPTIONS","TRACE","PATCH"],"deprecated":false,"autowired":false,"secret":false,"description":"Configure the HTTP method to use. The HttpMethod header cannot override this option if set."},"skipRequestHeaders":{"index":6,"kind":"parameter","displayName":"Skip Request Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to skip mapping all the Camel headers as HTTP request headers. If there are no data from Camel headers needed to be included in the HTTP request then this can avoid parsing overhead with many object allocations for the JVM garbage collector."},"skipResponseHeaders":{"index":7,"kind":"parameter","displayName":"Skip Response Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to skip mapping all the HTTP response headers to Camel headers. If there are no data needed from HTTP headers then this can avoid parsing overhead with many object allocations for the JVM garbage collector."},"throwExceptionOnFailure":{"index":8,"kind":"parameter","displayName":"Throw Exception On Failure","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code."},"clearExpiredCookies":{"index":9,"kind":"parameter","displayName":"Clear Expired Cookies","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired. If the component has disabled cookie management then this option is disabled too."},"cookieHandler":{"index":10,"kind":"parameter","displayName":"Cookie Handler","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.http.base.cookie.CookieHandler","deprecated":false,"autowired":false,"secret":false,"description":"Configure a cookie handler to maintain a HTTP session"},"cookieStore":{"index":11,"kind":"parameter","displayName":"Cookie Store","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.cookie.CookieStore","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom CookieStore. By default the BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler."},"copyHeaders":{"index":12,"kind":"parameter","displayName":"Copy Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers)."},"customHostHeader":{"index":13,"kind":"parameter","displayName":"Custom Host Header","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use custom host header for producer. When not set in query will be ignored. When set will override host header derived from url."},"deleteWithBody":{"index":14,"kind":"parameter","displayName":"Delete With Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP body. However in some rare cases users may need to be able to include the message body."},"followRedirects":{"index":15,"kind":"parameter","displayName":"Follow Redirects","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to the HTTP request should follow redirects. By default the HTTP request does not follow redirects"},"getWithBody":{"index":16,"kind":"parameter","displayName":"Get With Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the HTTP GET should include the message body or not. By default HTTP GET do not include any HTTP body. However in some rare cases users may need to be able to include the message body."},"ignoreResponseBody":{"index":17,"kind":"parameter","displayName":"Ignore Response Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If this option is true, The http producer won't read response body and cache the input stream"},"lazyStartProducer":{"index":18,"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."},"okStatusCodeRange":{"index":19,"kind":"parameter","displayName":"Ok Status Code Range","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"200-299","description":"The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included."},"preserveHostHeader":{"index":20,"kind":"parameter","displayName":"Preserve Host Header","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service"},"userAgent":{"index":21,"kind":"parameter","displayName":"User Agent","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To set a custom HTTP User-Agent request header"},"clientBuilder":{"index":22,"kind":"parameter","displayName":"Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.impl.classic.HttpClientBuilder","deprecated":false,"autowired":false,"secret":false,"description":"Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint."},"clientConnectionManager":{"index":23,"kind":"parameter","displayName":"Client Connection Manager","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.io.HttpClientConnectionManager","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpClientConnectionManager to manage connections"},"connectionsPerRoute":{"index":24,"kind":"parameter","displayName":"Connections Per Route","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20,"description":"The maximum number of connections per route."},"httpClient":{"index":25,"kind":"parameter","displayName":"Http Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.classic.HttpClient","deprecated":false,"autowired":false,"secret":false,"description":"Sets a custom HttpClient to be used by the producer"},"httpClientConfigurer":{"index":26,"kind":"parameter","displayName":"Http Client Configurer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.http.HttpClientConfigurer","deprecated":false,"autowired":false,"secret":false,"description":"Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc."},"httpClientOptions":{"index":27,"kind":"parameter","displayName":"Http Client Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"httpClient.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure the HttpClient using the key/values from the Map."},"httpConnectionOptions":{"index":28,"kind":"parameter","displayName":"Http Connection Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"httpConnection.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure the connection and the socket using the key/values from the Map."},"httpContext":{"index":29,"kind":"parameter","displayName":"Http Context","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.core5.http.protocol.HttpContext","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpContext instance"},"maxTotalConnections":{"index":30,"kind":"parameter","displayName":"Max Total Connections","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":200,"description":"The maximum number of connections."},"useSystemProperties":{"index":31,"kind":"parameter","displayName":"Use System Properties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To use System Properties as fallback for configuration"},"proxyAuthDomain":{"index":32,"kind":"parameter","displayName":"Proxy Auth Domain","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication domain to use with NTML"},"proxyAuthHost":{"index":33,"kind":"parameter","displayName":"Proxy Auth Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication host"},"proxyAuthMethod":{"index":34,"kind":"parameter","displayName":"Proxy Auth Method","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","enum":["Basic","Digest","NTLM"],"deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication method to use"},"proxyAuthNtHost":{"index":35,"kind":"parameter","displayName":"Proxy Auth Nt Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication domain (workstation name) to use with NTML"},"proxyAuthPassword":{"index":36,"kind":"parameter","displayName":"Proxy Auth Password","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyAuthPort":{"index":37,"kind":"parameter","displayName":"Proxy Auth Port","group":"proxy","label":"producer,proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication port"},"proxyAuthScheme":{"index":38,"kind":"parameter","displayName":"Proxy Auth Scheme","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","enum":["http","https"],"deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication scheme to use"},"proxyAuthUsername":{"index":39,"kind":"parameter","displayName":"Proxy Auth Username","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Proxy authentication username"},"proxyHost":{"index":40,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy hostname to use"},"proxyPort":{"index":41,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"producer,proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Proxy port to use"},"authDomain":{"index":42,"kind":"parameter","displayName":"Auth Domain","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication domain to use with NTML"},"authenticationPreemptive":{"index":43,"kind":"parameter","displayName":"Authentication Preemptive","group":"security","label":"producer,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If this option is true, camel-http sends preemptive basic authentication to the server."},"authHost":{"index":44,"kind":"parameter","displayName":"Auth Host","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication host to use with NTML"},"authMethod":{"index":45,"kind":"parameter","displayName":"Auth Method","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM."},"authMethodPriority":{"index":46,"kind":"parameter","displayName":"Auth Method Priority","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","enum":["Basic","Digest","NTLM"],"deprecated":false,"autowired":false,"secret":false,"description":"Which authentication method to prioritize to use, either as Basic, Digest or NTLM."},"authPassword":{"index":47,"kind":"parameter","displayName":"Auth Password","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Authentication password"},"authUsername":{"index":48,"kind":"parameter","displayName":"Auth Username","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Authentication username"},"oauth2ClientId":{"index":49,"kind":"parameter","displayName":"Oauth2 Client Id","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"OAuth2 client id"},"oauth2ClientSecret":{"index":50,"kind":"parameter","displayName":"Oauth2 Client Secret","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"OAuth2 client secret"},"oauth2Scope":{"index":51,"kind":"parameter","displayName":"Oauth2 Scope","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OAuth2 scope"},"oauth2TokenEndpoint":{"index":52,"kind":"parameter","displayName":"Oauth2 Token Endpoint","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OAuth2 Token endpoint"},"sslContextParameters":{"index":53,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need."},"x509HostnameVerifier":{"index":54,"kind":"parameter","displayName":"X509 Hostname Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier"}}} +{"component":{"kind":"component","name":"https","title":"HTTPS (Secure)","description":"Send requests to external HTTP servers using Apache HTTP Client 5.x.","deprecated":false,"firstVersion":"2.3.0","label":"http","javaType":"org.apache.camel.component.http.HttpComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-http","version":"4.8.2","scheme":"https","extendsScheme":"","alternativeSchemes":"http,https","syntax":"https://httpUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"Content-Encoding":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP content encoding. Is set on both the IN and OUT message to provide a content encoding, such as gzip.","constantName":"org.apache.camel.component.http.HttpConstants#CONTENT_ENCODING"},"CamelHttpResponseCode":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP response code from the external server. Is 200 for OK.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RESPONSE_CODE"},"CamelHttpResponseText":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP response text from the external server.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RESPONSE_TEXT"},"CamelHttpQuery":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URI parameters. Will override existing URI parameters set directly on the endpoint.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_QUERY"},"CamelHttpProtocolVersion":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The version of the http protocol used.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_PROTOCOL_VERSION"},"Host":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The target host.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_HEADER_HOST"},"CamelRestHttpUri":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The rest http URI.","constantName":"org.apache.camel.component.http.HttpConstants#REST_HTTP_URI"},"CamelHttpUri":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URI to call. Will override existing URI set directly on the endpoint. This uri is the uri of the http server to call. Its not the same as the Camel endpoint uri, where you can configure endpoint options such as security etc. This header does not support that, its only the uri of the http server.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_URI"},"CamelHttpPath":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Request URI's path, the header will be used to build the request URI with the HTTP_URI.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_PATH"},"CamelRestHttpQuery":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The rest http query.","constantName":"org.apache.camel.component.http.HttpConstants#REST_HTTP_QUERY"},"CamelHttpRawQuery":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http raw query.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RAW_QUERY"},"CamelHttpMethod":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.http.HttpMethods","enum":["GET","PATCH","POST","PUT","DELETE","HEAD","OPTIONS","TRACE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http method to use.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_METHOD"},"CamelHttpCharacterEncoding":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The character encoding.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_CHARACTER_ENCODING"},"Content-Type":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP content type. Is set on both the IN and OUT message to provide a content type, such as text/html.","constantName":"org.apache.camel.component.http.HttpConstants#CONTENT_TYPE"}},"properties":{"httpUri":{"index":0,"kind":"path","displayName":"Http Uri","group":"common","label":"common","required":true,"type":"string","javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The url of the HTTP endpoint to call."},"disableStreamCache":{"index":1,"kind":"parameter","displayName":"Disable Stream Cache","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The producer (camel-http) will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is (the stream can only be read once) as the message body."},"headerFilterStrategy":{"index":2,"kind":"parameter","displayName":"Header Filter Strategy","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"bridgeEndpoint":{"index":3,"kind":"parameter","displayName":"Bridge Endpoint","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back."},"connectionClose":{"index":4,"kind":"parameter","displayName":"Connection Close","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false."},"httpMethod":{"index":5,"kind":"parameter","displayName":"Http Method","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.http.common.HttpMethods","enum":["GET","POST","PUT","DELETE","HEAD","OPTIONS","TRACE","PATCH"],"deprecated":false,"autowired":false,"secret":false,"description":"Configure the HTTP method to use. The HttpMethod header cannot override this option if set."},"skipRequestHeaders":{"index":6,"kind":"parameter","displayName":"Skip Request Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to skip mapping all the Camel headers as HTTP request headers. If there are no data from Camel headers needed to be included in the HTTP request then this can avoid parsing overhead with many object allocations for the JVM garbage collector."},"skipResponseHeaders":{"index":7,"kind":"parameter","displayName":"Skip Response Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to skip mapping all the HTTP response headers to Camel headers. If there are no data needed from HTTP headers then this can avoid parsing overhead with many object allocations for the JVM garbage collector."},"throwExceptionOnFailure":{"index":8,"kind":"parameter","displayName":"Throw Exception On Failure","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code."},"clearExpiredCookies":{"index":9,"kind":"parameter","displayName":"Clear Expired Cookies","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired. If the component has disabled cookie management then this option is disabled too."},"cookieHandler":{"index":10,"kind":"parameter","displayName":"Cookie Handler","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.http.base.cookie.CookieHandler","deprecated":false,"autowired":false,"secret":false,"description":"Configure a cookie handler to maintain a HTTP session"},"cookieStore":{"index":11,"kind":"parameter","displayName":"Cookie Store","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.cookie.CookieStore","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom CookieStore. By default the BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler."},"copyHeaders":{"index":12,"kind":"parameter","displayName":"Copy Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers)."},"customHostHeader":{"index":13,"kind":"parameter","displayName":"Custom Host Header","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use custom host header for producer. When not set in query will be ignored. When set will override host header derived from url."},"deleteWithBody":{"index":14,"kind":"parameter","displayName":"Delete With Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP body. However in some rare cases users may need to be able to include the message body."},"followRedirects":{"index":15,"kind":"parameter","displayName":"Follow Redirects","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to the HTTP request should follow redirects. By default the HTTP request does not follow redirects"},"getWithBody":{"index":16,"kind":"parameter","displayName":"Get With Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the HTTP GET should include the message body or not. By default HTTP GET do not include any HTTP body. However in some rare cases users may need to be able to include the message body."},"ignoreResponseBody":{"index":17,"kind":"parameter","displayName":"Ignore Response Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If this option is true, The http producer won't read response body and cache the input stream"},"lazyStartProducer":{"index":18,"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."},"okStatusCodeRange":{"index":19,"kind":"parameter","displayName":"Ok Status Code Range","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"200-299","description":"The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included."},"preserveHostHeader":{"index":20,"kind":"parameter","displayName":"Preserve Host Header","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service"},"userAgent":{"index":21,"kind":"parameter","displayName":"User Agent","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To set a custom HTTP User-Agent request header"},"clientBuilder":{"index":22,"kind":"parameter","displayName":"Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.impl.classic.HttpClientBuilder","deprecated":false,"autowired":false,"secret":false,"description":"Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint."},"clientConnectionManager":{"index":23,"kind":"parameter","displayName":"Client Connection Manager","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.io.HttpClientConnectionManager","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpClientConnectionManager to manage connections"},"connectionsPerRoute":{"index":24,"kind":"parameter","displayName":"Connections Per Route","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20,"description":"The maximum number of connections per route."},"httpClient":{"index":25,"kind":"parameter","displayName":"Http Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.classic.HttpClient","deprecated":false,"autowired":false,"secret":false,"description":"Sets a custom HttpClient to be used by the producer"},"httpClientConfigurer":{"index":26,"kind":"parameter","displayName":"Http Client Configurer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.http.HttpClientConfigurer","deprecated":false,"autowired":false,"secret":false,"description":"Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc."},"httpClientOptions":{"index":27,"kind":"parameter","displayName":"Http Client Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"httpClient.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure the HttpClient using the key/values from the Map."},"httpConnectionOptions":{"index":28,"kind":"parameter","displayName":"Http Connection Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"httpConnection.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure the connection and the socket using the key/values from the Map."},"httpContext":{"index":29,"kind":"parameter","displayName":"Http Context","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.core5.http.protocol.HttpContext","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpContext instance"},"maxTotalConnections":{"index":30,"kind":"parameter","displayName":"Max Total Connections","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":200,"description":"The maximum number of connections."},"useSystemProperties":{"index":31,"kind":"parameter","displayName":"Use System Properties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To use System Properties as fallback for configuration"},"proxyAuthDomain":{"index":32,"kind":"parameter","displayName":"Proxy Auth Domain","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication domain to use with NTML"},"proxyAuthHost":{"index":33,"kind":"parameter","displayName":"Proxy Auth Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication host"},"proxyAuthMethod":{"index":34,"kind":"parameter","displayName":"Proxy Auth Method","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","enum":["Basic","Digest","NTLM"],"deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication method to use"},"proxyAuthNtHost":{"index":35,"kind":"parameter","displayName":"Proxy Auth Nt Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication domain (workstation name) to use with NTML"},"proxyAuthPassword":{"index":36,"kind":"parameter","displayName":"Proxy Auth Password","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyAuthPort":{"index":37,"kind":"parameter","displayName":"Proxy Auth Port","group":"proxy","label":"producer,proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication port"},"proxyAuthScheme":{"index":38,"kind":"parameter","displayName":"Proxy Auth Scheme","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","enum":["http","https"],"deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication scheme to use"},"proxyAuthUsername":{"index":39,"kind":"parameter","displayName":"Proxy Auth Username","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Proxy authentication username"},"proxyHost":{"index":40,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy hostname to use"},"proxyPort":{"index":41,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"producer,proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Proxy port to use"},"authDomain":{"index":42,"kind":"parameter","displayName":"Auth Domain","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication domain to use with NTML"},"authenticationPreemptive":{"index":43,"kind":"parameter","displayName":"Authentication Preemptive","group":"security","label":"producer,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If this option is true, camel-http sends preemptive basic authentication to the server."},"authHost":{"index":44,"kind":"parameter","displayName":"Auth Host","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication host to use with NTML"},"authMethod":{"index":45,"kind":"parameter","displayName":"Auth Method","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM."},"authMethodPriority":{"index":46,"kind":"parameter","displayName":"Auth Method Priority","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","enum":["Basic","Digest","NTLM"],"deprecated":false,"autowired":false,"secret":false,"description":"Which authentication method to prioritize to use, either as Basic, Digest or NTLM."},"authPassword":{"index":47,"kind":"parameter","displayName":"Auth Password","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Authentication password"},"authUsername":{"index":48,"kind":"parameter","displayName":"Auth Username","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Authentication username"},"oauth2ClientId":{"index":49,"kind":"parameter","displayName":"Oauth2 Client Id","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"OAuth2 client id"},"oauth2ClientSecret":{"index":50,"kind":"parameter","displayName":"Oauth2 Client Secret","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"OAuth2 client secret"},"oauth2Scope":{"index":51,"kind":"parameter","displayName":"Oauth2 Scope","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OAuth2 scope"},"oauth2TokenEndpoint":{"index":52,"kind":"parameter","displayName":"Oauth2 Token Endpoint","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OAuth2 Token endpoint"},"sslContextParameters":{"index":53,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need."},"x509HostnameVerifier":{"index":54,"kind":"parameter","displayName":"X509 Hostname Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier"}}} , -{"component":{"kind":"component","name":"hwcloud-dms","title":"Huawei Distributed Message Service (DMS)","description":"To integrate with a fully managed, high-performance message queuing service on Huawei Cloud","deprecated":false,"firstVersion":"3.12.0","label":"cloud","javaType":"org.apache.camel.component.huaweicloud.dms.DMSComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-dms","version":"4.8.1","scheme":"hwcloud-dms","extendsScheme":"","syntax":"hwcloud-dms:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation to be performed"},"accessKey":{"index":1,"kind":"parameter","displayName":"API access key (AK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"accessUser":{"index":2,"kind":"parameter","displayName":"Access user","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The username of a RabbitMQ instance. This option is mandatory when creating a RabbitMQ instance."},"availableZones":{"index":3,"kind":"parameter","displayName":"Available zones","group":"producer","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of an available zone. This option is mandatory when creating an instance and it cannot be an empty array."},"endpoint":{"index":4,"kind":"parameter","displayName":"Service endpoint","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"DMS url. Carries higher precedence than region parameter based client initialization"},"engine":{"index":5,"kind":"parameter","displayName":"Engine type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["kafka","rabbitmq"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message engine. Either kafka or rabbitmq. If the parameter is not specified, all instances will be queried"},"engineVersion":{"index":6,"kind":"parameter","displayName":"Engine version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The version of the message engine. This option is mandatory when creating an instance."},"ignoreSslVerification":{"index":7,"kind":"parameter","displayName":"SSL Verification Ignored","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"},"instanceId":{"index":8,"kind":"parameter","displayName":"Instance id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the instance. This option is mandatory when deleting or querying an instance"},"kafkaManagerPassword":{"index":9,"kind":"parameter","displayName":"Kafka manager password","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password for logging in to the Kafka Manager. This option is mandatory when creating a Kafka instance."},"kafkaManagerUser":{"index":10,"kind":"parameter","displayName":"Kafka manager username","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The username for logging in to the Kafka Manager. This option is mandatory when creating a Kafka instance."},"name":{"index":11,"kind":"parameter","displayName":"Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the instance for creating and updating an instance. This option is mandatory when creating an instance"},"partitionNum":{"index":12,"kind":"parameter","displayName":"Partition Number","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of partitions in a Kafka instance. This option is mandatory when creating a Kafka instance."},"password":{"index":13,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password of a RabbitMQ instance. This option is mandatory when creating a RabbitMQ instance."},"productId":{"index":14,"kind":"parameter","displayName":"Product ID","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The product ID. This option is mandatory when creating an instance."},"projectId":{"index":15,"kind":"parameter","displayName":"Project ID","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cloud project ID"},"proxyHost":{"index":16,"kind":"parameter","displayName":"Proxy server host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"index":17,"kind":"parameter","displayName":"Proxy password","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"index":18,"kind":"parameter","displayName":"Proxy server port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"index":19,"kind":"parameter","displayName":"Proxy user","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"region":{"index":20,"kind":"parameter","displayName":"Service region","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"DMS service region"},"secretKey":{"index":21,"kind":"parameter","displayName":"API secret key (SK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"},"securityGroupId":{"index":22,"kind":"parameter","displayName":"Security group ID","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The security group which the instance belongs to. This option is mandatory when creating an instance."},"serviceKeys":{"index":23,"kind":"parameter","displayName":"Service Configuration","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"},"specification":{"index":24,"kind":"parameter","displayName":"Engine version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The baseline bandwidth of a Kafka instance. This option is mandatory when creating a Kafka instance."},"storageSpace":{"index":25,"kind":"parameter","displayName":"Storage space","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message storage space. This option is mandatory when creating an instance."},"storageSpecCode":{"index":26,"kind":"parameter","displayName":"Storage specification code","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The storage I/O specification. This option is mandatory when creating an instance."},"subnetId":{"index":27,"kind":"parameter","displayName":"Subnet ID","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The subnet ID. This option is mandatory when creating an instance."},"vpcId":{"index":28,"kind":"parameter","displayName":"VPC ID","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The VPC ID. This option is mandatory when creating an instance."},"lazyStartProducer":{"index":29,"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."}}} +{"component":{"kind":"component","name":"hwcloud-dms","title":"Huawei Distributed Message Service (DMS)","description":"To integrate with a fully managed, high-performance message queuing service on Huawei Cloud","deprecated":false,"firstVersion":"3.12.0","label":"cloud","javaType":"org.apache.camel.component.huaweicloud.dms.DMSComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-dms","version":"4.8.2","scheme":"hwcloud-dms","extendsScheme":"","syntax":"hwcloud-dms:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation to be performed"},"accessKey":{"index":1,"kind":"parameter","displayName":"API access key (AK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"accessUser":{"index":2,"kind":"parameter","displayName":"Access user","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The username of a RabbitMQ instance. This option is mandatory when creating a RabbitMQ instance."},"availableZones":{"index":3,"kind":"parameter","displayName":"Available zones","group":"producer","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID of an available zone. This option is mandatory when creating an instance and it cannot be an empty array."},"endpoint":{"index":4,"kind":"parameter","displayName":"Service endpoint","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"DMS url. Carries higher precedence than region parameter based client initialization"},"engine":{"index":5,"kind":"parameter","displayName":"Engine type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["kafka","rabbitmq"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message engine. Either kafka or rabbitmq. If the parameter is not specified, all instances will be queried"},"engineVersion":{"index":6,"kind":"parameter","displayName":"Engine version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The version of the message engine. This option is mandatory when creating an instance."},"ignoreSslVerification":{"index":7,"kind":"parameter","displayName":"SSL Verification Ignored","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"},"instanceId":{"index":8,"kind":"parameter","displayName":"Instance id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the instance. This option is mandatory when deleting or querying an instance"},"kafkaManagerPassword":{"index":9,"kind":"parameter","displayName":"Kafka manager password","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password for logging in to the Kafka Manager. This option is mandatory when creating a Kafka instance."},"kafkaManagerUser":{"index":10,"kind":"parameter","displayName":"Kafka manager username","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The username for logging in to the Kafka Manager. This option is mandatory when creating a Kafka instance."},"name":{"index":11,"kind":"parameter","displayName":"Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the instance for creating and updating an instance. This option is mandatory when creating an instance"},"partitionNum":{"index":12,"kind":"parameter","displayName":"Partition Number","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of partitions in a Kafka instance. This option is mandatory when creating a Kafka instance."},"password":{"index":13,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password of a RabbitMQ instance. This option is mandatory when creating a RabbitMQ instance."},"productId":{"index":14,"kind":"parameter","displayName":"Product ID","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The product ID. This option is mandatory when creating an instance."},"projectId":{"index":15,"kind":"parameter","displayName":"Project ID","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cloud project ID"},"proxyHost":{"index":16,"kind":"parameter","displayName":"Proxy server host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"index":17,"kind":"parameter","displayName":"Proxy password","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"index":18,"kind":"parameter","displayName":"Proxy server port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"index":19,"kind":"parameter","displayName":"Proxy user","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"region":{"index":20,"kind":"parameter","displayName":"Service region","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"DMS service region"},"secretKey":{"index":21,"kind":"parameter","displayName":"API secret key (SK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"},"securityGroupId":{"index":22,"kind":"parameter","displayName":"Security group ID","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The security group which the instance belongs to. This option is mandatory when creating an instance."},"serviceKeys":{"index":23,"kind":"parameter","displayName":"Service Configuration","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"},"specification":{"index":24,"kind":"parameter","displayName":"Engine version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The baseline bandwidth of a Kafka instance. This option is mandatory when creating a Kafka instance."},"storageSpace":{"index":25,"kind":"parameter","displayName":"Storage space","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message storage space. This option is mandatory when creating an instance."},"storageSpecCode":{"index":26,"kind":"parameter","displayName":"Storage specification code","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The storage I/O specification. This option is mandatory when creating an instance."},"subnetId":{"index":27,"kind":"parameter","displayName":"Subnet ID","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The subnet ID. This option is mandatory when creating an instance."},"vpcId":{"index":28,"kind":"parameter","displayName":"VPC ID","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The VPC ID. This option is mandatory when creating an instance."},"lazyStartProducer":{"index":29,"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."}}} , -{"component":{"kind":"component","name":"hwcloud-frs","title":"Huawei Cloud Face Recognition Service (FRS)","description":"Face Recognition Service (FRS) is an intelligent service that uses computers to process, analyze, and understand facial images based on human facial features.","deprecated":false,"firstVersion":"3.15.0","label":"cloud,messaging","javaType":"org.apache.camel.component.huaweicloud.frs.FaceRecognitionComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-frs","version":"4.8.1","scheme":"hwcloud-frs","extendsScheme":"","syntax":"hwcloud-frs:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation name","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of Face Recognition operation to perform, including faceDetection, faceVerification and faceLiveDetection"},"accessKey":{"index":1,"kind":"parameter","displayName":"Account access key (AK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"actions":{"index":2,"kind":"parameter","displayName":"Actions","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param is mandatory when the operation is faceLiveDetection, indicating the action code sequence list. Actions are separated by commas (,). Currently, the following actions are supported: 1: Shake the head to the left. 2: Shake the head to the right. 3: Nod the head. 4: Mouth movement."},"actionTimes":{"index":3,"kind":"parameter","displayName":"Action Time","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when the operation is faceLiveDetection, indicating the action time array. The length of the array is the same as the number of actions. Each item contains the start time and end time of the action in the corresponding sequence. The unit is the milliseconds from the video start time."},"anotherImageBase64":{"index":4,"kind":"parameter","displayName":"Another Image in Base64","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceVerification, indicating the Base64 character string converted from the other image. It needs to be configured if imageBase64 is set. The image size cannot exceed 10 MB. The image resolution of the narrow sides must be greater than 15 pixels, and that of the wide sides cannot exceed 4096 pixels. The supported image formats include JPG, PNG, and BMP."},"anotherImageFilePath":{"index":5,"kind":"parameter","displayName":"Another Image File Path","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceVerification, indicating the local file path of the other image. It needs to be configured if imageFilePath is set. Image size cannot exceed 8 MB, and it is recommended that the image size be less than 1 MB."},"anotherImageUrl":{"index":6,"kind":"parameter","displayName":"Another Image Url","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceVerification, indicating the URL of the other image. It needs to be configured if imageUrl is set. The options are as follows: 1.HTTP/HTTPS URLs on the public network 2.OBS URLs. To use OBS data, authorization is required, including service authorization, temporary authorization, and anonymous public authorization. For details, see Configuring the Access Permission of OBS."},"endpoint":{"index":7,"kind":"parameter","displayName":"Service endpoint","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Fully qualified Face Recognition service url. Carries higher precedence than region based configuration."},"imageBase64":{"index":8,"kind":"parameter","displayName":"Image in Base64","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceDetection or faceVerification, indicating the Base64 character string converted from an image. Any one of imageBase64, imageUrl and imageFilePath needs to be set, and the priority is imageBase64 imageUrl imageFilePath. The Image size cannot exceed 10 MB. The image resolution of the narrow sides must be greater than 15 pixels, and that of the wide sides cannot exceed 4096 pixels. The supported image formats include JPG, PNG, and BMP."},"imageFilePath":{"index":9,"kind":"parameter","displayName":"Image File Path","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceDetection or faceVerification, indicating the local image file path. Any one of imageBase64, imageUrl and imageFilePath needs to be set, and the priority is imageBase64 imageUrl imageFilePath. Image size cannot exceed 8 MB, and it is recommended that the image size be less than 1 MB."},"imageUrl":{"index":10,"kind":"parameter","displayName":"Image Url","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceDetection or faceVerification, indicating the URL of an image. Any one of imageBase64, imageUrl and imageFilePath needs to be set, and the priority is imageBase64 imageUrl imageFilePath. The options are as follows: 1.HTTP/HTTPS URLs on the public network 2.OBS URLs. To use OBS data, authorization is required, including service authorization, temporary authorization, and anonymous public authorization. For details, see Configuring the Access Permission of OBS."},"projectId":{"index":11,"kind":"parameter","displayName":"Project ID","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cloud project ID"},"proxyHost":{"index":12,"kind":"parameter","displayName":"Proxy server host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"index":13,"kind":"parameter","displayName":"Proxy password","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"index":14,"kind":"parameter","displayName":"Proxy server port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"index":15,"kind":"parameter","displayName":"Proxy user","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"region":{"index":16,"kind":"parameter","displayName":"Service region","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Face Recognition service region. Currently only cn-north-1 and cn-north-4 are supported. This is lower precedence than endpoint based configuration."},"secretKey":{"index":17,"kind":"parameter","displayName":"Account secret key (SK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"},"serviceKeys":{"index":18,"kind":"parameter","displayName":"Service Configuration","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"},"videoBase64":{"index":19,"kind":"parameter","displayName":"Video in Base64","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceLiveDetection, indicating the Base64 character string converted from a video. Any one of videoBase64, videoUrl and videoFilePath needs to be set, and the priority is videoBase64 videoUrl videoFilePath. Requirements are as follows: 1.The video size after Base64 encoding cannot exceed 8 MB. It is recommended that the video file be compressed to 200 KB to 2 MB on the client. 2.The video duration must be 1 to 15 seconds. 3.The recommended frame rate is 10 fps to 30 fps. 4.The encapsulation format can be MP4, AVI, FLV, WEBM, ASF, or MOV. 5.The video encoding format can be H.261, H.263, H.264, HEVC, VC-1, VP8, VP9, or WMV3."},"videoFilePath":{"index":20,"kind":"parameter","displayName":"Video File Path","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceLiveDetection, indicating the local video file path. Any one of videoBase64, videoUrl and videoFilePath needs to be set, and the priority is videoBase64 videoUrl videoFilePath. The video requirements are as follows: 1.The size of a video file cannot exceed 8 MB. It is recommended that the video file be compressed to 200 KB to 2 MB on the client. 2.The video duration must be 1 to 15 seconds. 3.The recommended frame rate is 10 fps to 30 fps. 4.The encapsulation format can be MP4, AVI, FLV, WEBM, ASF, or MOV. 5.The video encoding format can be H.261, H.263, H.264, HEVC, VC-1, VP8, VP9, or WMV3."},"videoUrl":{"index":21,"kind":"parameter","displayName":"Video Url","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceLiveDetection, indicating the URL of a video. Any one of videoBase64, videoUrl and videoFilePath needs to be set, and the priority is videoBase64 videoUrl videoFilePath. Currently, only the URL of an OBS bucket on HUAWEI CLOUD is supported and FRS must have the permission to read data in the OBS bucket. For details about how to enable the read permission, see Service Authorization. The video requirements are as follows: 1.The video size after Base64 encoding cannot exceed 8 MB. 2.The video duration must be 1 to 15 seconds. 3.The recommended frame rate is 10 fps to 30 fps. 4.The encapsulation format can be MP4, AVI, FLV, WEBM, ASF, or MOV. 5.The video encoding format can be H.261, H.263, H.264, HEVC, VC-1, VP8, VP9, or WMV3."},"lazyStartProducer":{"index":22,"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."},"ignoreSslVerification":{"index":23,"kind":"parameter","displayName":"SSL Verification Ignored","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"}}} +{"component":{"kind":"component","name":"hwcloud-frs","title":"Huawei Cloud Face Recognition Service (FRS)","description":"Face Recognition Service (FRS) is an intelligent service that uses computers to process, analyze, and understand facial images based on human facial features.","deprecated":false,"firstVersion":"3.15.0","label":"cloud,messaging","javaType":"org.apache.camel.component.huaweicloud.frs.FaceRecognitionComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-frs","version":"4.8.2","scheme":"hwcloud-frs","extendsScheme":"","syntax":"hwcloud-frs:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation name","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of Face Recognition operation to perform, including faceDetection, faceVerification and faceLiveDetection"},"accessKey":{"index":1,"kind":"parameter","displayName":"Account access key (AK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"actions":{"index":2,"kind":"parameter","displayName":"Actions","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param is mandatory when the operation is faceLiveDetection, indicating the action code sequence list. Actions are separated by commas (,). Currently, the following actions are supported: 1: Shake the head to the left. 2: Shake the head to the right. 3: Nod the head. 4: Mouth movement."},"actionTimes":{"index":3,"kind":"parameter","displayName":"Action Time","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when the operation is faceLiveDetection, indicating the action time array. The length of the array is the same as the number of actions. Each item contains the start time and end time of the action in the corresponding sequence. The unit is the milliseconds from the video start time."},"anotherImageBase64":{"index":4,"kind":"parameter","displayName":"Another Image in Base64","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceVerification, indicating the Base64 character string converted from the other image. It needs to be configured if imageBase64 is set. The image size cannot exceed 10 MB. The image resolution of the narrow sides must be greater than 15 pixels, and that of the wide sides cannot exceed 4096 pixels. The supported image formats include JPG, PNG, and BMP."},"anotherImageFilePath":{"index":5,"kind":"parameter","displayName":"Another Image File Path","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceVerification, indicating the local file path of the other image. It needs to be configured if imageFilePath is set. Image size cannot exceed 8 MB, and it is recommended that the image size be less than 1 MB."},"anotherImageUrl":{"index":6,"kind":"parameter","displayName":"Another Image Url","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceVerification, indicating the URL of the other image. It needs to be configured if imageUrl is set. The options are as follows: 1.HTTP/HTTPS URLs on the public network 2.OBS URLs. To use OBS data, authorization is required, including service authorization, temporary authorization, and anonymous public authorization. For details, see Configuring the Access Permission of OBS."},"endpoint":{"index":7,"kind":"parameter","displayName":"Service endpoint","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Fully qualified Face Recognition service url. Carries higher precedence than region based configuration."},"imageBase64":{"index":8,"kind":"parameter","displayName":"Image in Base64","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceDetection or faceVerification, indicating the Base64 character string converted from an image. Any one of imageBase64, imageUrl and imageFilePath needs to be set, and the priority is imageBase64 imageUrl imageFilePath. The Image size cannot exceed 10 MB. The image resolution of the narrow sides must be greater than 15 pixels, and that of the wide sides cannot exceed 4096 pixels. The supported image formats include JPG, PNG, and BMP."},"imageFilePath":{"index":9,"kind":"parameter","displayName":"Image File Path","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceDetection or faceVerification, indicating the local image file path. Any one of imageBase64, imageUrl and imageFilePath needs to be set, and the priority is imageBase64 imageUrl imageFilePath. Image size cannot exceed 8 MB, and it is recommended that the image size be less than 1 MB."},"imageUrl":{"index":10,"kind":"parameter","displayName":"Image Url","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceDetection or faceVerification, indicating the URL of an image. Any one of imageBase64, imageUrl and imageFilePath needs to be set, and the priority is imageBase64 imageUrl imageFilePath. The options are as follows: 1.HTTP/HTTPS URLs on the public network 2.OBS URLs. To use OBS data, authorization is required, including service authorization, temporary authorization, and anonymous public authorization. For details, see Configuring the Access Permission of OBS."},"projectId":{"index":11,"kind":"parameter","displayName":"Project ID","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cloud project ID"},"proxyHost":{"index":12,"kind":"parameter","displayName":"Proxy server host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"index":13,"kind":"parameter","displayName":"Proxy password","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"index":14,"kind":"parameter","displayName":"Proxy server port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"index":15,"kind":"parameter","displayName":"Proxy user","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"region":{"index":16,"kind":"parameter","displayName":"Service region","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Face Recognition service region. Currently only cn-north-1 and cn-north-4 are supported. This is lower precedence than endpoint based configuration."},"secretKey":{"index":17,"kind":"parameter","displayName":"Account secret key (SK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"},"serviceKeys":{"index":18,"kind":"parameter","displayName":"Service Configuration","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"},"videoBase64":{"index":19,"kind":"parameter","displayName":"Video in Base64","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceLiveDetection, indicating the Base64 character string converted from a video. Any one of videoBase64, videoUrl and videoFilePath needs to be set, and the priority is videoBase64 videoUrl videoFilePath. Requirements are as follows: 1.The video size after Base64 encoding cannot exceed 8 MB. It is recommended that the video file be compressed to 200 KB to 2 MB on the client. 2.The video duration must be 1 to 15 seconds. 3.The recommended frame rate is 10 fps to 30 fps. 4.The encapsulation format can be MP4, AVI, FLV, WEBM, ASF, or MOV. 5.The video encoding format can be H.261, H.263, H.264, HEVC, VC-1, VP8, VP9, or WMV3."},"videoFilePath":{"index":20,"kind":"parameter","displayName":"Video File Path","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceLiveDetection, indicating the local video file path. Any one of videoBase64, videoUrl and videoFilePath needs to be set, and the priority is videoBase64 videoUrl videoFilePath. The video requirements are as follows: 1.The size of a video file cannot exceed 8 MB. It is recommended that the video file be compressed to 200 KB to 2 MB on the client. 2.The video duration must be 1 to 15 seconds. 3.The recommended frame rate is 10 fps to 30 fps. 4.The encapsulation format can be MP4, AVI, FLV, WEBM, ASF, or MOV. 5.The video encoding format can be H.261, H.263, H.264, HEVC, VC-1, VP8, VP9, or WMV3."},"videoUrl":{"index":21,"kind":"parameter","displayName":"Video Url","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This param can be used when operation is faceLiveDetection, indicating the URL of a video. Any one of videoBase64, videoUrl and videoFilePath needs to be set, and the priority is videoBase64 videoUrl videoFilePath. Currently, only the URL of an OBS bucket on HUAWEI CLOUD is supported and FRS must have the permission to read data in the OBS bucket. For details about how to enable the read permission, see Service Authorization. The video requirements are as follows: 1.The video size after Base64 encoding cannot exceed 8 MB. 2.The video duration must be 1 to 15 seconds. 3.The recommended frame rate is 10 fps to 30 fps. 4.The encapsulation format can be MP4, AVI, FLV, WEBM, ASF, or MOV. 5.The video encoding format can be H.261, H.263, H.264, HEVC, VC-1, VP8, VP9, or WMV3."},"lazyStartProducer":{"index":22,"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."},"ignoreSslVerification":{"index":23,"kind":"parameter","displayName":"SSL Verification Ignored","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"}}} , -{"component":{"kind":"component","name":"hwcloud-functiongraph","title":"Huawei FunctionGraph","description":"To call serverless functions on Huawei Cloud","deprecated":false,"firstVersion":"3.11.0","label":"cloud,serverless","javaType":"org.apache.camel.FunctionGraphComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-functiongraph","version":"4.8.1","scheme":"hwcloud-functiongraph","extendsScheme":"","syntax":"hwcloud-functiongraph:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation to be performed"},"endpoint":{"index":1,"kind":"parameter","displayName":"Service endpoint","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"FunctionGraph url. Carries higher precedence than region parameter based client initialization"},"functionName":{"index":2,"kind":"parameter","displayName":"Function name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the function to invoke"},"functionPackage":{"index":3,"kind":"parameter","displayName":"Function package","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"default","description":"Functions that can be logically grouped together"},"projectId":{"index":4,"kind":"parameter","displayName":"Project ID","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cloud project ID"},"region":{"index":5,"kind":"parameter","displayName":"Service region","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"FunctionGraph service region. This is lower precedence than endpoint based configuration"},"serviceKeys":{"index":6,"kind":"parameter","displayName":"Service Configuration","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"},"lazyStartProducer":{"index":7,"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."},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy server host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"index":9,"kind":"parameter","displayName":"Proxy password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"index":10,"kind":"parameter","displayName":"Proxy server port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"index":11,"kind":"parameter","displayName":"Proxy user","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"accessKey":{"index":12,"kind":"parameter","displayName":"API access key (AK)","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"ignoreSslVerification":{"index":13,"kind":"parameter","displayName":"SSL Verification Ignored","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"},"secretKey":{"index":14,"kind":"parameter","displayName":"API secret key (SK)","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"}}} +{"component":{"kind":"component","name":"hwcloud-functiongraph","title":"Huawei FunctionGraph","description":"To call serverless functions on Huawei Cloud","deprecated":false,"firstVersion":"3.11.0","label":"cloud,serverless","javaType":"org.apache.camel.FunctionGraphComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-functiongraph","version":"4.8.2","scheme":"hwcloud-functiongraph","extendsScheme":"","syntax":"hwcloud-functiongraph:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation to be performed"},"endpoint":{"index":1,"kind":"parameter","displayName":"Service endpoint","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"FunctionGraph url. Carries higher precedence than region parameter based client initialization"},"functionName":{"index":2,"kind":"parameter","displayName":"Function name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the function to invoke"},"functionPackage":{"index":3,"kind":"parameter","displayName":"Function package","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"default","description":"Functions that can be logically grouped together"},"projectId":{"index":4,"kind":"parameter","displayName":"Project ID","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cloud project ID"},"region":{"index":5,"kind":"parameter","displayName":"Service region","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"FunctionGraph service region. This is lower precedence than endpoint based configuration"},"serviceKeys":{"index":6,"kind":"parameter","displayName":"Service Configuration","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"},"lazyStartProducer":{"index":7,"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."},"proxyHost":{"index":8,"kind":"parameter","displayName":"Proxy server host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"index":9,"kind":"parameter","displayName":"Proxy password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"index":10,"kind":"parameter","displayName":"Proxy server port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"index":11,"kind":"parameter","displayName":"Proxy user","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"accessKey":{"index":12,"kind":"parameter","displayName":"API access key (AK)","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"ignoreSslVerification":{"index":13,"kind":"parameter","displayName":"SSL Verification Ignored","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"},"secretKey":{"index":14,"kind":"parameter","displayName":"API secret key (SK)","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"}}} , -{"component":{"kind":"component","name":"hwcloud-iam","title":"Huawei Identity and Access Management (IAM)","description":"To securely manage users on Huawei Cloud","deprecated":false,"firstVersion":"3.11.0","label":"cloud","javaType":"org.apache.camel.component.huaweicloud.iam.IAMComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-iam","version":"4.8.1","scheme":"hwcloud-iam","extendsScheme":"","syntax":"hwcloud-iam:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation to be performed"},"accessKey":{"index":1,"kind":"parameter","displayName":"API access key (AK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"groupId":{"index":2,"kind":"parameter","displayName":"Group ID","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Group ID to perform operation with"},"ignoreSslVerification":{"index":3,"kind":"parameter","displayName":"SSL Verification Ignored","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"},"proxyHost":{"index":4,"kind":"parameter","displayName":"Proxy server host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"index":5,"kind":"parameter","displayName":"Proxy password","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"index":6,"kind":"parameter","displayName":"Proxy server port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"index":7,"kind":"parameter","displayName":"Proxy user","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"region":{"index":8,"kind":"parameter","displayName":"Service region","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"IAM service region"},"secretKey":{"index":9,"kind":"parameter","displayName":"API secret key (SK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"},"serviceKeys":{"index":10,"kind":"parameter","displayName":"Service Configuration","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"},"userId":{"index":11,"kind":"parameter","displayName":"User ID","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"User ID to perform operation with"},"lazyStartProducer":{"index":12,"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."}}} +{"component":{"kind":"component","name":"hwcloud-iam","title":"Huawei Identity and Access Management (IAM)","description":"To securely manage users on Huawei Cloud","deprecated":false,"firstVersion":"3.11.0","label":"cloud","javaType":"org.apache.camel.component.huaweicloud.iam.IAMComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-iam","version":"4.8.2","scheme":"hwcloud-iam","extendsScheme":"","syntax":"hwcloud-iam:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation to be performed"},"accessKey":{"index":1,"kind":"parameter","displayName":"API access key (AK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"groupId":{"index":2,"kind":"parameter","displayName":"Group ID","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Group ID to perform operation with"},"ignoreSslVerification":{"index":3,"kind":"parameter","displayName":"SSL Verification Ignored","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"},"proxyHost":{"index":4,"kind":"parameter","displayName":"Proxy server host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"index":5,"kind":"parameter","displayName":"Proxy password","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"index":6,"kind":"parameter","displayName":"Proxy server port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"index":7,"kind":"parameter","displayName":"Proxy user","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"region":{"index":8,"kind":"parameter","displayName":"Service region","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"IAM service region"},"secretKey":{"index":9,"kind":"parameter","displayName":"API secret key (SK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"},"serviceKeys":{"index":10,"kind":"parameter","displayName":"Service Configuration","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"},"userId":{"index":11,"kind":"parameter","displayName":"User ID","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"User ID to perform operation with"},"lazyStartProducer":{"index":12,"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."}}} , -{"component":{"kind":"component","name":"hwcloud-imagerecognition","title":"Huawei Cloud Image Recognition","description":"To identify objects, scenes, and concepts in images on Huawei Cloud","deprecated":false,"firstVersion":"3.12.0","label":"cloud,messaging","javaType":"org.apache.camel.component.huaweicloud.image.ImageRecognitionComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-imagerecognition","version":"4.8.1","scheme":"hwcloud-imagerecognition","extendsScheme":"","syntax":"hwcloud-imagerecognition:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation name","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of Image Recognition operation to perform, including celebrityRecognition and tagRecognition"},"accessKey":{"index":1,"kind":"parameter","displayName":"Account access key (AK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"endpoint":{"index":2,"kind":"parameter","displayName":"Service endpoint","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Fully qualified Image Recognition service url. Carries higher precedence than region based configuration."},"imageContent":{"index":3,"kind":"parameter","displayName":"Image in Base64","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates the Base64 character string converted from the image. The size cannot exceed 10 MB. The image resolution of the narrow sides must be greater than 15 pixels, and that of the wide sides cannot exceed 4096 pixels.The supported image formats include JPG, PNG, and BMP. Configure either this parameter or imageUrl, and this one carries higher precedence than imageUrl."},"imageUrl":{"index":4,"kind":"parameter","displayName":"Image Url","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates the URL of an image. The options are as follows: HTTP/HTTPS URLs on the public network OBS URLs. To use OBS data, authorization is required, including service authorization, temporary authorization, and anonymous public authorization. For details, see Configuring the Access Permission of OBS. Configure either this parameter or imageContent, and this one carries lower precedence than imageContent."},"projectId":{"index":5,"kind":"parameter","displayName":"Project ID","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cloud project ID"},"proxyHost":{"index":6,"kind":"parameter","displayName":"Proxy server host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"index":7,"kind":"parameter","displayName":"Proxy password","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"index":8,"kind":"parameter","displayName":"Proxy server port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"index":9,"kind":"parameter","displayName":"Proxy user","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"region":{"index":10,"kind":"parameter","displayName":"Service region","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Image Recognition service region. Currently only cn-north-1 and cn-north-4 are supported. This is lower precedence than endpoint based configuration."},"secretKey":{"index":11,"kind":"parameter","displayName":"Account secret key (SK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"},"serviceKeys":{"index":12,"kind":"parameter","displayName":"Service Configuration","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"},"tagLanguage":{"index":13,"kind":"parameter","displayName":"Tag Language","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"zh","description":"Indicates the language of the returned tags when the operation is tagRecognition, including zh and en."},"tagLimit":{"index":14,"kind":"parameter","displayName":"Tag Limit","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":50,"description":"Indicates the maximum number of the returned tags when the operation is tagRecognition."},"threshold":{"index":15,"kind":"parameter","displayName":"Threshold of confidence","group":"producer","label":"","required":false,"type":"number","javaType":"float","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates the threshold of confidence. When the operation is tagRecognition, this parameter ranges from 0 to 100. Tags whose confidence score is lower than the threshold will not be returned. The default value is 60. When the operation is celebrityRecognition, this parameter ranges from 0 to 1. Labels whose confidence score is lower than the threshold will not be returned. The default value is 0.48."},"lazyStartProducer":{"index":16,"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."},"ignoreSslVerification":{"index":17,"kind":"parameter","displayName":"SSL Verification Ignored","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"}}} +{"component":{"kind":"component","name":"hwcloud-imagerecognition","title":"Huawei Cloud Image Recognition","description":"To identify objects, scenes, and concepts in images on Huawei Cloud","deprecated":false,"firstVersion":"3.12.0","label":"cloud,messaging","javaType":"org.apache.camel.component.huaweicloud.image.ImageRecognitionComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-imagerecognition","version":"4.8.2","scheme":"hwcloud-imagerecognition","extendsScheme":"","syntax":"hwcloud-imagerecognition:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation name","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of Image Recognition operation to perform, including celebrityRecognition and tagRecognition"},"accessKey":{"index":1,"kind":"parameter","displayName":"Account access key (AK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"endpoint":{"index":2,"kind":"parameter","displayName":"Service endpoint","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Fully qualified Image Recognition service url. Carries higher precedence than region based configuration."},"imageContent":{"index":3,"kind":"parameter","displayName":"Image in Base64","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates the Base64 character string converted from the image. The size cannot exceed 10 MB. The image resolution of the narrow sides must be greater than 15 pixels, and that of the wide sides cannot exceed 4096 pixels.The supported image formats include JPG, PNG, and BMP. Configure either this parameter or imageUrl, and this one carries higher precedence than imageUrl."},"imageUrl":{"index":4,"kind":"parameter","displayName":"Image Url","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates the URL of an image. The options are as follows: HTTP/HTTPS URLs on the public network OBS URLs. To use OBS data, authorization is required, including service authorization, temporary authorization, and anonymous public authorization. For details, see Configuring the Access Permission of OBS. Configure either this parameter or imageContent, and this one carries lower precedence than imageContent."},"projectId":{"index":5,"kind":"parameter","displayName":"Project ID","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cloud project ID"},"proxyHost":{"index":6,"kind":"parameter","displayName":"Proxy server host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"index":7,"kind":"parameter","displayName":"Proxy password","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"index":8,"kind":"parameter","displayName":"Proxy server port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"index":9,"kind":"parameter","displayName":"Proxy user","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"region":{"index":10,"kind":"parameter","displayName":"Service region","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Image Recognition service region. Currently only cn-north-1 and cn-north-4 are supported. This is lower precedence than endpoint based configuration."},"secretKey":{"index":11,"kind":"parameter","displayName":"Account secret key (SK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"},"serviceKeys":{"index":12,"kind":"parameter","displayName":"Service Configuration","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"},"tagLanguage":{"index":13,"kind":"parameter","displayName":"Tag Language","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"zh","description":"Indicates the language of the returned tags when the operation is tagRecognition, including zh and en."},"tagLimit":{"index":14,"kind":"parameter","displayName":"Tag Limit","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":50,"description":"Indicates the maximum number of the returned tags when the operation is tagRecognition."},"threshold":{"index":15,"kind":"parameter","displayName":"Threshold of confidence","group":"producer","label":"","required":false,"type":"number","javaType":"float","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates the threshold of confidence. When the operation is tagRecognition, this parameter ranges from 0 to 100. Tags whose confidence score is lower than the threshold will not be returned. The default value is 60. When the operation is celebrityRecognition, this parameter ranges from 0 to 1. Labels whose confidence score is lower than the threshold will not be returned. The default value is 0.48."},"lazyStartProducer":{"index":16,"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."},"ignoreSslVerification":{"index":17,"kind":"parameter","displayName":"SSL Verification Ignored","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"}}} , -{"component":{"kind":"component","name":"hwcloud-obs","title":"Huawei Object Storage Service (OBS)","description":"To provide stable, secure, efficient, and easy-to-use cloud storage service on Huawei Cloud","deprecated":false,"firstVersion":"3.12.0","label":"cloud","javaType":"org.apache.camel.component.huaweicloud.obs.OBSComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-obs","version":"4.8.1","scheme":"hwcloud-obs","extendsScheme":"","syntax":"hwcloud-obs:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHwCloudObsBucketName":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the bucket where object is contained","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#BUCKET_NAME"},"CamelHwCloudObsObjectKey":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key that the object is stored under","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#OBJECT_KEY"},"CamelHwCloudObsLastModified":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The date and time that the object was last modified","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#LAST_MODIFIED"},"CamelHwCloudObsETag":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The 128-bit MD5 digest of the Base64 code of the object. This data is the unique identifier of the object content","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#ETAG"},"CamelHwCloudObsContentMD5":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The 128-bit Base64-encoded digest used to decrypt the object","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#CONTENT_MD5"},"CamelHwCloudObsObjectType":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Shows whether the object is a file or a folder","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#OBJECT_TYPE"},"Content-Length":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the object body in bytes","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#CONTENT_LENGTH"},"Content-Type":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of content stored in the object","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#CONTENT_TYPE"},"CamelFileName":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the object with which the operation is to be performed","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#FILE_NAME"}},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation to be performed"},"bucketName":{"index":1,"kind":"parameter","displayName":"Bucket Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of bucket to perform operation on"},"endpoint":{"index":2,"kind":"parameter","displayName":"Endpoint url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OBS url. Carries higher precedence than region parameter based client initialization"},"objectName":{"index":3,"kind":"parameter","displayName":"Object Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of object to perform operation with"},"region":{"index":4,"kind":"parameter","displayName":"Service region","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OBS service region. This is lower precedence than endpoint based configuration"},"deleteAfterRead":{"index":5,"kind":"parameter","displayName":"Delete after read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Determines if objects should be deleted after it has been retrieved"},"delimiter":{"index":6,"kind":"parameter","displayName":"Delimiter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The character used for grouping object names"},"destinationBucket":{"index":7,"kind":"parameter","displayName":"Destination Bucket","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of destination bucket where objects will be moved when moveAfterRead is set to true"},"fileName":{"index":8,"kind":"parameter","displayName":"File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Get the object from the bucket with the given file name"},"includeFolders":{"index":9,"kind":"parameter","displayName":"Include Folders","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"description":"If true, objects in folders will be consumed. Otherwise, they will be ignored and no Exchanges will be created for them"},"maxMessagesPerPoll":{"index":10,"kind":"parameter","displayName":"Maximum messages per poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":10,"description":"The maximum number of messages to poll at each polling"},"moveAfterRead":{"index":11,"kind":"parameter","displayName":"Move After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Determines whether objects should be moved to a different bucket after they have been retrieved. The destinationBucket option must also be set for this option to work."},"prefix":{"index":12,"kind":"parameter","displayName":"Prefix","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object name prefix used for filtering objects to be listed"},"sendEmptyMessageWhenIdle":{"index":13,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":17,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"bucketLocation":{"index":18,"kind":"parameter","displayName":"Bucket Location","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Location of bucket when creating a new bucket"},"lazyStartProducer":{"index":19,"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."},"proxyHost":{"index":20,"kind":"parameter","displayName":"Proxy server host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"index":21,"kind":"parameter","displayName":"Proxy password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"index":22,"kind":"parameter","displayName":"Proxy server port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"index":23,"kind":"parameter","displayName":"Proxy user","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"backoffErrorThreshold":{"index":24,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":25,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":26,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":27,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":28,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":29,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":30,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":31,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":32,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":33,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":34,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":35,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":36,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":37,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":38,"kind":"parameter","displayName":"API access key (AK)","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"ignoreSslVerification":{"index":39,"kind":"parameter","displayName":"SSL Verification Ignored","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"},"secretKey":{"index":40,"kind":"parameter","displayName":"API secret key (SK)","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"},"serviceKeys":{"index":41,"kind":"parameter","displayName":"Service Configuration","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"}}} +{"component":{"kind":"component","name":"hwcloud-obs","title":"Huawei Object Storage Service (OBS)","description":"To provide stable, secure, efficient, and easy-to-use cloud storage service on Huawei Cloud","deprecated":false,"firstVersion":"3.12.0","label":"cloud","javaType":"org.apache.camel.component.huaweicloud.obs.OBSComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-obs","version":"4.8.2","scheme":"hwcloud-obs","extendsScheme":"","syntax":"hwcloud-obs:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelHwCloudObsBucketName":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the bucket where object is contained","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#BUCKET_NAME"},"CamelHwCloudObsObjectKey":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key that the object is stored under","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#OBJECT_KEY"},"CamelHwCloudObsLastModified":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The date and time that the object was last modified","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#LAST_MODIFIED"},"CamelHwCloudObsETag":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The 128-bit MD5 digest of the Base64 code of the object. This data is the unique identifier of the object content","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#ETAG"},"CamelHwCloudObsContentMD5":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The 128-bit Base64-encoded digest used to decrypt the object","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#CONTENT_MD5"},"CamelHwCloudObsObjectType":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Shows whether the object is a file or a folder","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#OBJECT_TYPE"},"Content-Length":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the object body in bytes","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#CONTENT_LENGTH"},"Content-Type":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of content stored in the object","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#CONTENT_TYPE"},"CamelFileName":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the object with which the operation is to be performed","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#FILE_NAME"}},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation to be performed"},"bucketName":{"index":1,"kind":"parameter","displayName":"Bucket Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of bucket to perform operation on"},"endpoint":{"index":2,"kind":"parameter","displayName":"Endpoint url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OBS url. Carries higher precedence than region parameter based client initialization"},"objectName":{"index":3,"kind":"parameter","displayName":"Object Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of object to perform operation with"},"region":{"index":4,"kind":"parameter","displayName":"Service region","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OBS service region. This is lower precedence than endpoint based configuration"},"deleteAfterRead":{"index":5,"kind":"parameter","displayName":"Delete after read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Determines if objects should be deleted after it has been retrieved"},"delimiter":{"index":6,"kind":"parameter","displayName":"Delimiter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The character used for grouping object names"},"destinationBucket":{"index":7,"kind":"parameter","displayName":"Destination Bucket","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of destination bucket where objects will be moved when moveAfterRead is set to true"},"fileName":{"index":8,"kind":"parameter","displayName":"File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Get the object from the bucket with the given file name"},"includeFolders":{"index":9,"kind":"parameter","displayName":"Include Folders","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"description":"If true, objects in folders will be consumed. Otherwise, they will be ignored and no Exchanges will be created for them"},"maxMessagesPerPoll":{"index":10,"kind":"parameter","displayName":"Maximum messages per poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":10,"description":"The maximum number of messages to poll at each polling"},"moveAfterRead":{"index":11,"kind":"parameter","displayName":"Move After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Determines whether objects should be moved to a different bucket after they have been retrieved. The destinationBucket option must also be set for this option to work."},"prefix":{"index":12,"kind":"parameter","displayName":"Prefix","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object name prefix used for filtering objects to be listed"},"sendEmptyMessageWhenIdle":{"index":13,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":17,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"bucketLocation":{"index":18,"kind":"parameter","displayName":"Bucket Location","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Location of bucket when creating a new bucket"},"lazyStartProducer":{"index":19,"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."},"proxyHost":{"index":20,"kind":"parameter","displayName":"Proxy server host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"index":21,"kind":"parameter","displayName":"Proxy password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"index":22,"kind":"parameter","displayName":"Proxy server port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"index":23,"kind":"parameter","displayName":"Proxy user","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"backoffErrorThreshold":{"index":24,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":25,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":26,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":27,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":28,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":29,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":30,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":31,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":32,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":33,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":34,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":35,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":36,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":37,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":38,"kind":"parameter","displayName":"API access key (AK)","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"ignoreSslVerification":{"index":39,"kind":"parameter","displayName":"SSL Verification Ignored","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"},"secretKey":{"index":40,"kind":"parameter","displayName":"API secret key (SK)","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"},"serviceKeys":{"index":41,"kind":"parameter","displayName":"Service Configuration","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"}}} , -{"component":{"kind":"component","name":"hwcloud-smn","title":"Huawei Simple Message Notification (SMN)","description":"To broadcast messages and connect cloud services through notifications on Huawei Cloud","deprecated":false,"firstVersion":"3.8.0","label":"cloud,messaging","javaType":"org.apache.camel.component.huaweicloud.smn.SimpleNotificationComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-smn","version":"4.8.1","scheme":"hwcloud-smn","extendsScheme":"","syntax":"hwcloud-smn:smnService","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"smnService":{"index":0,"kind":"path","displayName":"Service name","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of SMN service to invoke"},"accessKey":{"index":1,"kind":"parameter","displayName":"API access key (AK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"endpoint":{"index":2,"kind":"parameter","displayName":"Service endpoint","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Fully qualified smn service url. Carries higher precedence than region parameter based client initialization"},"ignoreSslVerification":{"index":3,"kind":"parameter","displayName":"SSL Verification Ignored","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"},"messageTtl":{"index":4,"kind":"parameter","displayName":"Message TTL","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":3600,"description":"TTL for published message"},"operation":{"index":5,"kind":"parameter","displayName":"Operation name","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of operation to perform"},"projectId":{"index":6,"kind":"parameter","displayName":"Project ID","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cloud project ID"},"proxyHost":{"index":7,"kind":"parameter","displayName":"Proxy server host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"index":8,"kind":"parameter","displayName":"Proxy password","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy server port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"index":10,"kind":"parameter","displayName":"Proxy user","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"region":{"index":11,"kind":"parameter","displayName":"Service region","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"SMN service region. This is lower precedence than endpoint based configuration"},"secretKey":{"index":12,"kind":"parameter","displayName":"API secret key (SK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"},"serviceKeys":{"index":13,"kind":"parameter","displayName":"Service Configuration","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"},"lazyStartProducer":{"index":14,"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."}}} +{"component":{"kind":"component","name":"hwcloud-smn","title":"Huawei Simple Message Notification (SMN)","description":"To broadcast messages and connect cloud services through notifications on Huawei Cloud","deprecated":false,"firstVersion":"3.8.0","label":"cloud,messaging","javaType":"org.apache.camel.component.huaweicloud.smn.SimpleNotificationComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-smn","version":"4.8.2","scheme":"hwcloud-smn","extendsScheme":"","syntax":"hwcloud-smn:smnService","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"smnService":{"index":0,"kind":"path","displayName":"Service name","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of SMN service to invoke"},"accessKey":{"index":1,"kind":"parameter","displayName":"API access key (AK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"endpoint":{"index":2,"kind":"parameter","displayName":"Service endpoint","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Fully qualified smn service url. Carries higher precedence than region parameter based client initialization"},"ignoreSslVerification":{"index":3,"kind":"parameter","displayName":"SSL Verification Ignored","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"},"messageTtl":{"index":4,"kind":"parameter","displayName":"Message TTL","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":3600,"description":"TTL for published message"},"operation":{"index":5,"kind":"parameter","displayName":"Operation name","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of operation to perform"},"projectId":{"index":6,"kind":"parameter","displayName":"Project ID","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cloud project ID"},"proxyHost":{"index":7,"kind":"parameter","displayName":"Proxy server host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"index":8,"kind":"parameter","displayName":"Proxy password","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"index":9,"kind":"parameter","displayName":"Proxy server port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"index":10,"kind":"parameter","displayName":"Proxy user","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"region":{"index":11,"kind":"parameter","displayName":"Service region","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"SMN service region. This is lower precedence than endpoint based configuration"},"secretKey":{"index":12,"kind":"parameter","displayName":"API secret key (SK)","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"},"serviceKeys":{"index":13,"kind":"parameter","displayName":"Service Configuration","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"},"lazyStartProducer":{"index":14,"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."}}} , -{"component":{"kind":"component","name":"iec60870-client","title":"IEC 60870 Client","description":"IEC 60870 supervisory control and data acquisition (SCADA) client using NeoSCADA implementation.","deprecated":false,"firstVersion":"2.20.0","label":"iot","javaType":"org.apache.camel.component.iec60870.client.ClientComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-iec60870","version":"4.8.1","scheme":"iec60870-client","extendsScheme":"","syntax":"iec60870-client:uriPath","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelIec60870Value":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value","constantName":"org.apache.camel.component.iec60870.Constants#IEC60870_VALUE"},"CamelIec60870Timestamp":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the value","constantName":"org.apache.camel.component.iec60870.Constants#IEC60870_TIMESTAMP"},"CamelIec60870Quality":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.eclipse.neoscada.protocol.iec60870.asdu.types.QualityInformation","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The quality information of the value","constantName":"org.apache.camel.component.iec60870.Constants#IEC60870_QUALITY"},"CamelIec60870Overflow":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is overflow","constantName":"org.apache.camel.component.iec60870.Constants#IEC60870_OVERFLOW"}},"properties":{"uriPath":{"index":0,"kind":"path","displayName":"Uri Path","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.iec60870.ObjectAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object information address"},"dataModuleOptions":{"index":1,"kind":"parameter","displayName":"Data Module Options","group":"common","label":"","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.client.data.DataModuleOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Data module options"},"protocolOptions":{"index":2,"kind":"parameter","displayName":"Protocol Options","group":"common","label":"","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.ProtocolOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Protocol options"},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":6,"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."},"acknowledgeWindow":{"index":7,"kind":"parameter","displayName":"Acknowledge Window","group":"connection","label":"connection","required":false,"type":"integer","javaType":"short","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10","configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Parameter W - Acknowledgment window."},"adsuAddressType":{"index":8,"kind":"parameter","displayName":"Adsu Address Type","group":"connection","label":"connection","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.ASDUAddressType","enum":["SIZE_1","SIZE_2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The common ASDU address size. May be either SIZE_1 or SIZE_2."},"causeOfTransmissionType":{"index":9,"kind":"parameter","displayName":"Cause Of Transmission Type","group":"connection","label":"connection","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.CauseOfTransmissionType","enum":["SIZE_1","SIZE_2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The cause of transmission type. May be either SIZE_1 or SIZE_2."},"informationObjectAddressType":{"index":10,"kind":"parameter","displayName":"Information Object Address Type","group":"connection","label":"connection","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.InformationObjectAddressType","enum":["SIZE_1","SIZE_2","SIZE_3"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The information address size. May be either SIZE_1, SIZE_2 or SIZE_3."},"maxUnacknowledged":{"index":11,"kind":"parameter","displayName":"Max Unacknowledged","group":"connection","label":"connection","required":false,"type":"integer","javaType":"short","deprecated":false,"autowired":false,"secret":false,"defaultValue":"15","configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Parameter K - Maximum number of un-acknowledged messages."},"timeout1":{"index":12,"kind":"parameter","displayName":"Timeout1","group":"connection","label":"connection","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":15000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout T1 in milliseconds."},"timeout2":{"index":13,"kind":"parameter","displayName":"Timeout2","group":"connection","label":"connection","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout T2 in milliseconds."},"timeout3":{"index":14,"kind":"parameter","displayName":"Timeout3","group":"connection","label":"connection","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout T3 in milliseconds."},"causeSourceAddress":{"index":15,"kind":"parameter","displayName":"Cause Source Address","group":"data","label":"data","required":false,"type":"integer","javaType":"byte","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Whether to include the source address"},"connectionTimeout":{"index":16,"kind":"parameter","displayName":"Connection Timeout","group":"data","label":"data","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout in millis to wait for client to establish a connected connection."},"ignoreBackgroundScan":{"index":17,"kind":"parameter","displayName":"Ignore Background Scan","group":"data","label":"data","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Whether background scan transmissions should be ignored."},"ignoreDaylightSavingTime":{"index":18,"kind":"parameter","displayName":"Ignore Daylight Saving Time","group":"data","label":"data","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Whether to ignore or respect DST"},"timeZone":{"index":19,"kind":"parameter","displayName":"Time Zone","group":"data","label":"data","required":false,"type":"object","javaType":"java.util.TimeZone","deprecated":false,"autowired":false,"secret":false,"defaultValue":"UTC","configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The timezone to use. May be any Java time zone string"},"connectionId":{"index":20,"kind":"parameter","displayName":"Connection Id","group":"id","label":"id","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An identifier grouping connection instances"}}} +{"component":{"kind":"component","name":"iec60870-client","title":"IEC 60870 Client","description":"IEC 60870 supervisory control and data acquisition (SCADA) client using NeoSCADA implementation.","deprecated":false,"firstVersion":"2.20.0","label":"iot","javaType":"org.apache.camel.component.iec60870.client.ClientComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-iec60870","version":"4.8.2","scheme":"iec60870-client","extendsScheme":"","syntax":"iec60870-client:uriPath","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelIec60870Value":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value","constantName":"org.apache.camel.component.iec60870.Constants#IEC60870_VALUE"},"CamelIec60870Timestamp":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the value","constantName":"org.apache.camel.component.iec60870.Constants#IEC60870_TIMESTAMP"},"CamelIec60870Quality":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.eclipse.neoscada.protocol.iec60870.asdu.types.QualityInformation","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The quality information of the value","constantName":"org.apache.camel.component.iec60870.Constants#IEC60870_QUALITY"},"CamelIec60870Overflow":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is overflow","constantName":"org.apache.camel.component.iec60870.Constants#IEC60870_OVERFLOW"}},"properties":{"uriPath":{"index":0,"kind":"path","displayName":"Uri Path","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.iec60870.ObjectAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object information address"},"dataModuleOptions":{"index":1,"kind":"parameter","displayName":"Data Module Options","group":"common","label":"","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.client.data.DataModuleOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Data module options"},"protocolOptions":{"index":2,"kind":"parameter","displayName":"Protocol Options","group":"common","label":"","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.ProtocolOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Protocol options"},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":6,"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."},"acknowledgeWindow":{"index":7,"kind":"parameter","displayName":"Acknowledge Window","group":"connection","label":"connection","required":false,"type":"integer","javaType":"short","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10","configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Parameter W - Acknowledgment window."},"adsuAddressType":{"index":8,"kind":"parameter","displayName":"Adsu Address Type","group":"connection","label":"connection","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.ASDUAddressType","enum":["SIZE_1","SIZE_2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The common ASDU address size. May be either SIZE_1 or SIZE_2."},"causeOfTransmissionType":{"index":9,"kind":"parameter","displayName":"Cause Of Transmission Type","group":"connection","label":"connection","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.CauseOfTransmissionType","enum":["SIZE_1","SIZE_2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The cause of transmission type. May be either SIZE_1 or SIZE_2."},"informationObjectAddressType":{"index":10,"kind":"parameter","displayName":"Information Object Address Type","group":"connection","label":"connection","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.InformationObjectAddressType","enum":["SIZE_1","SIZE_2","SIZE_3"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The information address size. May be either SIZE_1, SIZE_2 or SIZE_3."},"maxUnacknowledged":{"index":11,"kind":"parameter","displayName":"Max Unacknowledged","group":"connection","label":"connection","required":false,"type":"integer","javaType":"short","deprecated":false,"autowired":false,"secret":false,"defaultValue":"15","configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Parameter K - Maximum number of un-acknowledged messages."},"timeout1":{"index":12,"kind":"parameter","displayName":"Timeout1","group":"connection","label":"connection","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":15000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout T1 in milliseconds."},"timeout2":{"index":13,"kind":"parameter","displayName":"Timeout2","group":"connection","label":"connection","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout T2 in milliseconds."},"timeout3":{"index":14,"kind":"parameter","displayName":"Timeout3","group":"connection","label":"connection","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout T3 in milliseconds."},"causeSourceAddress":{"index":15,"kind":"parameter","displayName":"Cause Source Address","group":"data","label":"data","required":false,"type":"integer","javaType":"byte","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Whether to include the source address"},"connectionTimeout":{"index":16,"kind":"parameter","displayName":"Connection Timeout","group":"data","label":"data","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout in millis to wait for client to establish a connected connection."},"ignoreBackgroundScan":{"index":17,"kind":"parameter","displayName":"Ignore Background Scan","group":"data","label":"data","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Whether background scan transmissions should be ignored."},"ignoreDaylightSavingTime":{"index":18,"kind":"parameter","displayName":"Ignore Daylight Saving Time","group":"data","label":"data","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Whether to ignore or respect DST"},"timeZone":{"index":19,"kind":"parameter","displayName":"Time Zone","group":"data","label":"data","required":false,"type":"object","javaType":"java.util.TimeZone","deprecated":false,"autowired":false,"secret":false,"defaultValue":"UTC","configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The timezone to use. May be any Java time zone string"},"connectionId":{"index":20,"kind":"parameter","displayName":"Connection Id","group":"id","label":"id","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An identifier grouping connection instances"}}} , -{"component":{"kind":"component","name":"iec60870-server","title":"IEC 60870 Server","description":"IEC 60870 supervisory control and data acquisition (SCADA) server using NeoSCADA implementation.","deprecated":false,"firstVersion":"2.20.0","label":"iot","javaType":"org.apache.camel.component.iec60870.server.ServerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-iec60870","version":"4.8.1","scheme":"iec60870-server","extendsScheme":"","syntax":"iec60870-server:uriPath","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"address":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.iec60870.ObjectAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The address as ObjectAddress","constantName":"org.apache.camel.component.iec60870.Constants#ADDRESS"},"value":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value","constantName":"org.apache.camel.component.iec60870.Constants#VALUE"},"informationObjectAddress":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.eclipse.neoscada.protocol.iec60870.asdu.types.InformationObjectAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The address as InformationObjectAddress","constantName":"org.apache.camel.component.iec60870.Constants#INFORMATION_OBJECT_ADDRESS"},"asduHeader":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.eclipse.neoscada.protocol.iec60870.asdu.ASDUHeader","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ASDU header","constantName":"org.apache.camel.component.iec60870.Constants#ASDU_HEADER"},"type":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type","constantName":"org.apache.camel.component.iec60870.Constants#TYPE"},"execute":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is execute","constantName":"org.apache.camel.component.iec60870.Constants#EXECUTE"}},"properties":{"uriPath":{"index":0,"kind":"path","displayName":"Uri Path","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.iec60870.ObjectAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object information address"},"dataModuleOptions":{"index":1,"kind":"parameter","displayName":"Data Module Options","group":"common","label":"","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.client.data.DataModuleOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Data module options"},"filterNonExecute":{"index":2,"kind":"parameter","displayName":"Filter Non Execute","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Filter out all requests which don't have the execute bit set"},"protocolOptions":{"index":3,"kind":"parameter","displayName":"Protocol Options","group":"common","label":"","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.ProtocolOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Protocol options"},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":7,"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."},"acknowledgeWindow":{"index":8,"kind":"parameter","displayName":"Acknowledge Window","group":"connection","label":"connection","required":false,"type":"integer","javaType":"short","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10","configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Parameter W - Acknowledgment window."},"adsuAddressType":{"index":9,"kind":"parameter","displayName":"Adsu Address Type","group":"connection","label":"connection","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.ASDUAddressType","enum":["SIZE_1","SIZE_2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The common ASDU address size. May be either SIZE_1 or SIZE_2."},"causeOfTransmissionType":{"index":10,"kind":"parameter","displayName":"Cause Of Transmission Type","group":"connection","label":"connection","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.CauseOfTransmissionType","enum":["SIZE_1","SIZE_2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The cause of transmission type. May be either SIZE_1 or SIZE_2."},"informationObjectAddressType":{"index":11,"kind":"parameter","displayName":"Information Object Address Type","group":"connection","label":"connection","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.InformationObjectAddressType","enum":["SIZE_1","SIZE_2","SIZE_3"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The information address size. May be either SIZE_1, SIZE_2 or SIZE_3."},"maxUnacknowledged":{"index":12,"kind":"parameter","displayName":"Max Unacknowledged","group":"connection","label":"connection","required":false,"type":"integer","javaType":"short","deprecated":false,"autowired":false,"secret":false,"defaultValue":"15","configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Parameter K - Maximum number of un-acknowledged messages."},"timeout1":{"index":13,"kind":"parameter","displayName":"Timeout1","group":"connection","label":"connection","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":15000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout T1 in milliseconds."},"timeout2":{"index":14,"kind":"parameter","displayName":"Timeout2","group":"connection","label":"connection","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout T2 in milliseconds."},"timeout3":{"index":15,"kind":"parameter","displayName":"Timeout3","group":"connection","label":"connection","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout T3 in milliseconds."},"causeSourceAddress":{"index":16,"kind":"parameter","displayName":"Cause Source Address","group":"data","label":"data","required":false,"type":"integer","javaType":"byte","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Whether to include the source address"},"connectionTimeout":{"index":17,"kind":"parameter","displayName":"Connection Timeout","group":"data","label":"data","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout in millis to wait for client to establish a connected connection."},"ignoreBackgroundScan":{"index":18,"kind":"parameter","displayName":"Ignore Background Scan","group":"data","label":"data","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Whether background scan transmissions should be ignored."},"ignoreDaylightSavingTime":{"index":19,"kind":"parameter","displayName":"Ignore Daylight Saving Time","group":"data","label":"data","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Whether to ignore or respect DST"},"timeZone":{"index":20,"kind":"parameter","displayName":"Time Zone","group":"data","label":"data","required":false,"type":"object","javaType":"java.util.TimeZone","deprecated":false,"autowired":false,"secret":false,"defaultValue":"UTC","configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The timezone to use. May be any Java time zone string"},"connectionId":{"index":21,"kind":"parameter","displayName":"Connection Id","group":"id","label":"id","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An identifier grouping connection instances"}}} +{"component":{"kind":"component","name":"iec60870-server","title":"IEC 60870 Server","description":"IEC 60870 supervisory control and data acquisition (SCADA) server using NeoSCADA implementation.","deprecated":false,"firstVersion":"2.20.0","label":"iot","javaType":"org.apache.camel.component.iec60870.server.ServerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-iec60870","version":"4.8.2","scheme":"iec60870-server","extendsScheme":"","syntax":"iec60870-server:uriPath","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"address":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.iec60870.ObjectAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The address as ObjectAddress","constantName":"org.apache.camel.component.iec60870.Constants#ADDRESS"},"value":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value","constantName":"org.apache.camel.component.iec60870.Constants#VALUE"},"informationObjectAddress":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.eclipse.neoscada.protocol.iec60870.asdu.types.InformationObjectAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The address as InformationObjectAddress","constantName":"org.apache.camel.component.iec60870.Constants#INFORMATION_OBJECT_ADDRESS"},"asduHeader":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.eclipse.neoscada.protocol.iec60870.asdu.ASDUHeader","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ASDU header","constantName":"org.apache.camel.component.iec60870.Constants#ASDU_HEADER"},"type":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type","constantName":"org.apache.camel.component.iec60870.Constants#TYPE"},"execute":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is execute","constantName":"org.apache.camel.component.iec60870.Constants#EXECUTE"}},"properties":{"uriPath":{"index":0,"kind":"path","displayName":"Uri Path","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.iec60870.ObjectAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object information address"},"dataModuleOptions":{"index":1,"kind":"parameter","displayName":"Data Module Options","group":"common","label":"","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.client.data.DataModuleOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Data module options"},"filterNonExecute":{"index":2,"kind":"parameter","displayName":"Filter Non Execute","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Filter out all requests which don't have the execute bit set"},"protocolOptions":{"index":3,"kind":"parameter","displayName":"Protocol Options","group":"common","label":"","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.ProtocolOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Protocol options"},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":7,"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."},"acknowledgeWindow":{"index":8,"kind":"parameter","displayName":"Acknowledge Window","group":"connection","label":"connection","required":false,"type":"integer","javaType":"short","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10","configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Parameter W - Acknowledgment window."},"adsuAddressType":{"index":9,"kind":"parameter","displayName":"Adsu Address Type","group":"connection","label":"connection","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.ASDUAddressType","enum":["SIZE_1","SIZE_2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The common ASDU address size. May be either SIZE_1 or SIZE_2."},"causeOfTransmissionType":{"index":10,"kind":"parameter","displayName":"Cause Of Transmission Type","group":"connection","label":"connection","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.CauseOfTransmissionType","enum":["SIZE_1","SIZE_2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The cause of transmission type. May be either SIZE_1 or SIZE_2."},"informationObjectAddressType":{"index":11,"kind":"parameter","displayName":"Information Object Address Type","group":"connection","label":"connection","required":false,"type":"object","javaType":"org.eclipse.neoscada.protocol.iec60870.InformationObjectAddressType","enum":["SIZE_1","SIZE_2","SIZE_3"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The information address size. May be either SIZE_1, SIZE_2 or SIZE_3."},"maxUnacknowledged":{"index":12,"kind":"parameter","displayName":"Max Unacknowledged","group":"connection","label":"connection","required":false,"type":"integer","javaType":"short","deprecated":false,"autowired":false,"secret":false,"defaultValue":"15","configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Parameter K - Maximum number of un-acknowledged messages."},"timeout1":{"index":13,"kind":"parameter","displayName":"Timeout1","group":"connection","label":"connection","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":15000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout T1 in milliseconds."},"timeout2":{"index":14,"kind":"parameter","displayName":"Timeout2","group":"connection","label":"connection","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout T2 in milliseconds."},"timeout3":{"index":15,"kind":"parameter","displayName":"Timeout3","group":"connection","label":"connection","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout T3 in milliseconds."},"causeSourceAddress":{"index":16,"kind":"parameter","displayName":"Cause Source Address","group":"data","label":"data","required":false,"type":"integer","javaType":"byte","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Whether to include the source address"},"connectionTimeout":{"index":17,"kind":"parameter","displayName":"Connection Timeout","group":"data","label":"data","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Timeout in millis to wait for client to establish a connected connection."},"ignoreBackgroundScan":{"index":18,"kind":"parameter","displayName":"Ignore Background Scan","group":"data","label":"data","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Whether background scan transmissions should be ignored."},"ignoreDaylightSavingTime":{"index":19,"kind":"parameter","displayName":"Ignore Daylight Saving Time","group":"data","label":"data","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"Whether to ignore or respect DST"},"timeZone":{"index":20,"kind":"parameter","displayName":"Time Zone","group":"data","label":"data","required":false,"type":"object","javaType":"java.util.TimeZone","deprecated":false,"autowired":false,"secret":false,"defaultValue":"UTC","configurationClass":"org.apache.camel.component.iec60870.client.ClientOptions","configurationField":"connectionOptions","description":"The timezone to use. May be any Java time zone string"},"connectionId":{"index":21,"kind":"parameter","displayName":"Connection Id","group":"id","label":"id","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An identifier grouping connection instances"}}} , -{"component":{"kind":"component","name":"ignite-cache","title":"Ignite Cache","description":"Perform cache operations on an Ignite cache or consume changes from a continuous query.","deprecated":false,"firstVersion":"2.17.0","label":"cache,clustering","javaType":"org.apache.camel.component.ignite.cache.IgniteCacheComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"4.8.1","scheme":"ignite-cache","extendsScheme":"","syntax":"ignite-cache:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelIgniteCacheKey":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cache key for the entry value in the message body.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_CACHE_KEY"},"CamelIgniteCacheQuery":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.ignite.cache.query.Query","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query to run when invoking the QUERY operation.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_CACHE_QUERY"},"CamelIgniteCacheOperation":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.ignite.cache.IgniteCacheOperation","enum":["GET","PUT","REMOVE","SIZE","REBALANCE","QUERY","CLEAR","REPLACE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows you to dynamically change the cache operation to execute.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_CACHE_OPERATION"},"CamelIgniteCachePeekMode":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.ignite.cache.CachePeekMode","enum":["ALL","NEAR","PRIMARY","BACKUP","ONHEAP","OFFHEAP"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows you to dynamically change the cache peek mode when running the SIZE operation.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_CACHE_PEEK_MODE"},"CamelIgniteCacheEventType":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"javax.cache.event.EventType","enum":["CREATED","UPDATED","REMOVED","EXPIRED"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header carries the received event type when using the continuous query consumer.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_CACHE_EVENT_TYPE"},"CamelIgniteCacheName":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header carries the cache name for which a continuous query event was received (consumer). It does not allow you to dynamically change the cache against which a producer operation is performed. Use EIPs for that (e.g. recipient list, dynamic router).","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_CACHE_NAME"},"CamelIgniteCacheOldValue":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) The old cache value to be replaced when invoking the REPLACE operation. (consumer) This header carries the old cache value when passed in the incoming cache event.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_CACHE_OLD_VALUE"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cache name."},"propagateIncomingBodyIfNoReturnValue":{"index":1,"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"treatCollectionsAsCacheObjects":{"index":2,"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"autoUnsubscribe":{"index":3,"kind":"parameter","displayName":"Auto Unsubscribe","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether auto unsubscribe is enabled in the Continuous Query Consumer. Default value notice: ContinuousQuery.DFLT_AUTO_UNSUBSCRIBE"},"fireExistingQueryResults":{"index":4,"kind":"parameter","displayName":"Fire Existing Query Results","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to process existing results that match the query. Used on initialization of the Continuous Query Consumer."},"oneExchangePerUpdate":{"index":5,"kind":"parameter","displayName":"One Exchange Per Update","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to pack each update in an individual Exchange, even if multiple updates are received in one batch. Only used by the Continuous Query Consumer."},"pageSize":{"index":6,"kind":"parameter","displayName":"Page Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"The page size. Only used by the Continuous Query Consumer. Default value notice: ContinuousQuery.DFLT_PAGE_SIZE"},"query":{"index":7,"kind":"parameter","displayName":"Query","group":"consumer","label":"producer,consumer","required":false,"type":"object","javaType":"org.apache.ignite.cache.query.Query>","deprecated":false,"autowired":false,"secret":false,"description":"The Query to execute, only needed for operations that require it, and for the Continuous Query Consumer."},"remoteFilter":{"index":8,"kind":"parameter","displayName":"Remote Filter","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.ignite.cache.CacheEntryEventSerializableFilter","deprecated":false,"autowired":false,"secret":false,"description":"The remote filter, only used by the Continuous Query Consumer."},"timeInterval":{"index":9,"kind":"parameter","displayName":"Time Interval","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"The time interval for the Continuous Query Consumer. Default value notice: ContinuousQuery.DFLT_TIME_INTERVAL"},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"cachePeekMode":{"index":13,"kind":"parameter","displayName":"Cache Peek Mode","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.ignite.cache.CachePeekMode","enum":["ALL","NEAR","PRIMARY","BACKUP","ONHEAP","OFFHEAP"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ALL","description":"The CachePeekMode, only needed for operations that require it (IgniteCacheOperation#SIZE)."},"failIfInexistentCache":{"index":14,"kind":"parameter","displayName":"Fail If Inexistent Cache","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to fail the initialization if the cache doesn't exist."},"operation":{"index":15,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.cache.IgniteCacheOperation","enum":["GET","PUT","REMOVE","SIZE","REBALANCE","QUERY","CLEAR","REPLACE"],"deprecated":false,"autowired":false,"secret":false,"description":"The cache operation to invoke. Possible values: GET, PUT, REMOVE, SIZE, REBALANCE, QUERY, CLEAR."},"lazyStartProducer":{"index":16,"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."}}} +{"component":{"kind":"component","name":"ignite-cache","title":"Ignite Cache","description":"Perform cache operations on an Ignite cache or consume changes from a continuous query.","deprecated":false,"firstVersion":"2.17.0","label":"cache,clustering","javaType":"org.apache.camel.component.ignite.cache.IgniteCacheComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"4.8.2","scheme":"ignite-cache","extendsScheme":"","syntax":"ignite-cache:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelIgniteCacheKey":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cache key for the entry value in the message body.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_CACHE_KEY"},"CamelIgniteCacheQuery":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.ignite.cache.query.Query","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query to run when invoking the QUERY operation.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_CACHE_QUERY"},"CamelIgniteCacheOperation":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.ignite.cache.IgniteCacheOperation","enum":["GET","PUT","REMOVE","SIZE","REBALANCE","QUERY","CLEAR","REPLACE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows you to dynamically change the cache operation to execute.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_CACHE_OPERATION"},"CamelIgniteCachePeekMode":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.ignite.cache.CachePeekMode","enum":["ALL","NEAR","PRIMARY","BACKUP","ONHEAP","OFFHEAP"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows you to dynamically change the cache peek mode when running the SIZE operation.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_CACHE_PEEK_MODE"},"CamelIgniteCacheEventType":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"javax.cache.event.EventType","enum":["CREATED","UPDATED","REMOVED","EXPIRED"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header carries the received event type when using the continuous query consumer.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_CACHE_EVENT_TYPE"},"CamelIgniteCacheName":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header carries the cache name for which a continuous query event was received (consumer). It does not allow you to dynamically change the cache against which a producer operation is performed. Use EIPs for that (e.g. recipient list, dynamic router).","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_CACHE_NAME"},"CamelIgniteCacheOldValue":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) The old cache value to be replaced when invoking the REPLACE operation. (consumer) This header carries the old cache value when passed in the incoming cache event.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_CACHE_OLD_VALUE"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cache name."},"propagateIncomingBodyIfNoReturnValue":{"index":1,"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"treatCollectionsAsCacheObjects":{"index":2,"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"autoUnsubscribe":{"index":3,"kind":"parameter","displayName":"Auto Unsubscribe","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether auto unsubscribe is enabled in the Continuous Query Consumer. Default value notice: ContinuousQuery.DFLT_AUTO_UNSUBSCRIBE"},"fireExistingQueryResults":{"index":4,"kind":"parameter","displayName":"Fire Existing Query Results","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to process existing results that match the query. Used on initialization of the Continuous Query Consumer."},"oneExchangePerUpdate":{"index":5,"kind":"parameter","displayName":"One Exchange Per Update","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to pack each update in an individual Exchange, even if multiple updates are received in one batch. Only used by the Continuous Query Consumer."},"pageSize":{"index":6,"kind":"parameter","displayName":"Page Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"The page size. Only used by the Continuous Query Consumer. Default value notice: ContinuousQuery.DFLT_PAGE_SIZE"},"query":{"index":7,"kind":"parameter","displayName":"Query","group":"consumer","label":"producer,consumer","required":false,"type":"object","javaType":"org.apache.ignite.cache.query.Query>","deprecated":false,"autowired":false,"secret":false,"description":"The Query to execute, only needed for operations that require it, and for the Continuous Query Consumer."},"remoteFilter":{"index":8,"kind":"parameter","displayName":"Remote Filter","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.ignite.cache.CacheEntryEventSerializableFilter","deprecated":false,"autowired":false,"secret":false,"description":"The remote filter, only used by the Continuous Query Consumer."},"timeInterval":{"index":9,"kind":"parameter","displayName":"Time Interval","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"The time interval for the Continuous Query Consumer. Default value notice: ContinuousQuery.DFLT_TIME_INTERVAL"},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"cachePeekMode":{"index":13,"kind":"parameter","displayName":"Cache Peek Mode","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.ignite.cache.CachePeekMode","enum":["ALL","NEAR","PRIMARY","BACKUP","ONHEAP","OFFHEAP"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ALL","description":"The CachePeekMode, only needed for operations that require it (IgniteCacheOperation#SIZE)."},"failIfInexistentCache":{"index":14,"kind":"parameter","displayName":"Fail If Inexistent Cache","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to fail the initialization if the cache doesn't exist."},"operation":{"index":15,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.cache.IgniteCacheOperation","enum":["GET","PUT","REMOVE","SIZE","REBALANCE","QUERY","CLEAR","REPLACE"],"deprecated":false,"autowired":false,"secret":false,"description":"The cache operation to invoke. Possible values: GET, PUT, REMOVE, SIZE, REBALANCE, QUERY, CLEAR."},"lazyStartProducer":{"index":16,"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."}}} , -{"component":{"kind":"component","name":"ignite-compute","title":"Ignite Compute","description":"Run compute operations on an Ignite cluster.","deprecated":false,"firstVersion":"2.17.0","label":"cache,clustering","javaType":"org.apache.camel.component.ignite.compute.IgniteComputeComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"4.8.1","scheme":"ignite-compute","extendsScheme":"","syntax":"ignite-compute:endpointId","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelIgniteComputeExecutionType":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.ignite.compute.IgniteComputeExecutionType","enum":["CALL","BROADCAST","APPLY","EXECUTE","RUN","AFFINITY_CALL","AFFINITY_RUN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows you to dynamically change the compute operation to perform.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_EXECUTION_TYPE"},"CamelIgniteComputeParameters":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Any object or Collection of objects","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Parameters for APPLY, BROADCAST and EXECUTE operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_PARAMS"},"CamelIgniteComputeReducer":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.ignite.lang.IgniteReducer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reducer for the APPLY and CALL operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_REDUCER"},"CamelIgniteComputeAffinityCacheName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Affinity cache name for the AFFINITY_CALL and AFFINITY_RUN operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_AFFINITY_CACHE_NAME"},"CamelIgniteComputeAffinityKey":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Affinity key for the AFFINITY_CALL and AFFINITY_RUN operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_AFFINITY_KEY"}},"properties":{"endpointId":{"index":0,"kind":"path","displayName":"Endpoint Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The endpoint ID (not used)."},"clusterGroupExpression":{"index":1,"kind":"parameter","displayName":"Cluster Group Expression","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.ClusterGroupExpression","deprecated":false,"autowired":false,"secret":false,"description":"An expression that returns the Cluster Group for the IgniteCompute instance."},"computeName":{"index":2,"kind":"parameter","displayName":"Compute Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the compute job, which will be set via IgniteCompute#withName(String)."},"executionType":{"index":3,"kind":"parameter","displayName":"Execution Type","group":"producer","label":"producer","required":true,"type":"object","javaType":"org.apache.camel.component.ignite.compute.IgniteComputeExecutionType","enum":["CALL","BROADCAST","APPLY","EXECUTE","RUN","AFFINITY_CALL","AFFINITY_RUN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The compute operation to perform. Possible values: CALL, BROADCAST, APPLY, EXECUTE, RUN, AFFINITY_CALL, AFFINITY_RUN. The component expects different payload types depending on the operation."},"propagateIncomingBodyIfNoReturnValue":{"index":4,"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"taskName":{"index":5,"kind":"parameter","displayName":"Task Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The task name, only applicable if using the IgniteComputeExecutionType#EXECUTE execution type."},"timeoutMillis":{"index":6,"kind":"parameter","displayName":"Timeout Millis","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The timeout interval for triggered jobs, in milliseconds, which will be set via IgniteCompute#withTimeout(long)."},"treatCollectionsAsCacheObjects":{"index":7,"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"lazyStartProducer":{"index":8,"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."}}} +{"component":{"kind":"component","name":"ignite-compute","title":"Ignite Compute","description":"Run compute operations on an Ignite cluster.","deprecated":false,"firstVersion":"2.17.0","label":"cache,clustering","javaType":"org.apache.camel.component.ignite.compute.IgniteComputeComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"4.8.2","scheme":"ignite-compute","extendsScheme":"","syntax":"ignite-compute:endpointId","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelIgniteComputeExecutionType":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.ignite.compute.IgniteComputeExecutionType","enum":["CALL","BROADCAST","APPLY","EXECUTE","RUN","AFFINITY_CALL","AFFINITY_RUN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows you to dynamically change the compute operation to perform.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_EXECUTION_TYPE"},"CamelIgniteComputeParameters":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Any object or Collection of objects","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Parameters for APPLY, BROADCAST and EXECUTE operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_PARAMS"},"CamelIgniteComputeReducer":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.ignite.lang.IgniteReducer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reducer for the APPLY and CALL operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_REDUCER"},"CamelIgniteComputeAffinityCacheName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Affinity cache name for the AFFINITY_CALL and AFFINITY_RUN operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_AFFINITY_CACHE_NAME"},"CamelIgniteComputeAffinityKey":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Affinity key for the AFFINITY_CALL and AFFINITY_RUN operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_AFFINITY_KEY"}},"properties":{"endpointId":{"index":0,"kind":"path","displayName":"Endpoint Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The endpoint ID (not used)."},"clusterGroupExpression":{"index":1,"kind":"parameter","displayName":"Cluster Group Expression","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.ClusterGroupExpression","deprecated":false,"autowired":false,"secret":false,"description":"An expression that returns the Cluster Group for the IgniteCompute instance."},"computeName":{"index":2,"kind":"parameter","displayName":"Compute Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the compute job, which will be set via IgniteCompute#withName(String)."},"executionType":{"index":3,"kind":"parameter","displayName":"Execution Type","group":"producer","label":"producer","required":true,"type":"object","javaType":"org.apache.camel.component.ignite.compute.IgniteComputeExecutionType","enum":["CALL","BROADCAST","APPLY","EXECUTE","RUN","AFFINITY_CALL","AFFINITY_RUN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The compute operation to perform. Possible values: CALL, BROADCAST, APPLY, EXECUTE, RUN, AFFINITY_CALL, AFFINITY_RUN. The component expects different payload types depending on the operation."},"propagateIncomingBodyIfNoReturnValue":{"index":4,"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"taskName":{"index":5,"kind":"parameter","displayName":"Task Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The task name, only applicable if using the IgniteComputeExecutionType#EXECUTE execution type."},"timeoutMillis":{"index":6,"kind":"parameter","displayName":"Timeout Millis","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The timeout interval for triggered jobs, in milliseconds, which will be set via IgniteCompute#withTimeout(long)."},"treatCollectionsAsCacheObjects":{"index":7,"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"lazyStartProducer":{"index":8,"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."}}} , -{"component":{"kind":"component","name":"ignite-events","title":"Ignite Events","description":"Receive events from an Ignite cluster by creating a local event listener.","deprecated":false,"firstVersion":"2.17.0","label":"messaging,cache,clustering","javaType":"org.apache.camel.component.ignite.events.IgniteEventsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"4.8.1","scheme":"ignite-events","extendsScheme":"","syntax":"ignite-events:endpointId","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"endpointId":{"index":0,"kind":"path","displayName":"Endpoint Id","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The endpoint ID (not used)."},"clusterGroupExpression":{"index":1,"kind":"parameter","displayName":"Cluster Group Expression","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.ClusterGroupExpression","deprecated":false,"autowired":false,"secret":false,"description":"The cluster group expression."},"events":{"index":2,"kind":"parameter","displayName":"Events","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"EVTS_ALL","description":"The event types to subscribe to as a comma-separated string of event constants as defined in EventType. For example: EVT_CACHE_ENTRY_CREATED,EVT_CACHE_OBJECT_REMOVED,EVT_IGFS_DIR_CREATED."},"propagateIncomingBodyIfNoReturnValue":{"index":3,"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"treatCollectionsAsCacheObjects":{"index":4,"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} +{"component":{"kind":"component","name":"ignite-events","title":"Ignite Events","description":"Receive events from an Ignite cluster by creating a local event listener.","deprecated":false,"firstVersion":"2.17.0","label":"messaging,cache,clustering","javaType":"org.apache.camel.component.ignite.events.IgniteEventsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"4.8.2","scheme":"ignite-events","extendsScheme":"","syntax":"ignite-events:endpointId","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"endpointId":{"index":0,"kind":"path","displayName":"Endpoint Id","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The endpoint ID (not used)."},"clusterGroupExpression":{"index":1,"kind":"parameter","displayName":"Cluster Group Expression","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.ClusterGroupExpression","deprecated":false,"autowired":false,"secret":false,"description":"The cluster group expression."},"events":{"index":2,"kind":"parameter","displayName":"Events","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"EVTS_ALL","description":"The event types to subscribe to as a comma-separated string of event constants as defined in EventType. For example: EVT_CACHE_ENTRY_CREATED,EVT_CACHE_OBJECT_REMOVED,EVT_IGFS_DIR_CREATED."},"propagateIncomingBodyIfNoReturnValue":{"index":3,"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"treatCollectionsAsCacheObjects":{"index":4,"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} , -{"component":{"kind":"component","name":"ignite-idgen","title":"Ignite ID Generator","description":"Interact with Ignite Atomic Sequences and ID Generators .","deprecated":false,"firstVersion":"2.17.0","label":"cache,clustering","javaType":"org.apache.camel.component.ignite.idgen.IgniteIdGenComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"4.8.1","scheme":"ignite-idgen","extendsScheme":"","syntax":"ignite-idgen:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelIgniteIdGenOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.ignite.idgen.IgniteIdGenOperation","enum":["ADD_AND_GET","GET","GET_AND_ADD","GET_AND_INCREMENT","INCREMENT_AND_GET"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows you to dynamically change the ID Generator operation.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_IDGEN_OPERATION"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sequence name."},"batchSize":{"index":1,"kind":"parameter","displayName":"Batch Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The batch size."},"initialValue":{"index":2,"kind":"parameter","displayName":"Initial Value","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","description":"The initial value."},"operation":{"index":3,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.idgen.IgniteIdGenOperation","enum":["ADD_AND_GET","GET","GET_AND_ADD","GET_AND_INCREMENT","INCREMENT_AND_GET"],"deprecated":false,"autowired":false,"secret":false,"description":"The operation to invoke on the Ignite ID Generator. Superseded by the IgniteConstants.IGNITE_IDGEN_OPERATION header in the IN message. Possible values: ADD_AND_GET, GET, GET_AND_ADD, GET_AND_INCREMENT, INCREMENT_AND_GET."},"propagateIncomingBodyIfNoReturnValue":{"index":4,"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"treatCollectionsAsCacheObjects":{"index":5,"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"lazyStartProducer":{"index":6,"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."}}} +{"component":{"kind":"component","name":"ignite-idgen","title":"Ignite ID Generator","description":"Interact with Ignite Atomic Sequences and ID Generators .","deprecated":false,"firstVersion":"2.17.0","label":"cache,clustering","javaType":"org.apache.camel.component.ignite.idgen.IgniteIdGenComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"4.8.2","scheme":"ignite-idgen","extendsScheme":"","syntax":"ignite-idgen:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelIgniteIdGenOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.ignite.idgen.IgniteIdGenOperation","enum":["ADD_AND_GET","GET","GET_AND_ADD","GET_AND_INCREMENT","INCREMENT_AND_GET"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows you to dynamically change the ID Generator operation.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_IDGEN_OPERATION"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sequence name."},"batchSize":{"index":1,"kind":"parameter","displayName":"Batch Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The batch size."},"initialValue":{"index":2,"kind":"parameter","displayName":"Initial Value","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","description":"The initial value."},"operation":{"index":3,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.idgen.IgniteIdGenOperation","enum":["ADD_AND_GET","GET","GET_AND_ADD","GET_AND_INCREMENT","INCREMENT_AND_GET"],"deprecated":false,"autowired":false,"secret":false,"description":"The operation to invoke on the Ignite ID Generator. Superseded by the IgniteConstants.IGNITE_IDGEN_OPERATION header in the IN message. Possible values: ADD_AND_GET, GET, GET_AND_ADD, GET_AND_INCREMENT, INCREMENT_AND_GET."},"propagateIncomingBodyIfNoReturnValue":{"index":4,"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"treatCollectionsAsCacheObjects":{"index":5,"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"lazyStartProducer":{"index":6,"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."}}} , -{"component":{"kind":"component","name":"ignite-messaging","title":"Ignite Messaging","description":"Send and receive messages from an Ignite topic.","deprecated":false,"firstVersion":"2.17.0","label":"messaging","javaType":"org.apache.camel.component.ignite.messaging.IgniteMessagingComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"4.8.1","scheme":"ignite-messaging","extendsScheme":"","syntax":"ignite-messaging:topic","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelIgniteMessagingTopic":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) Allows you to dynamically change the topic to send messages to. (consumer) It also carries the topic on which a message was received.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_MESSAGING_TOPIC"},"CamelIgniteMessagingUUID":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.util.UUID","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header is filled in with the UUID of the subscription when a message arrives.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_MESSAGING_UUID"}},"properties":{"topic":{"index":0,"kind":"path","displayName":"Topic","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The topic name."},"propagateIncomingBodyIfNoReturnValue":{"index":1,"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"treatCollectionsAsCacheObjects":{"index":2,"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"clusterGroupExpression":{"index":6,"kind":"parameter","displayName":"Cluster Group Expression","group":"producer","label":"consumer,producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.ClusterGroupExpression","deprecated":false,"autowired":false,"secret":false,"description":"The cluster group expression."},"sendMode":{"index":7,"kind":"parameter","displayName":"Send Mode","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.messaging.IgniteMessagingSendMode","enum":["ORDERED","UNORDERED"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"UNORDERED","description":"The send mode to use. Possible values: UNORDERED, ORDERED."},"timeout":{"index":8,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The timeout for the send operation when using ordered messages."},"lazyStartProducer":{"index":9,"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."}}} +{"component":{"kind":"component","name":"ignite-messaging","title":"Ignite Messaging","description":"Send and receive messages from an Ignite topic.","deprecated":false,"firstVersion":"2.17.0","label":"messaging","javaType":"org.apache.camel.component.ignite.messaging.IgniteMessagingComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"4.8.2","scheme":"ignite-messaging","extendsScheme":"","syntax":"ignite-messaging:topic","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelIgniteMessagingTopic":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) Allows you to dynamically change the topic to send messages to. (consumer) It also carries the topic on which a message was received.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_MESSAGING_TOPIC"},"CamelIgniteMessagingUUID":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.util.UUID","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header is filled in with the UUID of the subscription when a message arrives.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_MESSAGING_UUID"}},"properties":{"topic":{"index":0,"kind":"path","displayName":"Topic","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The topic name."},"propagateIncomingBodyIfNoReturnValue":{"index":1,"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"treatCollectionsAsCacheObjects":{"index":2,"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"clusterGroupExpression":{"index":6,"kind":"parameter","displayName":"Cluster Group Expression","group":"producer","label":"consumer,producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.ClusterGroupExpression","deprecated":false,"autowired":false,"secret":false,"description":"The cluster group expression."},"sendMode":{"index":7,"kind":"parameter","displayName":"Send Mode","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.messaging.IgniteMessagingSendMode","enum":["ORDERED","UNORDERED"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"UNORDERED","description":"The send mode to use. Possible values: UNORDERED, ORDERED."},"timeout":{"index":8,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The timeout for the send operation when using ordered messages."},"lazyStartProducer":{"index":9,"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."}}} , -{"component":{"kind":"component","name":"ignite-queue","title":"Ignite Queues","description":"Interact with Ignite Queue data structures.","deprecated":false,"firstVersion":"2.17.0","label":"cache,clustering,messaging","javaType":"org.apache.camel.component.ignite.queue.IgniteQueueComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"4.8.1","scheme":"ignite-queue","extendsScheme":"","syntax":"ignite-queue:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelIgniteQueueOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.ignite.queue.IgniteQueueOperation","enum":["CONTAINS","ADD","SIZE","REMOVE","ITERATOR","CLEAR","RETAIN_ALL","ARRAY","DRAIN","ELEMENT","PEEK","OFFER","POLL","TAKE","PUT"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows you to dynamically change the queue operation.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_QUEUE_OPERATION"},"CamelIgniteQueueMaxElements":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When invoking the DRAIN operation, the amount of items to drain.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_QUEUE_MAX_ELEMENTS"},"CamelIgniteQueueTransferredCount":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The amount of items transferred as the result of the DRAIN operation.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_QUEUE_TRANSFERRED_COUNT"},"CamelIgniteQueueTimeoutMillis":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Dynamically sets the timeout in milliseconds to use when invoking the OFFER or POLL operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_QUEUE_TIMEOUT_MILLIS"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The queue name."},"capacity":{"index":1,"kind":"parameter","displayName":"Capacity","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The queue capacity. Default: non-bounded."},"configuration":{"index":2,"kind":"parameter","displayName":"Configuration","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.ignite.configuration.CollectionConfiguration","deprecated":false,"autowired":false,"secret":false,"description":"The collection configuration. Default: empty configuration. You can also conveniently set inner properties by using configuration.xyz=123 options."},"operation":{"index":3,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.queue.IgniteQueueOperation","enum":["CONTAINS","ADD","SIZE","REMOVE","ITERATOR","CLEAR","RETAIN_ALL","ARRAY","DRAIN","ELEMENT","PEEK","OFFER","POLL","TAKE","PUT"],"deprecated":false,"autowired":false,"secret":false,"description":"The operation to invoke on the Ignite Queue. Superseded by the IgniteConstants.IGNITE_QUEUE_OPERATION header in the IN message. Possible values: CONTAINS, ADD, SIZE, REMOVE, ITERATOR, CLEAR, RETAIN_ALL, ARRAY, DRAIN, ELEMENT, PEEK, OFFER, POLL, TAKE, PUT."},"propagateIncomingBodyIfNoReturnValue":{"index":4,"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"timeoutMillis":{"index":5,"kind":"parameter","displayName":"Timeout Millis","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The queue timeout in milliseconds. Default: no timeout."},"treatCollectionsAsCacheObjects":{"index":6,"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"lazyStartProducer":{"index":7,"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."}}} +{"component":{"kind":"component","name":"ignite-queue","title":"Ignite Queues","description":"Interact with Ignite Queue data structures.","deprecated":false,"firstVersion":"2.17.0","label":"cache,clustering,messaging","javaType":"org.apache.camel.component.ignite.queue.IgniteQueueComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"4.8.2","scheme":"ignite-queue","extendsScheme":"","syntax":"ignite-queue:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelIgniteQueueOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.ignite.queue.IgniteQueueOperation","enum":["CONTAINS","ADD","SIZE","REMOVE","ITERATOR","CLEAR","RETAIN_ALL","ARRAY","DRAIN","ELEMENT","PEEK","OFFER","POLL","TAKE","PUT"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows you to dynamically change the queue operation.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_QUEUE_OPERATION"},"CamelIgniteQueueMaxElements":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When invoking the DRAIN operation, the amount of items to drain.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_QUEUE_MAX_ELEMENTS"},"CamelIgniteQueueTransferredCount":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The amount of items transferred as the result of the DRAIN operation.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_QUEUE_TRANSFERRED_COUNT"},"CamelIgniteQueueTimeoutMillis":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Dynamically sets the timeout in milliseconds to use when invoking the OFFER or POLL operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_QUEUE_TIMEOUT_MILLIS"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The queue name."},"capacity":{"index":1,"kind":"parameter","displayName":"Capacity","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The queue capacity. Default: non-bounded."},"configuration":{"index":2,"kind":"parameter","displayName":"Configuration","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.ignite.configuration.CollectionConfiguration","deprecated":false,"autowired":false,"secret":false,"description":"The collection configuration. Default: empty configuration. You can also conveniently set inner properties by using configuration.xyz=123 options."},"operation":{"index":3,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.queue.IgniteQueueOperation","enum":["CONTAINS","ADD","SIZE","REMOVE","ITERATOR","CLEAR","RETAIN_ALL","ARRAY","DRAIN","ELEMENT","PEEK","OFFER","POLL","TAKE","PUT"],"deprecated":false,"autowired":false,"secret":false,"description":"The operation to invoke on the Ignite Queue. Superseded by the IgniteConstants.IGNITE_QUEUE_OPERATION header in the IN message. Possible values: CONTAINS, ADD, SIZE, REMOVE, ITERATOR, CLEAR, RETAIN_ALL, ARRAY, DRAIN, ELEMENT, PEEK, OFFER, POLL, TAKE, PUT."},"propagateIncomingBodyIfNoReturnValue":{"index":4,"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"timeoutMillis":{"index":5,"kind":"parameter","displayName":"Timeout Millis","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The queue timeout in milliseconds. Default: no timeout."},"treatCollectionsAsCacheObjects":{"index":6,"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"lazyStartProducer":{"index":7,"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."}}} , -{"component":{"kind":"component","name":"ignite-set","title":"Ignite Sets","description":"Interact with Ignite Set data structures.","deprecated":false,"firstVersion":"2.17.0","label":"cache,clustering","javaType":"org.apache.camel.component.ignite.set.IgniteSetComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"4.8.1","scheme":"ignite-set","extendsScheme":"","syntax":"ignite-set:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelIgniteSetsOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.ignite.set.IgniteSetOperation","enum":["CONTAINS","ADD","SIZE","REMOVE","ITERATOR","CLEAR","RETAIN_ALL","ARRAY"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows you to dynamically change the set operation.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_SETS_OPERATION"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The set name."},"configuration":{"index":1,"kind":"parameter","displayName":"Configuration","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.ignite.configuration.CollectionConfiguration","deprecated":false,"autowired":false,"secret":false,"description":"The collection configuration. Default: empty configuration. You can also conveniently set inner properties by using configuration.xyz=123 options."},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.set.IgniteSetOperation","enum":["CONTAINS","ADD","SIZE","REMOVE","ITERATOR","CLEAR","RETAIN_ALL","ARRAY"],"deprecated":false,"autowired":false,"secret":false,"description":"The operation to invoke on the Ignite Set. Superseded by the IgniteConstants.IGNITE_SETS_OPERATION header in the IN message. Possible values: CONTAINS, ADD, SIZE, REMOVE, ITERATOR, CLEAR, RETAIN_ALL, ARRAY.The set operation to perform."},"propagateIncomingBodyIfNoReturnValue":{"index":3,"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"treatCollectionsAsCacheObjects":{"index":4,"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"lazyStartProducer":{"index":5,"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."}}} +{"component":{"kind":"component","name":"ignite-set","title":"Ignite Sets","description":"Interact with Ignite Set data structures.","deprecated":false,"firstVersion":"2.17.0","label":"cache,clustering","javaType":"org.apache.camel.component.ignite.set.IgniteSetComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"4.8.2","scheme":"ignite-set","extendsScheme":"","syntax":"ignite-set:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelIgniteSetsOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.ignite.set.IgniteSetOperation","enum":["CONTAINS","ADD","SIZE","REMOVE","ITERATOR","CLEAR","RETAIN_ALL","ARRAY"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows you to dynamically change the set operation.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_SETS_OPERATION"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The set name."},"configuration":{"index":1,"kind":"parameter","displayName":"Configuration","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.ignite.configuration.CollectionConfiguration","deprecated":false,"autowired":false,"secret":false,"description":"The collection configuration. Default: empty configuration. You can also conveniently set inner properties by using configuration.xyz=123 options."},"operation":{"index":2,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.set.IgniteSetOperation","enum":["CONTAINS","ADD","SIZE","REMOVE","ITERATOR","CLEAR","RETAIN_ALL","ARRAY"],"deprecated":false,"autowired":false,"secret":false,"description":"The operation to invoke on the Ignite Set. Superseded by the IgniteConstants.IGNITE_SETS_OPERATION header in the IN message. Possible values: CONTAINS, ADD, SIZE, REMOVE, ITERATOR, CLEAR, RETAIN_ALL, ARRAY.The set operation to perform."},"propagateIncomingBodyIfNoReturnValue":{"index":3,"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"treatCollectionsAsCacheObjects":{"index":4,"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"lazyStartProducer":{"index":5,"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."}}} , -{"component":{"kind":"component","name":"imap","title":"IMAP","description":"Send and receive emails using imap, pop3 and smtp protocols.","deprecated":false,"firstVersion":"1.0.0","label":"mail","javaType":"org.apache.camel.component.mail.MailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mail","version":"4.8.1","scheme":"imap","extendsScheme":"","alternativeSchemes":"imap,imaps,pop3,pop3s,smtp,smtps","syntax":"imap:host:port","alternativeSyntax":"imap:username:password@host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"Subject":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Subject","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_SUBJECT"},"From":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"From","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_FROM"},"To":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_TO"},"Cc":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CC"},"Bcc":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Bcc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_BCC"},"Reply-To":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reply to","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_REPLY_TO"},"contentType":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CONTENT_TYPE"},"copyTo":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be copied to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_COPY_TO"},"moveTo":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be moved to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MOVE_TO"},"delete":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Deletes the messages after they have been processed.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_DELETE"},"CamelMailMessageId":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message ID.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MESSAGE_ID"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail server host name"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The port number of the mail server"},"closeFolder":{"index":2,"kind":"parameter","displayName":"Close Folder","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keeps the folder open between polls."},"copyTo":{"index":3,"kind":"parameter","displayName":"Copy To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime."},"decodeFilename":{"index":4,"kind":"parameter","displayName":"Decode Filename","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If set to true, the MimeUtility.decodeText method will be used to decode the filename. This is similar to setting JVM system property mail.mime.encodefilename."},"delete":{"index":5,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. You can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not."},"disconnect":{"index":6,"kind":"parameter","displayName":"Disconnect","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should disconnect after polling. If enabled, this forces Camel to connect on each poll."},"handleFailedMessage":{"index":7,"kind":"parameter","displayName":"Handle Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows handling the caused exception by the consumer's error handler. By enabling the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"maxMessagesPerPoll":{"index":8,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option."},"mimeDecodeHeaders":{"index":9,"kind":"parameter","displayName":"Mime Decode Headers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"This option enables transparent MIME decoding and unfolding for mail headers."},"moveTo":{"index":10,"kind":"parameter","displayName":"Move To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be moved to a mail folder with the given name. You can override this configuration value with a header with the key moveTo, allowing you to move messages to folder names configured at runtime."},"peek":{"index":11,"kind":"parameter","displayName":"Peek","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Will mark the jakarta.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek, the mail will not be eagerly marked as SEEN on the mail server, which allows us to roll back the mail message if there is a processing error in Camel."},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skipFailedMessage":{"index":13,"kind":"parameter","displayName":"Skip Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows skipping the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"unseen":{"index":14,"kind":"parameter","displayName":"Unseen","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to limit by unseen mails only."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"failOnDuplicateFileAttachment":{"index":18,"kind":"parameter","displayName":"Fail On Duplicate File Attachment","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to fail processing the mail if the mail message contains attachments with duplicate file names. If set to false, then the duplicate attachment is skipped and a WARN is logged. If set to true, then an exception is thrown failing to process the mail message."},"fetchSize":{"index":19,"kind":"parameter","displayName":"Fetch Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. The default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all."},"folderName":{"index":20,"kind":"parameter","displayName":"Folder Name","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INBOX","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The folder to poll."},"generateMissingAttachmentNames":{"index":21,"kind":"parameter","displayName":"Generate Missing Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set this to 'uuid' to set a UUID for the filename of the attachment if no filename was set"},"handleDuplicateAttachmentNames":{"index":22,"kind":"parameter","displayName":"Handle Duplicate Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set the strategy to handle duplicate filenames of attachments never: attachments that have a filename which is already present in the attachments will be ignored unless failOnDuplicateFileAttachment is set to true. uuidPrefix: this will prefix the duplicate attachment filenames each with an uuid and underscore (uuid_filename.fileextension). uuidSuffix: this will suffix the duplicate attachment filenames each with an underscore and uuid (filename_uuid.fileextension)."},"mailUidGenerator":{"index":23,"kind":"parameter","displayName":"Mail Uid Generator","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailUidGenerator","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message."},"mapMailMessage":{"index":24,"kind":"parameter","displayName":"Map Mail Message","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. If this option is set to false, then the IN message contains a raw jakarta.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(jakarta.mail.Message.class)."},"pollStrategy":{"index":25,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"postProcessAction":{"index":26,"kind":"parameter","displayName":"Post Process Action","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBoxPostProcessAction","deprecated":false,"autowired":false,"secret":false,"description":"Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended."},"bcc":{"index":27,"kind":"parameter","displayName":"Bcc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the BCC email address. Separate multiple email addresses with comma."},"cc":{"index":28,"kind":"parameter","displayName":"Cc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the CC email address. Separate multiple email addresses with comma."},"from":{"index":29,"kind":"parameter","displayName":"From","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel@localhost","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The from email address"},"replyTo":{"index":30,"kind":"parameter","displayName":"Reply To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma."},"subject":{"index":31,"kind":"parameter","displayName":"Subject","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option."},"to":{"index":32,"kind":"parameter","displayName":"To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the destination email address. Separate multiple email addresses with comma."},"javaMailSender":{"index":33,"kind":"parameter","displayName":"Java Mail Sender","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.JavaMailSender","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails."},"lazyStartProducer":{"index":34,"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."},"additionalJavaMailProperties":{"index":35,"kind":"parameter","displayName":"Additional Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","prefix":"mail.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets additional java mail properties, that will append/override any default properties that are set based on all the other options. This is useful if you need to add some special options but want to keep the others as is."},"alternativeBodyHeader":{"index":36,"kind":"parameter","displayName":"Alternative Body Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelMailAlternativeBody","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header."},"attachmentsContentTransferEncodingResolver":{"index":37,"kind":"parameter","displayName":"Attachments Content Transfer Encoding Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments."},"authenticator":{"index":38,"kind":"parameter","displayName":"Authenticator","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailAuthenticator","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The authenticator for login. If set then the password and username are ignored. It can be used for tokens which can expire and therefore must be read dynamically."},"binding":{"index":39,"kind":"parameter","displayName":"Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBinding","deprecated":false,"autowired":false,"secret":false,"description":"Sets the binding used to convert from a Camel message to and from a Mail message"},"connectionTimeout":{"index":40,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The connection timeout in milliseconds."},"contentType":{"index":41,"kind":"parameter","displayName":"Content Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"text/plain","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail message content type. Use text/html for HTML mails."},"contentTypeResolver":{"index":42,"kind":"parameter","displayName":"Content Type Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.ContentTypeResolver","deprecated":false,"autowired":false,"secret":false,"description":"Resolver to determine Content-Type for file attachments."},"debugMode":{"index":43,"kind":"parameter","displayName":"Debug Mode","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default."},"headerFilterStrategy":{"index":44,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."},"ignoreUnsupportedCharset":{"index":45,"kind":"parameter","displayName":"Ignore Unsupported Charset","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"ignoreUriScheme":{"index":46,"kind":"parameter","displayName":"Ignore Uri Scheme","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"javaMailProperties":{"index":47,"kind":"parameter","displayName":"Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the java mail options. Will clear any default properties and only use the properties provided for this method."},"session":{"index":48,"kind":"parameter","displayName":"Session","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.mail.Session","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session)."},"useInlineAttachments":{"index":49,"kind":"parameter","displayName":"Use Inline Attachments","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to use disposition inline or attachment."},"idempotentRepository":{"index":50,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use."},"idempotentRepositoryRemoveOnCommit":{"index":51,"kind":"parameter","displayName":"Idempotent Repository Remove On Commit","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have."},"searchTerm":{"index":52,"kind":"parameter","displayName":"Search Term","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"jakarta.mail.search.SearchTerm","prefix":"searchTerm.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Refers to a jakarta.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc."},"backoffErrorThreshold":{"index":53,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":54,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":55,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":56,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Milliseconds before the next poll."},"greedy":{"index":57,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":58,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":59,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":60,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":61,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":62,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":63,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":64,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":65,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":66,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":67,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The password for login. See also setAuthenticator(MailAuthenticator)."},"sslContextParameters":{"index":68,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters."},"username":{"index":69,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The username for login. See also setAuthenticator(MailAuthenticator)."},"sortTerm":{"index":70,"kind":"parameter","displayName":"Sort Term","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"org.eclipse.angus.mail.imap.SortTerm[]","deprecated":false,"autowired":false,"secret":false,"description":"Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability."}}} +{"component":{"kind":"component","name":"imap","title":"IMAP","description":"Send and receive emails using imap, pop3 and smtp protocols.","deprecated":false,"firstVersion":"1.0.0","label":"mail","javaType":"org.apache.camel.component.mail.MailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mail","version":"4.8.2","scheme":"imap","extendsScheme":"","alternativeSchemes":"imap,imaps,pop3,pop3s,smtp,smtps","syntax":"imap:host:port","alternativeSyntax":"imap:username:password@host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"Subject":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Subject","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_SUBJECT"},"From":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"From","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_FROM"},"To":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_TO"},"Cc":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CC"},"Bcc":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Bcc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_BCC"},"Reply-To":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reply to","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_REPLY_TO"},"contentType":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CONTENT_TYPE"},"copyTo":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be copied to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_COPY_TO"},"moveTo":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be moved to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MOVE_TO"},"delete":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Deletes the messages after they have been processed.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_DELETE"},"CamelMailMessageId":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message ID.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MESSAGE_ID"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail server host name"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The port number of the mail server"},"closeFolder":{"index":2,"kind":"parameter","displayName":"Close Folder","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keeps the folder open between polls."},"copyTo":{"index":3,"kind":"parameter","displayName":"Copy To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime."},"decodeFilename":{"index":4,"kind":"parameter","displayName":"Decode Filename","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If set to true, the MimeUtility.decodeText method will be used to decode the filename. This is similar to setting JVM system property mail.mime.encodefilename."},"delete":{"index":5,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. You can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not."},"disconnect":{"index":6,"kind":"parameter","displayName":"Disconnect","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should disconnect after polling. If enabled, this forces Camel to connect on each poll."},"handleFailedMessage":{"index":7,"kind":"parameter","displayName":"Handle Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows handling the caused exception by the consumer's error handler. By enabling the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"maxMessagesPerPoll":{"index":8,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option."},"mimeDecodeHeaders":{"index":9,"kind":"parameter","displayName":"Mime Decode Headers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"This option enables transparent MIME decoding and unfolding for mail headers."},"moveTo":{"index":10,"kind":"parameter","displayName":"Move To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be moved to a mail folder with the given name. You can override this configuration value with a header with the key moveTo, allowing you to move messages to folder names configured at runtime."},"peek":{"index":11,"kind":"parameter","displayName":"Peek","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Will mark the jakarta.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek, the mail will not be eagerly marked as SEEN on the mail server, which allows us to roll back the mail message if there is a processing error in Camel."},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skipFailedMessage":{"index":13,"kind":"parameter","displayName":"Skip Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows skipping the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"unseen":{"index":14,"kind":"parameter","displayName":"Unseen","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to limit by unseen mails only."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"failOnDuplicateFileAttachment":{"index":18,"kind":"parameter","displayName":"Fail On Duplicate File Attachment","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to fail processing the mail if the mail message contains attachments with duplicate file names. If set to false, then the duplicate attachment is skipped and a WARN is logged. If set to true, then an exception is thrown failing to process the mail message."},"fetchSize":{"index":19,"kind":"parameter","displayName":"Fetch Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. The default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all."},"folderName":{"index":20,"kind":"parameter","displayName":"Folder Name","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INBOX","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The folder to poll."},"generateMissingAttachmentNames":{"index":21,"kind":"parameter","displayName":"Generate Missing Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set this to 'uuid' to set a UUID for the filename of the attachment if no filename was set"},"handleDuplicateAttachmentNames":{"index":22,"kind":"parameter","displayName":"Handle Duplicate Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set the strategy to handle duplicate filenames of attachments never: attachments that have a filename which is already present in the attachments will be ignored unless failOnDuplicateFileAttachment is set to true. uuidPrefix: this will prefix the duplicate attachment filenames each with an uuid and underscore (uuid_filename.fileextension). uuidSuffix: this will suffix the duplicate attachment filenames each with an underscore and uuid (filename_uuid.fileextension)."},"mailUidGenerator":{"index":23,"kind":"parameter","displayName":"Mail Uid Generator","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailUidGenerator","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message."},"mapMailMessage":{"index":24,"kind":"parameter","displayName":"Map Mail Message","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. If this option is set to false, then the IN message contains a raw jakarta.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(jakarta.mail.Message.class)."},"pollStrategy":{"index":25,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"postProcessAction":{"index":26,"kind":"parameter","displayName":"Post Process Action","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBoxPostProcessAction","deprecated":false,"autowired":false,"secret":false,"description":"Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended."},"bcc":{"index":27,"kind":"parameter","displayName":"Bcc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the BCC email address. Separate multiple email addresses with comma."},"cc":{"index":28,"kind":"parameter","displayName":"Cc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the CC email address. Separate multiple email addresses with comma."},"from":{"index":29,"kind":"parameter","displayName":"From","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel@localhost","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The from email address"},"replyTo":{"index":30,"kind":"parameter","displayName":"Reply To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma."},"subject":{"index":31,"kind":"parameter","displayName":"Subject","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option."},"to":{"index":32,"kind":"parameter","displayName":"To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the destination email address. Separate multiple email addresses with comma."},"javaMailSender":{"index":33,"kind":"parameter","displayName":"Java Mail Sender","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.JavaMailSender","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails."},"lazyStartProducer":{"index":34,"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."},"additionalJavaMailProperties":{"index":35,"kind":"parameter","displayName":"Additional Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","prefix":"mail.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets additional java mail properties, that will append/override any default properties that are set based on all the other options. This is useful if you need to add some special options but want to keep the others as is."},"alternativeBodyHeader":{"index":36,"kind":"parameter","displayName":"Alternative Body Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelMailAlternativeBody","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header."},"attachmentsContentTransferEncodingResolver":{"index":37,"kind":"parameter","displayName":"Attachments Content Transfer Encoding Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments."},"authenticator":{"index":38,"kind":"parameter","displayName":"Authenticator","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailAuthenticator","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The authenticator for login. If set then the password and username are ignored. It can be used for tokens which can expire and therefore must be read dynamically."},"binding":{"index":39,"kind":"parameter","displayName":"Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBinding","deprecated":false,"autowired":false,"secret":false,"description":"Sets the binding used to convert from a Camel message to and from a Mail message"},"connectionTimeout":{"index":40,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The connection timeout in milliseconds."},"contentType":{"index":41,"kind":"parameter","displayName":"Content Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"text/plain","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail message content type. Use text/html for HTML mails."},"contentTypeResolver":{"index":42,"kind":"parameter","displayName":"Content Type Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.ContentTypeResolver","deprecated":false,"autowired":false,"secret":false,"description":"Resolver to determine Content-Type for file attachments."},"debugMode":{"index":43,"kind":"parameter","displayName":"Debug Mode","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default."},"headerFilterStrategy":{"index":44,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."},"ignoreUnsupportedCharset":{"index":45,"kind":"parameter","displayName":"Ignore Unsupported Charset","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"ignoreUriScheme":{"index":46,"kind":"parameter","displayName":"Ignore Uri Scheme","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"javaMailProperties":{"index":47,"kind":"parameter","displayName":"Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the java mail options. Will clear any default properties and only use the properties provided for this method."},"session":{"index":48,"kind":"parameter","displayName":"Session","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.mail.Session","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session)."},"useInlineAttachments":{"index":49,"kind":"parameter","displayName":"Use Inline Attachments","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to use disposition inline or attachment."},"idempotentRepository":{"index":50,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use."},"idempotentRepositoryRemoveOnCommit":{"index":51,"kind":"parameter","displayName":"Idempotent Repository Remove On Commit","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have."},"searchTerm":{"index":52,"kind":"parameter","displayName":"Search Term","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"jakarta.mail.search.SearchTerm","prefix":"searchTerm.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Refers to a jakarta.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc."},"backoffErrorThreshold":{"index":53,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":54,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":55,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":56,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Milliseconds before the next poll."},"greedy":{"index":57,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":58,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":59,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":60,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":61,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":62,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":63,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":64,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":65,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":66,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":67,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The password for login. See also setAuthenticator(MailAuthenticator)."},"sslContextParameters":{"index":68,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters."},"username":{"index":69,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The username for login. See also setAuthenticator(MailAuthenticator)."},"sortTerm":{"index":70,"kind":"parameter","displayName":"Sort Term","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"org.eclipse.angus.mail.imap.SortTerm[]","deprecated":false,"autowired":false,"secret":false,"description":"Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability."}}} , -{"component":{"kind":"component","name":"imaps","title":"IMAPS (Secure)","description":"Send and receive emails using imap, pop3 and smtp protocols.","deprecated":false,"firstVersion":"1.0.0","label":"mail","javaType":"org.apache.camel.component.mail.MailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mail","version":"4.8.1","scheme":"imaps","extendsScheme":"","alternativeSchemes":"imap,imaps,pop3,pop3s,smtp,smtps","syntax":"imaps:host:port","alternativeSyntax":"imaps:username:password@host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"Subject":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Subject","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_SUBJECT"},"From":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"From","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_FROM"},"To":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_TO"},"Cc":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CC"},"Bcc":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Bcc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_BCC"},"Reply-To":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reply to","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_REPLY_TO"},"contentType":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CONTENT_TYPE"},"copyTo":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be copied to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_COPY_TO"},"moveTo":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be moved to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MOVE_TO"},"delete":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Deletes the messages after they have been processed.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_DELETE"},"CamelMailMessageId":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message ID.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MESSAGE_ID"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail server host name"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The port number of the mail server"},"closeFolder":{"index":2,"kind":"parameter","displayName":"Close Folder","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keeps the folder open between polls."},"copyTo":{"index":3,"kind":"parameter","displayName":"Copy To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime."},"decodeFilename":{"index":4,"kind":"parameter","displayName":"Decode Filename","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If set to true, the MimeUtility.decodeText method will be used to decode the filename. This is similar to setting JVM system property mail.mime.encodefilename."},"delete":{"index":5,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. You can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not."},"disconnect":{"index":6,"kind":"parameter","displayName":"Disconnect","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should disconnect after polling. If enabled, this forces Camel to connect on each poll."},"handleFailedMessage":{"index":7,"kind":"parameter","displayName":"Handle Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows handling the caused exception by the consumer's error handler. By enabling the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"maxMessagesPerPoll":{"index":8,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option."},"mimeDecodeHeaders":{"index":9,"kind":"parameter","displayName":"Mime Decode Headers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"This option enables transparent MIME decoding and unfolding for mail headers."},"moveTo":{"index":10,"kind":"parameter","displayName":"Move To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be moved to a mail folder with the given name. You can override this configuration value with a header with the key moveTo, allowing you to move messages to folder names configured at runtime."},"peek":{"index":11,"kind":"parameter","displayName":"Peek","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Will mark the jakarta.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek, the mail will not be eagerly marked as SEEN on the mail server, which allows us to roll back the mail message if there is a processing error in Camel."},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skipFailedMessage":{"index":13,"kind":"parameter","displayName":"Skip Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows skipping the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"unseen":{"index":14,"kind":"parameter","displayName":"Unseen","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to limit by unseen mails only."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"failOnDuplicateFileAttachment":{"index":18,"kind":"parameter","displayName":"Fail On Duplicate File Attachment","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to fail processing the mail if the mail message contains attachments with duplicate file names. If set to false, then the duplicate attachment is skipped and a WARN is logged. If set to true, then an exception is thrown failing to process the mail message."},"fetchSize":{"index":19,"kind":"parameter","displayName":"Fetch Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. The default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all."},"folderName":{"index":20,"kind":"parameter","displayName":"Folder Name","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INBOX","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The folder to poll."},"generateMissingAttachmentNames":{"index":21,"kind":"parameter","displayName":"Generate Missing Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set this to 'uuid' to set a UUID for the filename of the attachment if no filename was set"},"handleDuplicateAttachmentNames":{"index":22,"kind":"parameter","displayName":"Handle Duplicate Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set the strategy to handle duplicate filenames of attachments never: attachments that have a filename which is already present in the attachments will be ignored unless failOnDuplicateFileAttachment is set to true. uuidPrefix: this will prefix the duplicate attachment filenames each with an uuid and underscore (uuid_filename.fileextension). uuidSuffix: this will suffix the duplicate attachment filenames each with an underscore and uuid (filename_uuid.fileextension)."},"mailUidGenerator":{"index":23,"kind":"parameter","displayName":"Mail Uid Generator","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailUidGenerator","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message."},"mapMailMessage":{"index":24,"kind":"parameter","displayName":"Map Mail Message","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. If this option is set to false, then the IN message contains a raw jakarta.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(jakarta.mail.Message.class)."},"pollStrategy":{"index":25,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"postProcessAction":{"index":26,"kind":"parameter","displayName":"Post Process Action","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBoxPostProcessAction","deprecated":false,"autowired":false,"secret":false,"description":"Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended."},"bcc":{"index":27,"kind":"parameter","displayName":"Bcc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the BCC email address. Separate multiple email addresses with comma."},"cc":{"index":28,"kind":"parameter","displayName":"Cc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the CC email address. Separate multiple email addresses with comma."},"from":{"index":29,"kind":"parameter","displayName":"From","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel@localhost","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The from email address"},"replyTo":{"index":30,"kind":"parameter","displayName":"Reply To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma."},"subject":{"index":31,"kind":"parameter","displayName":"Subject","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option."},"to":{"index":32,"kind":"parameter","displayName":"To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the destination email address. Separate multiple email addresses with comma."},"javaMailSender":{"index":33,"kind":"parameter","displayName":"Java Mail Sender","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.JavaMailSender","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails."},"lazyStartProducer":{"index":34,"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."},"additionalJavaMailProperties":{"index":35,"kind":"parameter","displayName":"Additional Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","prefix":"mail.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets additional java mail properties, that will append/override any default properties that are set based on all the other options. This is useful if you need to add some special options but want to keep the others as is."},"alternativeBodyHeader":{"index":36,"kind":"parameter","displayName":"Alternative Body Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelMailAlternativeBody","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header."},"attachmentsContentTransferEncodingResolver":{"index":37,"kind":"parameter","displayName":"Attachments Content Transfer Encoding Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments."},"authenticator":{"index":38,"kind":"parameter","displayName":"Authenticator","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailAuthenticator","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The authenticator for login. If set then the password and username are ignored. It can be used for tokens which can expire and therefore must be read dynamically."},"binding":{"index":39,"kind":"parameter","displayName":"Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBinding","deprecated":false,"autowired":false,"secret":false,"description":"Sets the binding used to convert from a Camel message to and from a Mail message"},"connectionTimeout":{"index":40,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The connection timeout in milliseconds."},"contentType":{"index":41,"kind":"parameter","displayName":"Content Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"text/plain","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail message content type. Use text/html for HTML mails."},"contentTypeResolver":{"index":42,"kind":"parameter","displayName":"Content Type Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.ContentTypeResolver","deprecated":false,"autowired":false,"secret":false,"description":"Resolver to determine Content-Type for file attachments."},"debugMode":{"index":43,"kind":"parameter","displayName":"Debug Mode","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default."},"headerFilterStrategy":{"index":44,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."},"ignoreUnsupportedCharset":{"index":45,"kind":"parameter","displayName":"Ignore Unsupported Charset","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"ignoreUriScheme":{"index":46,"kind":"parameter","displayName":"Ignore Uri Scheme","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"javaMailProperties":{"index":47,"kind":"parameter","displayName":"Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the java mail options. Will clear any default properties and only use the properties provided for this method."},"session":{"index":48,"kind":"parameter","displayName":"Session","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.mail.Session","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session)."},"useInlineAttachments":{"index":49,"kind":"parameter","displayName":"Use Inline Attachments","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to use disposition inline or attachment."},"idempotentRepository":{"index":50,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use."},"idempotentRepositoryRemoveOnCommit":{"index":51,"kind":"parameter","displayName":"Idempotent Repository Remove On Commit","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have."},"searchTerm":{"index":52,"kind":"parameter","displayName":"Search Term","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"jakarta.mail.search.SearchTerm","prefix":"searchTerm.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Refers to a jakarta.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc."},"backoffErrorThreshold":{"index":53,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":54,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":55,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":56,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Milliseconds before the next poll."},"greedy":{"index":57,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":58,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":59,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":60,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":61,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":62,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":63,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":64,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":65,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":66,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":67,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The password for login. See also setAuthenticator(MailAuthenticator)."},"sslContextParameters":{"index":68,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters."},"username":{"index":69,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The username for login. See also setAuthenticator(MailAuthenticator)."},"sortTerm":{"index":70,"kind":"parameter","displayName":"Sort Term","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"org.eclipse.angus.mail.imap.SortTerm[]","deprecated":false,"autowired":false,"secret":false,"description":"Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability."}}} +{"component":{"kind":"component","name":"imaps","title":"IMAPS (Secure)","description":"Send and receive emails using imap, pop3 and smtp protocols.","deprecated":false,"firstVersion":"1.0.0","label":"mail","javaType":"org.apache.camel.component.mail.MailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mail","version":"4.8.2","scheme":"imaps","extendsScheme":"","alternativeSchemes":"imap,imaps,pop3,pop3s,smtp,smtps","syntax":"imaps:host:port","alternativeSyntax":"imaps:username:password@host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"Subject":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Subject","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_SUBJECT"},"From":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"From","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_FROM"},"To":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_TO"},"Cc":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CC"},"Bcc":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Bcc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_BCC"},"Reply-To":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reply to","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_REPLY_TO"},"contentType":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CONTENT_TYPE"},"copyTo":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be copied to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_COPY_TO"},"moveTo":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be moved to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MOVE_TO"},"delete":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Deletes the messages after they have been processed.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_DELETE"},"CamelMailMessageId":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message ID.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MESSAGE_ID"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail server host name"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The port number of the mail server"},"closeFolder":{"index":2,"kind":"parameter","displayName":"Close Folder","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keeps the folder open between polls."},"copyTo":{"index":3,"kind":"parameter","displayName":"Copy To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime."},"decodeFilename":{"index":4,"kind":"parameter","displayName":"Decode Filename","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If set to true, the MimeUtility.decodeText method will be used to decode the filename. This is similar to setting JVM system property mail.mime.encodefilename."},"delete":{"index":5,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. You can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not."},"disconnect":{"index":6,"kind":"parameter","displayName":"Disconnect","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should disconnect after polling. If enabled, this forces Camel to connect on each poll."},"handleFailedMessage":{"index":7,"kind":"parameter","displayName":"Handle Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows handling the caused exception by the consumer's error handler. By enabling the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"maxMessagesPerPoll":{"index":8,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option."},"mimeDecodeHeaders":{"index":9,"kind":"parameter","displayName":"Mime Decode Headers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"This option enables transparent MIME decoding and unfolding for mail headers."},"moveTo":{"index":10,"kind":"parameter","displayName":"Move To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be moved to a mail folder with the given name. You can override this configuration value with a header with the key moveTo, allowing you to move messages to folder names configured at runtime."},"peek":{"index":11,"kind":"parameter","displayName":"Peek","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Will mark the jakarta.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek, the mail will not be eagerly marked as SEEN on the mail server, which allows us to roll back the mail message if there is a processing error in Camel."},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skipFailedMessage":{"index":13,"kind":"parameter","displayName":"Skip Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows skipping the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"unseen":{"index":14,"kind":"parameter","displayName":"Unseen","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to limit by unseen mails only."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"failOnDuplicateFileAttachment":{"index":18,"kind":"parameter","displayName":"Fail On Duplicate File Attachment","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to fail processing the mail if the mail message contains attachments with duplicate file names. If set to false, then the duplicate attachment is skipped and a WARN is logged. If set to true, then an exception is thrown failing to process the mail message."},"fetchSize":{"index":19,"kind":"parameter","displayName":"Fetch Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. The default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all."},"folderName":{"index":20,"kind":"parameter","displayName":"Folder Name","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INBOX","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The folder to poll."},"generateMissingAttachmentNames":{"index":21,"kind":"parameter","displayName":"Generate Missing Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set this to 'uuid' to set a UUID for the filename of the attachment if no filename was set"},"handleDuplicateAttachmentNames":{"index":22,"kind":"parameter","displayName":"Handle Duplicate Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set the strategy to handle duplicate filenames of attachments never: attachments that have a filename which is already present in the attachments will be ignored unless failOnDuplicateFileAttachment is set to true. uuidPrefix: this will prefix the duplicate attachment filenames each with an uuid and underscore (uuid_filename.fileextension). uuidSuffix: this will suffix the duplicate attachment filenames each with an underscore and uuid (filename_uuid.fileextension)."},"mailUidGenerator":{"index":23,"kind":"parameter","displayName":"Mail Uid Generator","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailUidGenerator","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message."},"mapMailMessage":{"index":24,"kind":"parameter","displayName":"Map Mail Message","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. If this option is set to false, then the IN message contains a raw jakarta.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(jakarta.mail.Message.class)."},"pollStrategy":{"index":25,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"postProcessAction":{"index":26,"kind":"parameter","displayName":"Post Process Action","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBoxPostProcessAction","deprecated":false,"autowired":false,"secret":false,"description":"Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended."},"bcc":{"index":27,"kind":"parameter","displayName":"Bcc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the BCC email address. Separate multiple email addresses with comma."},"cc":{"index":28,"kind":"parameter","displayName":"Cc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the CC email address. Separate multiple email addresses with comma."},"from":{"index":29,"kind":"parameter","displayName":"From","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel@localhost","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The from email address"},"replyTo":{"index":30,"kind":"parameter","displayName":"Reply To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma."},"subject":{"index":31,"kind":"parameter","displayName":"Subject","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option."},"to":{"index":32,"kind":"parameter","displayName":"To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the destination email address. Separate multiple email addresses with comma."},"javaMailSender":{"index":33,"kind":"parameter","displayName":"Java Mail Sender","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.JavaMailSender","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails."},"lazyStartProducer":{"index":34,"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."},"additionalJavaMailProperties":{"index":35,"kind":"parameter","displayName":"Additional Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","prefix":"mail.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets additional java mail properties, that will append/override any default properties that are set based on all the other options. This is useful if you need to add some special options but want to keep the others as is."},"alternativeBodyHeader":{"index":36,"kind":"parameter","displayName":"Alternative Body Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelMailAlternativeBody","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header."},"attachmentsContentTransferEncodingResolver":{"index":37,"kind":"parameter","displayName":"Attachments Content Transfer Encoding Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments."},"authenticator":{"index":38,"kind":"parameter","displayName":"Authenticator","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailAuthenticator","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The authenticator for login. If set then the password and username are ignored. It can be used for tokens which can expire and therefore must be read dynamically."},"binding":{"index":39,"kind":"parameter","displayName":"Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBinding","deprecated":false,"autowired":false,"secret":false,"description":"Sets the binding used to convert from a Camel message to and from a Mail message"},"connectionTimeout":{"index":40,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The connection timeout in milliseconds."},"contentType":{"index":41,"kind":"parameter","displayName":"Content Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"text/plain","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail message content type. Use text/html for HTML mails."},"contentTypeResolver":{"index":42,"kind":"parameter","displayName":"Content Type Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.ContentTypeResolver","deprecated":false,"autowired":false,"secret":false,"description":"Resolver to determine Content-Type for file attachments."},"debugMode":{"index":43,"kind":"parameter","displayName":"Debug Mode","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default."},"headerFilterStrategy":{"index":44,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."},"ignoreUnsupportedCharset":{"index":45,"kind":"parameter","displayName":"Ignore Unsupported Charset","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"ignoreUriScheme":{"index":46,"kind":"parameter","displayName":"Ignore Uri Scheme","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"javaMailProperties":{"index":47,"kind":"parameter","displayName":"Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the java mail options. Will clear any default properties and only use the properties provided for this method."},"session":{"index":48,"kind":"parameter","displayName":"Session","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.mail.Session","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session)."},"useInlineAttachments":{"index":49,"kind":"parameter","displayName":"Use Inline Attachments","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to use disposition inline or attachment."},"idempotentRepository":{"index":50,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use."},"idempotentRepositoryRemoveOnCommit":{"index":51,"kind":"parameter","displayName":"Idempotent Repository Remove On Commit","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have."},"searchTerm":{"index":52,"kind":"parameter","displayName":"Search Term","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"jakarta.mail.search.SearchTerm","prefix":"searchTerm.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Refers to a jakarta.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc."},"backoffErrorThreshold":{"index":53,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":54,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":55,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":56,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Milliseconds before the next poll."},"greedy":{"index":57,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":58,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":59,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":60,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":61,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":62,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":63,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":64,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":65,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":66,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":67,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The password for login. See also setAuthenticator(MailAuthenticator)."},"sslContextParameters":{"index":68,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters."},"username":{"index":69,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The username for login. See also setAuthenticator(MailAuthenticator)."},"sortTerm":{"index":70,"kind":"parameter","displayName":"Sort Term","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"org.eclipse.angus.mail.imap.SortTerm[]","deprecated":false,"autowired":false,"secret":false,"description":"Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability."}}} , -{"component":{"kind":"component","name":"infinispan","title":"Infinispan","description":"Read and write from/to Infinispan distributed key/value store and data grid.","deprecated":false,"firstVersion":"2.13.0","label":"cache,clustering","javaType":"org.apache.camel.component.infinispan.remote.InfinispanRemoteComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-infinispan","version":"4.8.1","scheme":"infinispan","extendsScheme":"","syntax":"infinispan:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelInfinispanEventType":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the received event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#EVENT_TYPE"},"CamelInfinispanCacheName":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cache participating in the operation or event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#CACHE_NAME"},"CamelInfinispanKey":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key to perform the operation to or the key generating the event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#KEY"},"CamelInfinispanValue":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value to use for the operation.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#VALUE"},"CamelInfinispanDefaultValue":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The default value to use for a getOrDefault.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#DEFAULT_VALUE"},"CamelInfinispanOldValue":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value to use for a replace.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#OLD_VALUE"},"CamelInfinispanMap":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Map to use in case of CamelInfinispanOperationPutAll operation","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAP"},"CamelInfinispanOperation":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.infinispan.InfinispanOperation","enum":["PUT","PUTASYNC","PUTALL","PUTALLASYNC","PUTIFABSENT","PUTIFABSENTASYNC","GET","GETORDEFAULT","CONTAINSKEY","CONTAINSVALUE","REMOVE","REMOVEASYNC","REPLACE","REPLACEASYNC","SIZE","CLEAR","CLEARASYNC","QUERY","STATS","COMPUTE","COMPUTEASYNC"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#OPERATION"},"CamelInfinispanOperationResult":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the header whose value is the result","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#RESULT"},"CamelInfinispanOperationResultHeader":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Store the operation result in a header instead of the message body","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#RESULT_HEADER"},"CamelInfinispanLifespanTime":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Lifespan time of a value inside the cache. Negative values are interpreted as infinity.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#LIFESPAN_TIME"},"CamelInfinispanTimeUnit":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Time Unit of an entry Lifespan Time.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#LIFESPAN_TIME_UNIT"},"CamelInfinispanMaxIdleTime":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum amount of time an entry is allowed to be idle for before it is considered as expired.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAX_IDLE_TIME"},"CamelInfinispanMaxIdleTimeUnit":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Time Unit of an entry Max Idle Time.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAX_IDLE_TIME_UNIT"},"CamelInfinispanEventData":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event data.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#EVENT_DATA"},"CamelInfinispanQueryBuilder":{"index":15,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.infinispan.InfinispanQueryBuilder","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The QueryBuilder to use for QUERY command, if not present the command defaults to InifinispanConfiguration's one","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#QUERY_BUILDER"},"CamelInfinispanEntryVersion":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Provides access to the version of the created cache entry.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#ENTRY_VERSION"},"CamelInfinispanCommandRetried":{"index":17,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This will be true if the write command that caused this had to be retried again due to a topology change.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#COMMAND_RETRIED"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache to use. Use current to use the existing cache name from the currently configured cached manager. Or use default for the default cache manager name."},"hosts":{"index":1,"kind":"parameter","displayName":"Hosts","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Specifies the host of the cache on Infinispan instance. Multiple hosts can be separated by semicolon."},"queryBuilder":{"index":2,"kind":"parameter","displayName":"Query Builder","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.InfinispanQueryBuilder","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Specifies the query builder."},"customListener":{"index":3,"kind":"parameter","displayName":"Custom Listener","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.remote.InfinispanRemoteCustomListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Returns the custom listener in use, if provided"},"eventTypes":{"index":4,"kind":"parameter","displayName":"Event Types","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Specifies the set of event types to register by the consumer.Multiple event can be separated by comma. The possible event types are: CLIENT_CACHE_ENTRY_CREATED, CLIENT_CACHE_ENTRY_MODIFIED, CLIENT_CACHE_ENTRY_REMOVED, CLIENT_CACHE_ENTRY_EXPIRED, CLIENT_CACHE_FAILOVER"},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"defaultValue":{"index":8,"kind":"parameter","displayName":"Default Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific default value for some producer operations"},"key":{"index":9,"kind":"parameter","displayName":"Key","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific key for producer operations"},"oldValue":{"index":10,"kind":"parameter","displayName":"Old Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific old value for some producer operations"},"operation":{"index":11,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.InfinispanOperation","enum":["PUT","PUTASYNC","PUTALL","PUTALLASYNC","PUTIFABSENT","PUTIFABSENTASYNC","GET","GETORDEFAULT","CONTAINSKEY","CONTAINSVALUE","REMOVE","REMOVEASYNC","REPLACE","REPLACEASYNC","SIZE","CLEAR","CLEARASYNC","QUERY","STATS","COMPUTE","COMPUTEASYNC"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PUT","configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"The operation to perform"},"value":{"index":12,"kind":"parameter","displayName":"Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific value for producer operations"},"lazyStartProducer":{"index":13,"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."},"cacheContainer":{"index":14,"kind":"parameter","displayName":"Cache Container","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.infinispan.client.hotrod.RemoteCacheManager","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Specifies the cache Container to connect"},"cacheContainerConfiguration":{"index":15,"kind":"parameter","displayName":"Cache Container Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.infinispan.client.hotrod.configuration.Configuration","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"The CacheContainer configuration. Used if the cacheContainer is not defined."},"configurationProperties":{"index":16,"kind":"parameter","displayName":"Configuration Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Implementation specific properties for the CacheManager"},"configurationUri":{"index":17,"kind":"parameter","displayName":"Configuration Uri","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"An implementation specific URI for the CacheManager"},"flags":{"index":18,"kind":"parameter","displayName":"Flags","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"A comma separated list of org.infinispan.client.hotrod.Flag to be applied by default on each cache invocation."},"remappingFunction":{"index":19,"kind":"parameter","displayName":"Remapping Function","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.function.BiFunction","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific remappingFunction to use in a compute operation."},"resultHeader":{"index":20,"kind":"parameter","displayName":"Result Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Store the operation result in a header instead of the message body. By default, resultHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If resultHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. This value can be overridden by an in message header named: CamelInfinispanOperationResultHeader"},"password":{"index":21,"kind":"parameter","displayName":"Password","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the password to access the infinispan instance"},"saslMechanism":{"index":22,"kind":"parameter","displayName":"Sasl Mechanism","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the SASL Mechanism to access the infinispan instance"},"secure":{"index":23,"kind":"parameter","displayName":"Secure","group":"security","label":"common,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define if we are connecting to a secured Infinispan instance"},"securityRealm":{"index":24,"kind":"parameter","displayName":"Security Realm","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the security realm to access the infinispan instance"},"securityServerName":{"index":25,"kind":"parameter","displayName":"Security Server Name","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the security server name to access the infinispan instance"},"username":{"index":26,"kind":"parameter","displayName":"Username","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the username to access the infinispan instance"}}} +{"component":{"kind":"component","name":"infinispan","title":"Infinispan","description":"Read and write from/to Infinispan distributed key/value store and data grid.","deprecated":false,"firstVersion":"2.13.0","label":"cache,clustering","javaType":"org.apache.camel.component.infinispan.remote.InfinispanRemoteComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-infinispan","version":"4.8.2","scheme":"infinispan","extendsScheme":"","syntax":"infinispan:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelInfinispanEventType":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the received event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#EVENT_TYPE"},"CamelInfinispanCacheName":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cache participating in the operation or event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#CACHE_NAME"},"CamelInfinispanKey":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key to perform the operation to or the key generating the event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#KEY"},"CamelInfinispanValue":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value to use for the operation.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#VALUE"},"CamelInfinispanDefaultValue":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The default value to use for a getOrDefault.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#DEFAULT_VALUE"},"CamelInfinispanOldValue":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value to use for a replace.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#OLD_VALUE"},"CamelInfinispanMap":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Map to use in case of CamelInfinispanOperationPutAll operation","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAP"},"CamelInfinispanOperation":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.infinispan.InfinispanOperation","enum":["PUT","PUTASYNC","PUTALL","PUTALLASYNC","PUTIFABSENT","PUTIFABSENTASYNC","GET","GETORDEFAULT","CONTAINSKEY","CONTAINSVALUE","REMOVE","REMOVEASYNC","REPLACE","REPLACEASYNC","SIZE","CLEAR","CLEARASYNC","QUERY","STATS","COMPUTE","COMPUTEASYNC"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#OPERATION"},"CamelInfinispanOperationResult":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the header whose value is the result","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#RESULT"},"CamelInfinispanOperationResultHeader":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Store the operation result in a header instead of the message body","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#RESULT_HEADER"},"CamelInfinispanLifespanTime":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Lifespan time of a value inside the cache. Negative values are interpreted as infinity.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#LIFESPAN_TIME"},"CamelInfinispanTimeUnit":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Time Unit of an entry Lifespan Time.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#LIFESPAN_TIME_UNIT"},"CamelInfinispanMaxIdleTime":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum amount of time an entry is allowed to be idle for before it is considered as expired.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAX_IDLE_TIME"},"CamelInfinispanMaxIdleTimeUnit":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Time Unit of an entry Max Idle Time.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAX_IDLE_TIME_UNIT"},"CamelInfinispanEventData":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event data.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#EVENT_DATA"},"CamelInfinispanQueryBuilder":{"index":15,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.infinispan.InfinispanQueryBuilder","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The QueryBuilder to use for QUERY command, if not present the command defaults to InifinispanConfiguration's one","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#QUERY_BUILDER"},"CamelInfinispanEntryVersion":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Provides access to the version of the created cache entry.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#ENTRY_VERSION"},"CamelInfinispanCommandRetried":{"index":17,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This will be true if the write command that caused this had to be retried again due to a topology change.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#COMMAND_RETRIED"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache to use. Use current to use the existing cache name from the currently configured cached manager. Or use default for the default cache manager name."},"hosts":{"index":1,"kind":"parameter","displayName":"Hosts","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Specifies the host of the cache on Infinispan instance. Multiple hosts can be separated by semicolon."},"queryBuilder":{"index":2,"kind":"parameter","displayName":"Query Builder","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.InfinispanQueryBuilder","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Specifies the query builder."},"customListener":{"index":3,"kind":"parameter","displayName":"Custom Listener","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.remote.InfinispanRemoteCustomListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Returns the custom listener in use, if provided"},"eventTypes":{"index":4,"kind":"parameter","displayName":"Event Types","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Specifies the set of event types to register by the consumer.Multiple event can be separated by comma. The possible event types are: CLIENT_CACHE_ENTRY_CREATED, CLIENT_CACHE_ENTRY_MODIFIED, CLIENT_CACHE_ENTRY_REMOVED, CLIENT_CACHE_ENTRY_EXPIRED, CLIENT_CACHE_FAILOVER"},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"defaultValue":{"index":8,"kind":"parameter","displayName":"Default Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific default value for some producer operations"},"key":{"index":9,"kind":"parameter","displayName":"Key","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific key for producer operations"},"oldValue":{"index":10,"kind":"parameter","displayName":"Old Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific old value for some producer operations"},"operation":{"index":11,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.InfinispanOperation","enum":["PUT","PUTASYNC","PUTALL","PUTALLASYNC","PUTIFABSENT","PUTIFABSENTASYNC","GET","GETORDEFAULT","CONTAINSKEY","CONTAINSVALUE","REMOVE","REMOVEASYNC","REPLACE","REPLACEASYNC","SIZE","CLEAR","CLEARASYNC","QUERY","STATS","COMPUTE","COMPUTEASYNC"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PUT","configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"The operation to perform"},"value":{"index":12,"kind":"parameter","displayName":"Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific value for producer operations"},"lazyStartProducer":{"index":13,"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."},"cacheContainer":{"index":14,"kind":"parameter","displayName":"Cache Container","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.infinispan.client.hotrod.RemoteCacheManager","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Specifies the cache Container to connect"},"cacheContainerConfiguration":{"index":15,"kind":"parameter","displayName":"Cache Container Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.infinispan.client.hotrod.configuration.Configuration","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"The CacheContainer configuration. Used if the cacheContainer is not defined."},"configurationProperties":{"index":16,"kind":"parameter","displayName":"Configuration Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Implementation specific properties for the CacheManager"},"configurationUri":{"index":17,"kind":"parameter","displayName":"Configuration Uri","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"An implementation specific URI for the CacheManager"},"flags":{"index":18,"kind":"parameter","displayName":"Flags","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"A comma separated list of org.infinispan.client.hotrod.Flag to be applied by default on each cache invocation."},"remappingFunction":{"index":19,"kind":"parameter","displayName":"Remapping Function","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.function.BiFunction","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific remappingFunction to use in a compute operation."},"resultHeader":{"index":20,"kind":"parameter","displayName":"Result Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Store the operation result in a header instead of the message body. By default, resultHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If resultHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. This value can be overridden by an in message header named: CamelInfinispanOperationResultHeader"},"password":{"index":21,"kind":"parameter","displayName":"Password","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the password to access the infinispan instance"},"saslMechanism":{"index":22,"kind":"parameter","displayName":"Sasl Mechanism","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the SASL Mechanism to access the infinispan instance"},"secure":{"index":23,"kind":"parameter","displayName":"Secure","group":"security","label":"common,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define if we are connecting to a secured Infinispan instance"},"securityRealm":{"index":24,"kind":"parameter","displayName":"Security Realm","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the security realm to access the infinispan instance"},"securityServerName":{"index":25,"kind":"parameter","displayName":"Security Server Name","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the security server name to access the infinispan instance"},"username":{"index":26,"kind":"parameter","displayName":"Username","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the username to access the infinispan instance"}}} , -{"component":{"kind":"component","name":"infinispan-embedded","title":"Infinispan Embedded","description":"Read and write from/to Infinispan distributed key/value store and data grid.","deprecated":false,"firstVersion":"2.13.0","label":"cache,clustering","javaType":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-infinispan-embedded","version":"4.8.1","scheme":"infinispan-embedded","extendsScheme":"","syntax":"infinispan-embedded:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelInfinispanEventType":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the received event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#EVENT_TYPE"},"CamelInfinispanIsPre":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"true if the notification is before the event has occurred, false if after the event has occurred.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#IS_PRE"},"CamelInfinispanCacheName":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cache participating in the operation or event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#CACHE_NAME"},"CamelInfinispanKey":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key to perform the operation to or the key generating the event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#KEY"},"CamelInfinispanValue":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value to use for the operation.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#VALUE"},"CamelInfinispanDefaultValue":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The default value to use for a getOrDefault.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#DEFAULT_VALUE"},"CamelInfinispanOldValue":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value to use for a replace.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#OLD_VALUE"},"CamelInfinispanMap":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Map to use in case of CamelInfinispanOperationPutAll operation","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAP"},"CamelInfinispanOperation":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.infinispan.InfinispanOperation","enum":["PUT","PUTASYNC","PUTALL","PUTALLASYNC","PUTIFABSENT","PUTIFABSENTASYNC","GET","GETORDEFAULT","CONTAINSKEY","CONTAINSVALUE","REMOVE","REMOVEASYNC","REPLACE","REPLACEASYNC","SIZE","CLEAR","CLEARASYNC","QUERY","STATS","COMPUTE","COMPUTEASYNC"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#OPERATION"},"CamelInfinispanOperationResult":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the header whose value is the result","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#RESULT"},"CamelInfinispanOperationResultHeader":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Store the operation result in a header instead of the message body","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#RESULT_HEADER"},"CamelInfinispanLifespanTime":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Lifespan time of a value inside the cache. Negative values are interpreted as infinity.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#LIFESPAN_TIME"},"CamelInfinispanTimeUnit":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Time Unit of an entry Lifespan Time.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#LIFESPAN_TIME_UNIT"},"CamelInfinispanMaxIdleTime":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum amount of time an entry is allowed to be idle for before it is considered as expired.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAX_IDLE_TIME"},"CamelInfinispanMaxIdleTimeUnit":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Time Unit of an entry Max Idle Time.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAX_IDLE_TIME_UNIT"},"CamelInfinispanIgnoreReturnValues":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Signals that a write operation's return value will be ignored, so reading the existing value from a store or from a remote node is not necessary.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#IGNORE_RETURN_VALUES"},"CamelInfinispanEventData":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event data.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#EVENT_DATA"},"CamelInfinispanQueryBuilder":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.infinispan.InfinispanQueryBuilder","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The QueryBuilder to use for QUERY command, if not present the command defaults to InifinispanConfiguration's one","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#QUERY_BUILDER"},"CamelInfinispanCommandRetried":{"index":18,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This will be true if the write command that caused this had to be retried again due to a topology change.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#COMMAND_RETRIED"},"CamelInfinispanEntryCreated":{"index":19,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates whether the cache entry modification event is the result of the cache entry being created.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#ENTRY_CREATED"},"CamelInfinispanOriginLocal":{"index":20,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"true if the call originated on the local cache instance; false if originated from a remote one.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#ORIGIN_LOCAL"},"CamelInfinispanCurrentState":{"index":21,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"True if this event is generated from an existing entry as the listener has Listener.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#CURRENT_STATE"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache to use. Use current to use the existing cache name from the currently configured cached manager. Or use default for the default cache manager name."},"queryBuilder":{"index":1,"kind":"parameter","displayName":"Query Builder","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.InfinispanQueryBuilder","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Specifies the query builder."},"clusteredListener":{"index":2,"kind":"parameter","displayName":"Clustered Listener","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"If true, the listener will be installed for the entire cluster"},"customListener":{"index":3,"kind":"parameter","displayName":"Custom Listener","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedCustomListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Returns the custom listener in use, if provided"},"eventTypes":{"index":4,"kind":"parameter","displayName":"Event Types","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Specifies the set of event types to register by the consumer.Multiple event can be separated by comma. The possible event types are: CACHE_ENTRY_ACTIVATED, CACHE_ENTRY_PASSIVATED, CACHE_ENTRY_VISITED, CACHE_ENTRY_LOADED, CACHE_ENTRY_EVICTED, CACHE_ENTRY_CREATED, CACHE_ENTRY_REMOVED, CACHE_ENTRY_MODIFIED, TRANSACTION_COMPLETED, TRANSACTION_REGISTERED, CACHE_ENTRY_INVALIDATED, CACHE_ENTRY_EXPIRED, DATA_REHASHED, TOPOLOGY_CHANGED, PARTITION_STATUS_CHANGED, PERSISTENCE_AVAILABILITY_CHANGED"},"sync":{"index":5,"kind":"parameter","displayName":"Sync","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"If true, the consumer will receive notifications synchronously"},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"defaultValue":{"index":9,"kind":"parameter","displayName":"Default Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Set a specific default value for some producer operations"},"key":{"index":10,"kind":"parameter","displayName":"Key","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Set a specific key for producer operations"},"oldValue":{"index":11,"kind":"parameter","displayName":"Old Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Set a specific old value for some producer operations"},"operation":{"index":12,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.InfinispanOperation","enum":["PUT","PUTASYNC","PUTALL","PUTALLASYNC","PUTIFABSENT","PUTIFABSENTASYNC","GET","GETORDEFAULT","CONTAINSKEY","CONTAINSVALUE","REMOVE","REMOVEASYNC","REPLACE","REPLACEASYNC","SIZE","CLEAR","CLEARASYNC","QUERY","STATS","COMPUTE","COMPUTEASYNC"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PUT","configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"The operation to perform"},"value":{"index":13,"kind":"parameter","displayName":"Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Set a specific value for producer operations"},"lazyStartProducer":{"index":14,"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."},"cacheContainer":{"index":15,"kind":"parameter","displayName":"Cache Container","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.infinispan.manager.EmbeddedCacheManager","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Specifies the cache Container to connect"},"cacheContainerConfiguration":{"index":16,"kind":"parameter","displayName":"Cache Container Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.infinispan.configuration.cache.Configuration","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"The CacheContainer configuration. Used if the cacheContainer is not defined."},"configurationUri":{"index":17,"kind":"parameter","displayName":"Configuration Uri","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"An implementation specific URI for the CacheManager"},"flags":{"index":18,"kind":"parameter","displayName":"Flags","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"A comma separated list of org.infinispan.context.Flag to be applied by default on each cache invocation"},"remappingFunction":{"index":19,"kind":"parameter","displayName":"Remapping Function","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.function.BiFunction","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Set a specific remappingFunction to use in a compute operation."},"resultHeader":{"index":20,"kind":"parameter","displayName":"Result Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Store the operation result in a header instead of the message body. By default, resultHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If resultHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. This value can be overridden by an in message header named: CamelInfinispanOperationResultHeader"}}} +{"component":{"kind":"component","name":"infinispan-embedded","title":"Infinispan Embedded","description":"Read and write from/to Infinispan distributed key/value store and data grid.","deprecated":false,"firstVersion":"2.13.0","label":"cache,clustering","javaType":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-infinispan-embedded","version":"4.8.2","scheme":"infinispan-embedded","extendsScheme":"","syntax":"infinispan-embedded:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelInfinispanEventType":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the received event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#EVENT_TYPE"},"CamelInfinispanIsPre":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"true if the notification is before the event has occurred, false if after the event has occurred.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#IS_PRE"},"CamelInfinispanCacheName":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cache participating in the operation or event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#CACHE_NAME"},"CamelInfinispanKey":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key to perform the operation to or the key generating the event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#KEY"},"CamelInfinispanValue":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value to use for the operation.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#VALUE"},"CamelInfinispanDefaultValue":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The default value to use for a getOrDefault.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#DEFAULT_VALUE"},"CamelInfinispanOldValue":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value to use for a replace.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#OLD_VALUE"},"CamelInfinispanMap":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Map to use in case of CamelInfinispanOperationPutAll operation","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAP"},"CamelInfinispanOperation":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.infinispan.InfinispanOperation","enum":["PUT","PUTASYNC","PUTALL","PUTALLASYNC","PUTIFABSENT","PUTIFABSENTASYNC","GET","GETORDEFAULT","CONTAINSKEY","CONTAINSVALUE","REMOVE","REMOVEASYNC","REPLACE","REPLACEASYNC","SIZE","CLEAR","CLEARASYNC","QUERY","STATS","COMPUTE","COMPUTEASYNC"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#OPERATION"},"CamelInfinispanOperationResult":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the header whose value is the result","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#RESULT"},"CamelInfinispanOperationResultHeader":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Store the operation result in a header instead of the message body","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#RESULT_HEADER"},"CamelInfinispanLifespanTime":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Lifespan time of a value inside the cache. Negative values are interpreted as infinity.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#LIFESPAN_TIME"},"CamelInfinispanTimeUnit":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Time Unit of an entry Lifespan Time.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#LIFESPAN_TIME_UNIT"},"CamelInfinispanMaxIdleTime":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum amount of time an entry is allowed to be idle for before it is considered as expired.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAX_IDLE_TIME"},"CamelInfinispanMaxIdleTimeUnit":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Time Unit of an entry Max Idle Time.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAX_IDLE_TIME_UNIT"},"CamelInfinispanIgnoreReturnValues":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Signals that a write operation's return value will be ignored, so reading the existing value from a store or from a remote node is not necessary.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#IGNORE_RETURN_VALUES"},"CamelInfinispanEventData":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event data.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#EVENT_DATA"},"CamelInfinispanQueryBuilder":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.infinispan.InfinispanQueryBuilder","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The QueryBuilder to use for QUERY command, if not present the command defaults to InifinispanConfiguration's one","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#QUERY_BUILDER"},"CamelInfinispanCommandRetried":{"index":18,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This will be true if the write command that caused this had to be retried again due to a topology change.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#COMMAND_RETRIED"},"CamelInfinispanEntryCreated":{"index":19,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates whether the cache entry modification event is the result of the cache entry being created.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#ENTRY_CREATED"},"CamelInfinispanOriginLocal":{"index":20,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"true if the call originated on the local cache instance; false if originated from a remote one.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#ORIGIN_LOCAL"},"CamelInfinispanCurrentState":{"index":21,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"True if this event is generated from an existing entry as the listener has Listener.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#CURRENT_STATE"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache to use. Use current to use the existing cache name from the currently configured cached manager. Or use default for the default cache manager name."},"queryBuilder":{"index":1,"kind":"parameter","displayName":"Query Builder","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.InfinispanQueryBuilder","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Specifies the query builder."},"clusteredListener":{"index":2,"kind":"parameter","displayName":"Clustered Listener","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"If true, the listener will be installed for the entire cluster"},"customListener":{"index":3,"kind":"parameter","displayName":"Custom Listener","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedCustomListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Returns the custom listener in use, if provided"},"eventTypes":{"index":4,"kind":"parameter","displayName":"Event Types","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Specifies the set of event types to register by the consumer.Multiple event can be separated by comma. The possible event types are: CACHE_ENTRY_ACTIVATED, CACHE_ENTRY_PASSIVATED, CACHE_ENTRY_VISITED, CACHE_ENTRY_LOADED, CACHE_ENTRY_EVICTED, CACHE_ENTRY_CREATED, CACHE_ENTRY_REMOVED, CACHE_ENTRY_MODIFIED, TRANSACTION_COMPLETED, TRANSACTION_REGISTERED, CACHE_ENTRY_INVALIDATED, CACHE_ENTRY_EXPIRED, DATA_REHASHED, TOPOLOGY_CHANGED, PARTITION_STATUS_CHANGED, PERSISTENCE_AVAILABILITY_CHANGED"},"sync":{"index":5,"kind":"parameter","displayName":"Sync","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"If true, the consumer will receive notifications synchronously"},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"defaultValue":{"index":9,"kind":"parameter","displayName":"Default Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Set a specific default value for some producer operations"},"key":{"index":10,"kind":"parameter","displayName":"Key","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Set a specific key for producer operations"},"oldValue":{"index":11,"kind":"parameter","displayName":"Old Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Set a specific old value for some producer operations"},"operation":{"index":12,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.InfinispanOperation","enum":["PUT","PUTASYNC","PUTALL","PUTALLASYNC","PUTIFABSENT","PUTIFABSENTASYNC","GET","GETORDEFAULT","CONTAINSKEY","CONTAINSVALUE","REMOVE","REMOVEASYNC","REPLACE","REPLACEASYNC","SIZE","CLEAR","CLEARASYNC","QUERY","STATS","COMPUTE","COMPUTEASYNC"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PUT","configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"The operation to perform"},"value":{"index":13,"kind":"parameter","displayName":"Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Set a specific value for producer operations"},"lazyStartProducer":{"index":14,"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."},"cacheContainer":{"index":15,"kind":"parameter","displayName":"Cache Container","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.infinispan.manager.EmbeddedCacheManager","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Specifies the cache Container to connect"},"cacheContainerConfiguration":{"index":16,"kind":"parameter","displayName":"Cache Container Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.infinispan.configuration.cache.Configuration","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"The CacheContainer configuration. Used if the cacheContainer is not defined."},"configurationUri":{"index":17,"kind":"parameter","displayName":"Configuration Uri","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"An implementation specific URI for the CacheManager"},"flags":{"index":18,"kind":"parameter","displayName":"Flags","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"A comma separated list of org.infinispan.context.Flag to be applied by default on each cache invocation"},"remappingFunction":{"index":19,"kind":"parameter","displayName":"Remapping Function","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.function.BiFunction","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Set a specific remappingFunction to use in a compute operation."},"resultHeader":{"index":20,"kind":"parameter","displayName":"Result Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedConfiguration","configurationField":"configuration","description":"Store the operation result in a header instead of the message body. By default, resultHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If resultHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. This value can be overridden by an in message header named: CamelInfinispanOperationResultHeader"}}} , -{"component":{"kind":"component","name":"influxdb","title":"InfluxDB","description":"Interact with InfluxDB v1, a time series database.","deprecated":false,"firstVersion":"2.18.0","label":"database","javaType":"org.apache.camel.component.influxdb.InfluxDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-influxdb","version":"4.8.1","scheme":"influxdb","extendsScheme":"","syntax":"influxdb:connectionBean","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"camelInfluxDB.RetentionPolicy":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The string that defines the retention policy to the data created by the endpoint","constantName":"org.apache.camel.component.influxdb.InfluxDbConstants#RETENTION_POLICY_HEADER"},"camelInfluxDB.databaseName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the database where the time series will be stored","constantName":"org.apache.camel.component.influxdb.InfluxDbConstants#DBNAME_HEADER"},"camelInfluxDB.query":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Define the query in case of operation query","constantName":"org.apache.camel.component.influxdb.InfluxDbConstants#INFLUXDB_QUERY"}},"properties":{"connectionBean":{"index":0,"kind":"path","displayName":"Connection Bean","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Connection to the influx database, of class InfluxDB.class"},"autoCreateDatabase":{"index":1,"kind":"parameter","displayName":"Auto Create Database","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Define if we want to auto create the database if it's not present"},"batch":{"index":2,"kind":"parameter","displayName":"Batch","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Define if this operation is a batch operation or not"},"checkDatabaseExistence":{"index":3,"kind":"parameter","displayName":"Check Database Existence","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Define if we want to check the database existence while starting the endpoint"},"databaseName":{"index":4,"kind":"parameter","displayName":"Database Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the database where the time series will be stored"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"insert","description":"Define if this operation is an insert or a query"},"query":{"index":6,"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define the query in case of operation query"},"retentionPolicy":{"index":7,"kind":"parameter","displayName":"Retention Policy","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"The string that defines the retention policy to the data created by the endpoint"},"lazyStartProducer":{"index":8,"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."}}} +{"component":{"kind":"component","name":"influxdb","title":"InfluxDB","description":"Interact with InfluxDB v1, a time series database.","deprecated":false,"firstVersion":"2.18.0","label":"database","javaType":"org.apache.camel.component.influxdb.InfluxDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-influxdb","version":"4.8.2","scheme":"influxdb","extendsScheme":"","syntax":"influxdb:connectionBean","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"camelInfluxDB.RetentionPolicy":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The string that defines the retention policy to the data created by the endpoint","constantName":"org.apache.camel.component.influxdb.InfluxDbConstants#RETENTION_POLICY_HEADER"},"camelInfluxDB.databaseName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the database where the time series will be stored","constantName":"org.apache.camel.component.influxdb.InfluxDbConstants#DBNAME_HEADER"},"camelInfluxDB.query":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Define the query in case of operation query","constantName":"org.apache.camel.component.influxdb.InfluxDbConstants#INFLUXDB_QUERY"}},"properties":{"connectionBean":{"index":0,"kind":"path","displayName":"Connection Bean","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Connection to the influx database, of class InfluxDB.class"},"autoCreateDatabase":{"index":1,"kind":"parameter","displayName":"Auto Create Database","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Define if we want to auto create the database if it's not present"},"batch":{"index":2,"kind":"parameter","displayName":"Batch","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Define if this operation is a batch operation or not"},"checkDatabaseExistence":{"index":3,"kind":"parameter","displayName":"Check Database Existence","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Define if we want to check the database existence while starting the endpoint"},"databaseName":{"index":4,"kind":"parameter","displayName":"Database Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the database where the time series will be stored"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"insert","description":"Define if this operation is an insert or a query"},"query":{"index":6,"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define the query in case of operation query"},"retentionPolicy":{"index":7,"kind":"parameter","displayName":"Retention Policy","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"The string that defines the retention policy to the data created by the endpoint"},"lazyStartProducer":{"index":8,"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."}}} , -{"component":{"kind":"component","name":"influxdb2","title":"InfluxDB2","description":"Interact with InfluxDB v2, a time series database.","deprecated":false,"firstVersion":"3.20.0","label":"database","javaType":"org.apache.camel.component.influxdb2.InfluxDb2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-influxdb2","version":"4.8.1","scheme":"influxdb2","extendsScheme":"","syntax":"influxdb2:connectionBean","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelInfluxDB2MeasurementName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of measurement","constantName":"org.apache.camel.component.influxdb2.InfluxDb2Constants#MEASUREMENT"},"camelInfluxDB.RetentionPolicy":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The string that defines the retention policy to the data created by the endpoint","constantName":"org.apache.camel.component.influxdb2.InfluxDb2Constants#RETENTION_POLICY"},"CamelInfluxDB2WritePrecision":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"com.influxdb.client.domain.WritePrecision","enum":["ms","s","us","ns"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"InfluxDb Write precision.","constantName":"org.apache.camel.component.influxdb2.InfluxDb2Constants#WRITE_PRECISION"}},"properties":{"connectionBean":{"index":0,"kind":"path","displayName":"Connection Bean","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Connection to the Influx database, of class com.influxdb.client.InfluxDBClient.class."},"autoCreateBucket":{"index":1,"kind":"parameter","displayName":"Auto Create Bucket","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Define if we want to auto create the bucket if it's not present."},"autoCreateOrg":{"index":2,"kind":"parameter","displayName":"Auto Create Org","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Define if we want to auto create the organization if it's not present."},"bucket":{"index":3,"kind":"parameter","displayName":"Bucket","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the bucket where the time series will be stored."},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.influxdb2.enums.Operation","enum":["INSERT","PING"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"INSERT","description":"Define if this operation is an insert of ping."},"org":{"index":5,"kind":"parameter","displayName":"Org","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the organization where the time series will be stored."},"retentionPolicy":{"index":6,"kind":"parameter","displayName":"Retention Policy","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Define the retention policy to the data created by the endpoint."},"writePrecision":{"index":7,"kind":"parameter","displayName":"Write Precision","group":"producer","label":"","required":false,"type":"object","javaType":"com.influxdb.client.domain.WritePrecision","enum":["ms","s","us","ns"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ms","description":"The format or precision of time series timestamps."},"lazyStartProducer":{"index":8,"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."}}} +{"component":{"kind":"component","name":"influxdb2","title":"InfluxDB2","description":"Interact with InfluxDB v2, a time series database.","deprecated":false,"firstVersion":"3.20.0","label":"database","javaType":"org.apache.camel.component.influxdb2.InfluxDb2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-influxdb2","version":"4.8.2","scheme":"influxdb2","extendsScheme":"","syntax":"influxdb2:connectionBean","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelInfluxDB2MeasurementName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of measurement","constantName":"org.apache.camel.component.influxdb2.InfluxDb2Constants#MEASUREMENT"},"camelInfluxDB.RetentionPolicy":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The string that defines the retention policy to the data created by the endpoint","constantName":"org.apache.camel.component.influxdb2.InfluxDb2Constants#RETENTION_POLICY"},"CamelInfluxDB2WritePrecision":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"com.influxdb.client.domain.WritePrecision","enum":["ms","s","us","ns"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"InfluxDb Write precision.","constantName":"org.apache.camel.component.influxdb2.InfluxDb2Constants#WRITE_PRECISION"}},"properties":{"connectionBean":{"index":0,"kind":"path","displayName":"Connection Bean","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Connection to the Influx database, of class com.influxdb.client.InfluxDBClient.class."},"autoCreateBucket":{"index":1,"kind":"parameter","displayName":"Auto Create Bucket","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Define if we want to auto create the bucket if it's not present."},"autoCreateOrg":{"index":2,"kind":"parameter","displayName":"Auto Create Org","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Define if we want to auto create the organization if it's not present."},"bucket":{"index":3,"kind":"parameter","displayName":"Bucket","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the bucket where the time series will be stored."},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.influxdb2.enums.Operation","enum":["INSERT","PING"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"INSERT","description":"Define if this operation is an insert of ping."},"org":{"index":5,"kind":"parameter","displayName":"Org","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the organization where the time series will be stored."},"retentionPolicy":{"index":6,"kind":"parameter","displayName":"Retention Policy","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Define the retention policy to the data created by the endpoint."},"writePrecision":{"index":7,"kind":"parameter","displayName":"Write Precision","group":"producer","label":"","required":false,"type":"object","javaType":"com.influxdb.client.domain.WritePrecision","enum":["ms","s","us","ns"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ms","description":"The format or precision of time series timestamps."},"lazyStartProducer":{"index":8,"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."}}} , -{"component":{"kind":"component","name":"irc","title":"IRC","description":"Send and receive messages to/from and IRC chat.","deprecated":false,"firstVersion":"1.1.0","label":"chat","javaType":"org.apache.camel.component.irc.IrcComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-irc","version":"4.8.1","scheme":"irc","extendsScheme":"","syntax":"irc:hostname:port","alternativeSyntax":"irc:username:password@hostname:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"irc.messageType":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of message","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_MESSAGE_TYPE"},"irc.target":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The target","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_TARGET"},"irc.sendTo":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The nickname or channel the message should be sent to.","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_SEND_TO"},"irc.user.kicked":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The nickname of the user who is kicked from a channel (passive).","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_USER_KICKED"},"irc.user.host":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The host of the person who sent the line.","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_USER_HOST"},"irc.user.nick":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The nickname of the person who sent the line or the server name of the server which sent the line.","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_USER_NICK"},"irc.user.servername":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The server name of the server which sent the line or the nickname of the person who sent the line.","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_USER_SERVERNAME"},"irc.user.username":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The username of the person who sent the line.","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_USER_USERNAME"},"irc.num":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The numeric reply.","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_NUM"},"irc.value":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The first part of the message","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_VALUE"}},"properties":{"hostname":{"index":0,"kind":"path","displayName":"Hostname","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Hostname for the IRC chat server"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Port number for the IRC chat server. If no port is configured then a default port of either 6667, 6668 or 6669 is used."},"autoRejoin":{"index":2,"kind":"parameter","displayName":"Auto Rejoin","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Whether to auto re-join when being kicked"},"channels":{"index":3,"kind":"parameter","displayName":"Channels","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Comma separated list of IRC channels."},"commandTimeout":{"index":4,"kind":"parameter","displayName":"Command Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Delay in milliseconds before sending commands after the connection is established."},"keys":{"index":5,"kind":"parameter","displayName":"Keys","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Comma separated list of keys for channels."},"namesOnJoin":{"index":6,"kind":"parameter","displayName":"Names On Join","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Sends NAMES command to channel after joining it. onReply has to be true in order to process the result which will have the header value irc.num = '353'."},"nickname":{"index":7,"kind":"parameter","displayName":"Nickname","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"The nickname used in chat."},"persistent":{"index":8,"kind":"parameter","displayName":"Persistent","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":true,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Use persistent messages."},"realname":{"index":9,"kind":"parameter","displayName":"Realname","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"The IRC user's actual name."},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":13,"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."},"colors":{"index":14,"kind":"parameter","displayName":"Colors","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Whether or not the server supports color codes."},"onJoin":{"index":15,"kind":"parameter","displayName":"On Join","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle user join events."},"onKick":{"index":16,"kind":"parameter","displayName":"On Kick","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle kick events."},"onMode":{"index":17,"kind":"parameter","displayName":"On Mode","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle mode change events."},"onNick":{"index":18,"kind":"parameter","displayName":"On Nick","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle nickname change events."},"onPart":{"index":19,"kind":"parameter","displayName":"On Part","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle user part events."},"onPrivmsg":{"index":20,"kind":"parameter","displayName":"On Privmsg","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle private message events."},"onQuit":{"index":21,"kind":"parameter","displayName":"On Quit","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle user quit events."},"onReply":{"index":22,"kind":"parameter","displayName":"On Reply","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Whether or not to handle general responses to commands or informational messages."},"onTopic":{"index":23,"kind":"parameter","displayName":"On Topic","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle topic change events."},"nickPassword":{"index":24,"kind":"parameter","displayName":"Nick Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Your IRC server nickname password."},"password":{"index":25,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"The IRC server password."},"sslContextParameters":{"index":26,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Used for configuring security using SSL. Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. Note that this setting overrides the trustManager option."},"trustManager":{"index":27,"kind":"parameter","displayName":"Trust Manager","group":"security","label":"security","required":false,"type":"object","javaType":"org.schwering.irc.lib.ssl.SSLTrustManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"The trust manager used to verify the SSL server's certificate."},"username":{"index":28,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"The IRC server user name."}}} +{"component":{"kind":"component","name":"irc","title":"IRC","description":"Send and receive messages to/from and IRC chat.","deprecated":false,"firstVersion":"1.1.0","label":"chat","javaType":"org.apache.camel.component.irc.IrcComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-irc","version":"4.8.2","scheme":"irc","extendsScheme":"","syntax":"irc:hostname:port","alternativeSyntax":"irc:username:password@hostname:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"irc.messageType":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of message","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_MESSAGE_TYPE"},"irc.target":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The target","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_TARGET"},"irc.sendTo":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The nickname or channel the message should be sent to.","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_SEND_TO"},"irc.user.kicked":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The nickname of the user who is kicked from a channel (passive).","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_USER_KICKED"},"irc.user.host":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The host of the person who sent the line.","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_USER_HOST"},"irc.user.nick":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The nickname of the person who sent the line or the server name of the server which sent the line.","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_USER_NICK"},"irc.user.servername":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The server name of the server which sent the line or the nickname of the person who sent the line.","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_USER_SERVERNAME"},"irc.user.username":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The username of the person who sent the line.","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_USER_USERNAME"},"irc.num":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The numeric reply.","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_NUM"},"irc.value":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The first part of the message","constantName":"org.apache.camel.component.irc.IrcConstants#IRC_VALUE"}},"properties":{"hostname":{"index":0,"kind":"path","displayName":"Hostname","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Hostname for the IRC chat server"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Port number for the IRC chat server. If no port is configured then a default port of either 6667, 6668 or 6669 is used."},"autoRejoin":{"index":2,"kind":"parameter","displayName":"Auto Rejoin","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Whether to auto re-join when being kicked"},"channels":{"index":3,"kind":"parameter","displayName":"Channels","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Comma separated list of IRC channels."},"commandTimeout":{"index":4,"kind":"parameter","displayName":"Command Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Delay in milliseconds before sending commands after the connection is established."},"keys":{"index":5,"kind":"parameter","displayName":"Keys","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Comma separated list of keys for channels."},"namesOnJoin":{"index":6,"kind":"parameter","displayName":"Names On Join","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Sends NAMES command to channel after joining it. onReply has to be true in order to process the result which will have the header value irc.num = '353'."},"nickname":{"index":7,"kind":"parameter","displayName":"Nickname","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"The nickname used in chat."},"persistent":{"index":8,"kind":"parameter","displayName":"Persistent","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":true,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Use persistent messages."},"realname":{"index":9,"kind":"parameter","displayName":"Realname","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"The IRC user's actual name."},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":13,"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."},"colors":{"index":14,"kind":"parameter","displayName":"Colors","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Whether or not the server supports color codes."},"onJoin":{"index":15,"kind":"parameter","displayName":"On Join","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle user join events."},"onKick":{"index":16,"kind":"parameter","displayName":"On Kick","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle kick events."},"onMode":{"index":17,"kind":"parameter","displayName":"On Mode","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle mode change events."},"onNick":{"index":18,"kind":"parameter","displayName":"On Nick","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle nickname change events."},"onPart":{"index":19,"kind":"parameter","displayName":"On Part","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle user part events."},"onPrivmsg":{"index":20,"kind":"parameter","displayName":"On Privmsg","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle private message events."},"onQuit":{"index":21,"kind":"parameter","displayName":"On Quit","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle user quit events."},"onReply":{"index":22,"kind":"parameter","displayName":"On Reply","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Whether or not to handle general responses to commands or informational messages."},"onTopic":{"index":23,"kind":"parameter","displayName":"On Topic","group":"filter","label":"filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Handle topic change events."},"nickPassword":{"index":24,"kind":"parameter","displayName":"Nick Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Your IRC server nickname password."},"password":{"index":25,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"The IRC server password."},"sslContextParameters":{"index":26,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"Used for configuring security using SSL. Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. Note that this setting overrides the trustManager option."},"trustManager":{"index":27,"kind":"parameter","displayName":"Trust Manager","group":"security","label":"security","required":false,"type":"object","javaType":"org.schwering.irc.lib.ssl.SSLTrustManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"The trust manager used to verify the SSL server's certificate."},"username":{"index":28,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.irc.IrcConfiguration","configurationField":"configuration","description":"The IRC server user name."}}} , -{"component":{"kind":"component","name":"ironmq","title":"IronMQ","description":"Send and receive messages to/from IronMQ an elastic and durable hosted message queue as a service.","deprecated":false,"firstVersion":"2.17.0","label":"cloud,messaging","javaType":"org.apache.camel.component.ironmq.IronMQComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ironmq","version":"4.8.1","scheme":"ironmq","extendsScheme":"","syntax":"ironmq:queueName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelIronMQMessageId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or io.iron.ironmq.Ids","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) The id of the IronMQ message as a String when sending a single message, or a Ids object when sending a array of strings. (consumer) The id of the message.","constantName":"org.apache.camel.component.ironmq.IronMQConstants#MESSAGE_ID"},"CamelIronMQReservationId":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The reservation id of the message.","constantName":"org.apache.camel.component.ironmq.IronMQConstants#MESSAGE_RESERVATION_ID"},"CamelIronMQReservedCount":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of times this message has been reserved.","constantName":"org.apache.camel.component.ironmq.IronMQConstants#MESSAGE_RESERVED_COUNT"},"CamelIronMQOperation":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If value set to 'CamelIronMQClearQueue' the queue is cleared of unconsumed messages.","constantName":"org.apache.camel.component.ironmq.IronMQConstants#OPERATION"}},"properties":{"queueName":{"index":0,"kind":"path","displayName":"Queue Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"The name of the IronMQ queue"},"ironMQCloud":{"index":1,"kind":"parameter","displayName":"Iron MQCloud","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https://mq-aws-us-east-1-1.iron.io","configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"IronMq Cloud url. Urls for public clusters: https://mq-aws-us-east-1-1.iron.io (US) and https://mq-aws-eu-west-1-1.iron.io (EU)"},"preserveHeaders":{"index":2,"kind":"parameter","displayName":"Preserve Headers","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"Should message headers be preserved when publishing messages. This will add the Camel headers to the Iron MQ message as a json payload with a header list, and a message body. Useful when Camel is both consumer and producer."},"projectId":{"index":3,"kind":"parameter","displayName":"Project Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"IronMQ projectId"},"batchDelete":{"index":4,"kind":"parameter","displayName":"Batch Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"Should messages be deleted in one batch. This will limit the number of api requests since messages are deleted in one request, instead of one per exchange. If enabled care should be taken that the consumer is idempotent when processing exchanges."},"concurrentConsumers":{"index":5,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"The number of concurrent consumers."},"maxMessagesPerPoll":{"index":6,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"Number of messages to poll per call. Maximum is 100."},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"timeout":{"index":8,"kind":"parameter","displayName":"Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"After timeout (in seconds), item will be placed back onto the queue."},"wait":{"index":9,"kind":"parameter","displayName":"Wait","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"Time in seconds to wait for a message to become available. This enables long polling. Default is 0 (does not wait), maximum is 30."},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":13,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"visibilityDelay":{"index":14,"kind":"parameter","displayName":"Visibility Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"The item will not be available on the queue until this many seconds have passed. Default is 0 seconds."},"lazyStartProducer":{"index":15,"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."},"client":{"index":16,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.iron.ironmq.Client","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"Reference to a io.iron.ironmq.Client in the Registry."},"backoffErrorThreshold":{"index":17,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":18,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":19,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":20,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":21,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":22,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":23,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":24,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":25,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":26,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":27,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":28,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":29,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":30,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"token":{"index":31,"kind":"parameter","displayName":"Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"IronMQ token"}}} +{"component":{"kind":"component","name":"ironmq","title":"IronMQ","description":"Send and receive messages to/from IronMQ an elastic and durable hosted message queue as a service.","deprecated":false,"firstVersion":"2.17.0","label":"cloud,messaging","javaType":"org.apache.camel.component.ironmq.IronMQComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ironmq","version":"4.8.2","scheme":"ironmq","extendsScheme":"","syntax":"ironmq:queueName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelIronMQMessageId":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or io.iron.ironmq.Ids","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer) The id of the IronMQ message as a String when sending a single message, or a Ids object when sending a array of strings. (consumer) The id of the message.","constantName":"org.apache.camel.component.ironmq.IronMQConstants#MESSAGE_ID"},"CamelIronMQReservationId":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The reservation id of the message.","constantName":"org.apache.camel.component.ironmq.IronMQConstants#MESSAGE_RESERVATION_ID"},"CamelIronMQReservedCount":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of times this message has been reserved.","constantName":"org.apache.camel.component.ironmq.IronMQConstants#MESSAGE_RESERVED_COUNT"},"CamelIronMQOperation":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If value set to 'CamelIronMQClearQueue' the queue is cleared of unconsumed messages.","constantName":"org.apache.camel.component.ironmq.IronMQConstants#OPERATION"}},"properties":{"queueName":{"index":0,"kind":"path","displayName":"Queue Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"The name of the IronMQ queue"},"ironMQCloud":{"index":1,"kind":"parameter","displayName":"Iron MQCloud","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https://mq-aws-us-east-1-1.iron.io","configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"IronMq Cloud url. Urls for public clusters: https://mq-aws-us-east-1-1.iron.io (US) and https://mq-aws-eu-west-1-1.iron.io (EU)"},"preserveHeaders":{"index":2,"kind":"parameter","displayName":"Preserve Headers","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"Should message headers be preserved when publishing messages. This will add the Camel headers to the Iron MQ message as a json payload with a header list, and a message body. Useful when Camel is both consumer and producer."},"projectId":{"index":3,"kind":"parameter","displayName":"Project Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"IronMQ projectId"},"batchDelete":{"index":4,"kind":"parameter","displayName":"Batch Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"Should messages be deleted in one batch. This will limit the number of api requests since messages are deleted in one request, instead of one per exchange. If enabled care should be taken that the consumer is idempotent when processing exchanges."},"concurrentConsumers":{"index":5,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"The number of concurrent consumers."},"maxMessagesPerPoll":{"index":6,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"Number of messages to poll per call. Maximum is 100."},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"timeout":{"index":8,"kind":"parameter","displayName":"Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"After timeout (in seconds), item will be placed back onto the queue."},"wait":{"index":9,"kind":"parameter","displayName":"Wait","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"Time in seconds to wait for a message to become available. This enables long polling. Default is 0 (does not wait), maximum is 30."},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":13,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"visibilityDelay":{"index":14,"kind":"parameter","displayName":"Visibility Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"The item will not be available on the queue until this many seconds have passed. Default is 0 seconds."},"lazyStartProducer":{"index":15,"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."},"client":{"index":16,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.iron.ironmq.Client","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"Reference to a io.iron.ironmq.Client in the Registry."},"backoffErrorThreshold":{"index":17,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":18,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":19,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":20,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":21,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":22,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":23,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":24,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":25,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":26,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":27,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":28,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":29,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":30,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"token":{"index":31,"kind":"parameter","displayName":"Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.ironmq.IronMQConfiguration","configurationField":"configuration","description":"IronMQ token"}}} , -{"component":{"kind":"component","name":"jcache","title":"JCache","description":"Perform caching operations against JSR107/JCache.","deprecated":false,"firstVersion":"2.17.0","label":"cache,clustering","javaType":"org.apache.camel.component.jcache.JCacheComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jcache","version":"4.8.1","scheme":"jcache","extendsScheme":"","syntax":"jcache:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJCacheAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cache operation to perform","constantName":"org.apache.camel.component.jcache.JCacheConstants#ACTION"},"CamelJCacheResult":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The result of the cache operation","constantName":"org.apache.camel.component.jcache.JCacheConstants#RESULT"},"CamelJCacheEventType":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event received","constantName":"org.apache.camel.component.jcache.JCacheConstants#EVENT_TYPE"},"CamelJCacheKey":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the cache entry","constantName":"org.apache.camel.component.jcache.JCacheConstants#KEY"},"CamelJCacheKeys":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection of keys against which the action should be performed","constantName":"org.apache.camel.component.jcache.JCacheConstants#KEYS"},"CamelJCacheOldValue":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value of the cache entry","constantName":"org.apache.camel.component.jcache.JCacheConstants#OLD_VALUE"},"CamelJCacheEntryProcessor":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"EntryProcessor","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The EntryProcessor to invoke","constantName":"org.apache.camel.component.jcache.JCacheConstants#ENTRY_PROCESSOR"},"CamelJCacheEntryArgs":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The additional arguments to pass to the EntryProcessor","constantName":"org.apache.camel.component.jcache.JCacheConstants#ARGUMENTS"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"cacheConfigurationProperties":{"index":1,"kind":"parameter","displayName":"Cache Configuration Properties","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The Properties for the javax.cache.spi.CachingProvider to create the CacheManager"},"cachingProvider":{"index":2,"kind":"parameter","displayName":"Caching Provider","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The fully qualified class name of the javax.cache.spi.CachingProvider"},"configurationUri":{"index":3,"kind":"parameter","displayName":"Configuration Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"An implementation specific URI for the CacheManager"},"managementEnabled":{"index":4,"kind":"parameter","displayName":"Management Enabled","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Whether management gathering is enabled"},"readThrough":{"index":5,"kind":"parameter","displayName":"Read Through","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"If read-through caching should be used"},"statisticsEnabled":{"index":6,"kind":"parameter","displayName":"Statistics Enabled","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Whether statistics gathering is enabled"},"storeByValue":{"index":7,"kind":"parameter","displayName":"Store By Value","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"If cache should use store-by-value or store-by-reference semantics"},"writeThrough":{"index":8,"kind":"parameter","displayName":"Write Through","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"If write-through caching should be used"},"filteredEvents":{"index":9,"kind":"parameter","displayName":"Filtered Events","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["CREATED","UPDATED","REMOVED","EXPIRED"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Events a consumer should filter (multiple events can be separated by comma). If using filteredEvents option, then eventFilters one will be ignored"},"oldValueRequired":{"index":10,"kind":"parameter","displayName":"Old Value Required","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"if the old value is required for events"},"synchronous":{"index":11,"kind":"parameter","displayName":"Synchronous","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"if the event listener should block the thread causing the event"},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"eventFilters":{"index":13,"kind":"parameter","displayName":"Event Filters","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The CacheEntryEventFilter. If using eventFilters option, then filteredEvents one will be ignored"},"exceptionHandler":{"index":14,"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":{"index":15,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"action":{"index":16,"kind":"parameter","displayName":"Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"To configure using a cache operation by default. If an operation in the message header, then the operation from the header takes precedence."},"lazyStartProducer":{"index":17,"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."},"cacheConfiguration":{"index":18,"kind":"parameter","displayName":"Cache Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.cache.configuration.Configuration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"A Configuration for the Cache"},"cacheLoaderFactory":{"index":19,"kind":"parameter","displayName":"Cache Loader Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.cache.configuration.Factory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The CacheLoader factory"},"cacheWriterFactory":{"index":20,"kind":"parameter","displayName":"Cache Writer Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.cache.configuration.Factory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The CacheWriter factory"},"createCacheIfNotExists":{"index":21,"kind":"parameter","displayName":"Create Cache If Not Exists","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Configure if a cache need to be created if it does exist or can't be pre-configured."},"expiryPolicyFactory":{"index":22,"kind":"parameter","displayName":"Expiry Policy Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.cache.configuration.Factory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The ExpiryPolicy factory"},"lookupProviders":{"index":23,"kind":"parameter","displayName":"Lookup Providers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi."}}} +{"component":{"kind":"component","name":"jcache","title":"JCache","description":"Perform caching operations against JSR107/JCache.","deprecated":false,"firstVersion":"2.17.0","label":"cache,clustering","javaType":"org.apache.camel.component.jcache.JCacheComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jcache","version":"4.8.2","scheme":"jcache","extendsScheme":"","syntax":"jcache:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJCacheAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cache operation to perform","constantName":"org.apache.camel.component.jcache.JCacheConstants#ACTION"},"CamelJCacheResult":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The result of the cache operation","constantName":"org.apache.camel.component.jcache.JCacheConstants#RESULT"},"CamelJCacheEventType":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event received","constantName":"org.apache.camel.component.jcache.JCacheConstants#EVENT_TYPE"},"CamelJCacheKey":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the cache entry","constantName":"org.apache.camel.component.jcache.JCacheConstants#KEY"},"CamelJCacheKeys":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection of keys against which the action should be performed","constantName":"org.apache.camel.component.jcache.JCacheConstants#KEYS"},"CamelJCacheOldValue":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value of the cache entry","constantName":"org.apache.camel.component.jcache.JCacheConstants#OLD_VALUE"},"CamelJCacheEntryProcessor":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"EntryProcessor","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The EntryProcessor to invoke","constantName":"org.apache.camel.component.jcache.JCacheConstants#ENTRY_PROCESSOR"},"CamelJCacheEntryArgs":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The additional arguments to pass to the EntryProcessor","constantName":"org.apache.camel.component.jcache.JCacheConstants#ARGUMENTS"}},"properties":{"cacheName":{"index":0,"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"cacheConfigurationProperties":{"index":1,"kind":"parameter","displayName":"Cache Configuration Properties","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The Properties for the javax.cache.spi.CachingProvider to create the CacheManager"},"cachingProvider":{"index":2,"kind":"parameter","displayName":"Caching Provider","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The fully qualified class name of the javax.cache.spi.CachingProvider"},"configurationUri":{"index":3,"kind":"parameter","displayName":"Configuration Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"An implementation specific URI for the CacheManager"},"managementEnabled":{"index":4,"kind":"parameter","displayName":"Management Enabled","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Whether management gathering is enabled"},"readThrough":{"index":5,"kind":"parameter","displayName":"Read Through","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"If read-through caching should be used"},"statisticsEnabled":{"index":6,"kind":"parameter","displayName":"Statistics Enabled","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Whether statistics gathering is enabled"},"storeByValue":{"index":7,"kind":"parameter","displayName":"Store By Value","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"If cache should use store-by-value or store-by-reference semantics"},"writeThrough":{"index":8,"kind":"parameter","displayName":"Write Through","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"If write-through caching should be used"},"filteredEvents":{"index":9,"kind":"parameter","displayName":"Filtered Events","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["CREATED","UPDATED","REMOVED","EXPIRED"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Events a consumer should filter (multiple events can be separated by comma). If using filteredEvents option, then eventFilters one will be ignored"},"oldValueRequired":{"index":10,"kind":"parameter","displayName":"Old Value Required","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"if the old value is required for events"},"synchronous":{"index":11,"kind":"parameter","displayName":"Synchronous","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"if the event listener should block the thread causing the event"},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"eventFilters":{"index":13,"kind":"parameter","displayName":"Event Filters","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The CacheEntryEventFilter. If using eventFilters option, then filteredEvents one will be ignored"},"exceptionHandler":{"index":14,"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":{"index":15,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"action":{"index":16,"kind":"parameter","displayName":"Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"To configure using a cache operation by default. If an operation in the message header, then the operation from the header takes precedence."},"lazyStartProducer":{"index":17,"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."},"cacheConfiguration":{"index":18,"kind":"parameter","displayName":"Cache Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.cache.configuration.Configuration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"A Configuration for the Cache"},"cacheLoaderFactory":{"index":19,"kind":"parameter","displayName":"Cache Loader Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.cache.configuration.Factory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The CacheLoader factory"},"cacheWriterFactory":{"index":20,"kind":"parameter","displayName":"Cache Writer Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.cache.configuration.Factory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The CacheWriter factory"},"createCacheIfNotExists":{"index":21,"kind":"parameter","displayName":"Create Cache If Not Exists","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Configure if a cache need to be created if it does exist or can't be pre-configured."},"expiryPolicyFactory":{"index":22,"kind":"parameter","displayName":"Expiry Policy Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.cache.configuration.Factory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The ExpiryPolicy factory"},"lookupProviders":{"index":23,"kind":"parameter","displayName":"Lookup Providers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi."}}} , -{"component":{"kind":"component","name":"jcr","title":"JCR","description":"Read and write nodes to/from a JCR compliant content repository.","deprecated":false,"firstVersion":"1.3.0","label":"database,cms","javaType":"org.apache.camel.component.jcr.JcrComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jcr","version":"4.8.1","scheme":"jcr","extendsScheme":"","syntax":"jcr:host/base","alternativeSyntax":"jcr:username:password@host/base","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJcrNodeName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"The exchange id","description":"The name of the target node","constantName":"org.apache.camel.component.jcr.JcrConstants#JCR_NODE_NAME"},"CamelJcrOperation":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"CamelJcrInsert","description":"The operation to perform. Possible values: CamelJcrInsert or CamelJcrGetById","constantName":"org.apache.camel.component.jcr.JcrConstants#JCR_OPERATION"},"CamelJcrNodeType":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The node type of the target node","constantName":"org.apache.camel.component.jcr.JcrConstants#JCR_NODE_TYPE"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the javax.jcr.Repository to lookup from the Camel registry to be used."},"base":{"index":1,"kind":"path","displayName":"Base","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Get the base node when accessing the repository"},"deep":{"index":2,"kind":"parameter","displayName":"Deep","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When isDeep is true, events whose associated parent node is at absPath or within its subgraph are received."},"eventTypes":{"index":3,"kind":"parameter","displayName":"Event Types","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"eventTypes (a combination of one or more event types encoded as a bit mask value such as javax.jcr.observation.Event.NODE_ADDED, javax.jcr.observation.Event.NODE_REMOVED, etc.)."},"nodeTypeNames":{"index":4,"kind":"parameter","displayName":"Node Type Names","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When a comma separated nodeTypeName list string is set, only events whose associated parent node has one of the node types (or a subtype of one of the node types) in this list will be received."},"noLocal":{"index":5,"kind":"parameter","displayName":"No Local","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If noLocal is true, then events generated by the session through which the listener was registered are ignored. Otherwise, they are not ignored."},"password":{"index":6,"kind":"parameter","displayName":"Password","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Password for login"},"sessionLiveCheckInterval":{"index":7,"kind":"parameter","displayName":"Session Live Check Interval","group":"common","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Interval in milliseconds to wait before each session live checking The default value is 60000 ms."},"sessionLiveCheckIntervalOnStart":{"index":8,"kind":"parameter","displayName":"Session Live Check Interval On Start","group":"common","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3000","description":"Interval in milliseconds to wait before the first session live checking. The default value is 3000 ms."},"username":{"index":9,"kind":"parameter","displayName":"Username","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Username for login"},"uuids":{"index":10,"kind":"parameter","displayName":"Uuids","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When a comma separated uuid list string is set, only events whose associated parent node has one of the identifiers in the comma separated uuid list will be received."},"workspaceName":{"index":11,"kind":"parameter","displayName":"Workspace Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The workspace to access. If it's not specified then the default one will be used"},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":15,"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."}}} +{"component":{"kind":"component","name":"jcr","title":"JCR","description":"Read and write nodes to/from a JCR compliant content repository.","deprecated":false,"firstVersion":"1.3.0","label":"database,cms","javaType":"org.apache.camel.component.jcr.JcrComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jcr","version":"4.8.2","scheme":"jcr","extendsScheme":"","syntax":"jcr:host/base","alternativeSyntax":"jcr:username:password@host/base","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJcrNodeName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"The exchange id","description":"The name of the target node","constantName":"org.apache.camel.component.jcr.JcrConstants#JCR_NODE_NAME"},"CamelJcrOperation":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"CamelJcrInsert","description":"The operation to perform. Possible values: CamelJcrInsert or CamelJcrGetById","constantName":"org.apache.camel.component.jcr.JcrConstants#JCR_OPERATION"},"CamelJcrNodeType":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The node type of the target node","constantName":"org.apache.camel.component.jcr.JcrConstants#JCR_NODE_TYPE"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the javax.jcr.Repository to lookup from the Camel registry to be used."},"base":{"index":1,"kind":"path","displayName":"Base","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Get the base node when accessing the repository"},"deep":{"index":2,"kind":"parameter","displayName":"Deep","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When isDeep is true, events whose associated parent node is at absPath or within its subgraph are received."},"eventTypes":{"index":3,"kind":"parameter","displayName":"Event Types","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"eventTypes (a combination of one or more event types encoded as a bit mask value such as javax.jcr.observation.Event.NODE_ADDED, javax.jcr.observation.Event.NODE_REMOVED, etc.)."},"nodeTypeNames":{"index":4,"kind":"parameter","displayName":"Node Type Names","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When a comma separated nodeTypeName list string is set, only events whose associated parent node has one of the node types (or a subtype of one of the node types) in this list will be received."},"noLocal":{"index":5,"kind":"parameter","displayName":"No Local","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If noLocal is true, then events generated by the session through which the listener was registered are ignored. Otherwise, they are not ignored."},"password":{"index":6,"kind":"parameter","displayName":"Password","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Password for login"},"sessionLiveCheckInterval":{"index":7,"kind":"parameter","displayName":"Session Live Check Interval","group":"common","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Interval in milliseconds to wait before each session live checking The default value is 60000 ms."},"sessionLiveCheckIntervalOnStart":{"index":8,"kind":"parameter","displayName":"Session Live Check Interval On Start","group":"common","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3000","description":"Interval in milliseconds to wait before the first session live checking. The default value is 3000 ms."},"username":{"index":9,"kind":"parameter","displayName":"Username","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Username for login"},"uuids":{"index":10,"kind":"parameter","displayName":"Uuids","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When a comma separated uuid list string is set, only events whose associated parent node has one of the identifiers in the comma separated uuid list will be received."},"workspaceName":{"index":11,"kind":"parameter","displayName":"Workspace Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The workspace to access. If it's not specified then the default one will be used"},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":15,"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."}}} , -{"component":{"kind":"component","name":"jdbc","title":"JDBC","description":"Access databases through SQL and JDBC.","deprecated":false,"firstVersion":"1.2.0","label":"database","javaType":"org.apache.camel.component.jdbc.JdbcComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jdbc","version":"4.8.1","scheme":"jdbc","extendsScheme":"","syntax":"jdbc:dataSourceName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelJdbcUpdateCount":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the query is an UPDATE, query the update count is returned in this OUT header.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_UPDATE_COUNT"},"CamelJdbcRowCount":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the query is a SELECT, query the row count is returned in this OUT header.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_ROW_COUNT"},"CamelJdbcColumnNames":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The column names from the ResultSet as a java.util.Set type.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_COLUMN_NAMES"},"CamelJdbcParameters":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A java.util.Map which has the headers to be used if useHeadersAsParameters has been enabled.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_PARAMETERS"},"CamelRetrieveGeneratedKeys":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Set its value to true to retrieve generated keys","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_RETRIEVE_GENERATED_KEYS"},"CamelGeneratedColumns":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String[] or int[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set it to specify the expected generated columns","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_GENERATED_COLUMNS"},"CamelGeneratedKeysRowCount":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of rows in the header that contains generated keys.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_GENERATED_KEYS_ROW_COUNT"},"CamelGeneratedKeysRows":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Rows that contains the generated keys.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_GENERATED_KEYS_DATA"}},"properties":{"dataSourceName":{"index":0,"kind":"path","displayName":"Data Source Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of DataSource to lookup in the Registry. If the name is dataSource or default, then Camel will attempt to lookup a default DataSource from the registry, meaning if there is a only one instance of DataSource found, then this DataSource will be used."},"allowNamedParameters":{"index":1,"kind":"parameter","displayName":"Allow Named Parameters","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to allow using named parameters in the queries."},"outputClass":{"index":2,"kind":"parameter","displayName":"Output Class","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList."},"outputType":{"index":3,"kind":"parameter","displayName":"Output Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.JdbcOutputType","enum":["SelectOne","SelectList","StreamList"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SelectList","description":"Determines the output the producer should use."},"parameters":{"index":4,"kind":"parameter","displayName":"Parameters","group":"producer","label":"","required":false,"type":"object","javaType":"java.util.Map","prefix":"statement.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Optional parameters to the java.sql.Statement. For example to set maxRows, fetchSize etc."},"readSize":{"index":5,"kind":"parameter","displayName":"Read Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The default maximum number of rows that can be read by a polling query. The default value is 0."},"resetAutoCommit":{"index":6,"kind":"parameter","displayName":"Reset Auto Commit","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Camel will set the autoCommit on the JDBC connection to be false, commit the change after executed the statement and reset the autoCommit flag of the connection at the end, if the resetAutoCommit is true. If the JDBC connection doesn't support to reset the autoCommit flag, you can set the resetAutoCommit flag to be false, and Camel will not try to reset the autoCommit flag. When used with XA transactions you most likely need to set it to false so that the transaction manager is in charge of committing this tx."},"transacted":{"index":7,"kind":"parameter","displayName":"Transacted","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether transactions are in use."},"useGetBytesForBlob":{"index":8,"kind":"parameter","displayName":"Use Get Bytes For Blob","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To read BLOB columns as bytes instead of string data. This may be needed for certain databases such as Oracle where you must read BLOB columns as bytes."},"useHeadersAsParameters":{"index":9,"kind":"parameter","displayName":"Use Headers As Parameters","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Set this option to true to use the prepareStatementStrategy with named parameters. This allows to define queries with named placeholders, and use headers with the dynamic values for the query placeholders."},"useJDBC4ColumnNameAndLabelSemantics":{"index":10,"kind":"parameter","displayName":"Use JDBC4 Column Name And Label Semantics","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name. JDBC 4.0 uses columnLabel to get the column name where as JDBC 3.0 uses both columnName or columnLabel. Unfortunately JDBC drivers behave differently so you can use this option to work out issues around your JDBC driver if you get problem using this component This option is default true."},"lazyStartProducer":{"index":11,"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."},"beanRowMapper":{"index":12,"kind":"parameter","displayName":"Bean Row Mapper","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.BeanRowMapper","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.component.jdbc.BeanRowMapper when using outputClass. The default implementation will lower case the row names and skip underscores, and dashes. For example CUST_ID is mapped as custId."},"connectionStrategy":{"index":13,"kind":"parameter","displayName":"Connection Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.ConnectionStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom strategy for working with connections. Do not use a custom strategy when using the spring-jdbc component because a special Spring ConnectionStrategy is used by default to support Spring Transactions."},"prepareStatementStrategy":{"index":14,"kind":"parameter","displayName":"Prepare Statement Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Allows the plugin to use a custom org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy to control preparation of the query and prepared statement."}}} +{"component":{"kind":"component","name":"jdbc","title":"JDBC","description":"Access databases through SQL and JDBC.","deprecated":false,"firstVersion":"1.2.0","label":"database","javaType":"org.apache.camel.component.jdbc.JdbcComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jdbc","version":"4.8.2","scheme":"jdbc","extendsScheme":"","syntax":"jdbc:dataSourceName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelJdbcUpdateCount":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the query is an UPDATE, query the update count is returned in this OUT header.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_UPDATE_COUNT"},"CamelJdbcRowCount":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the query is a SELECT, query the row count is returned in this OUT header.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_ROW_COUNT"},"CamelJdbcColumnNames":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The column names from the ResultSet as a java.util.Set type.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_COLUMN_NAMES"},"CamelJdbcParameters":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A java.util.Map which has the headers to be used if useHeadersAsParameters has been enabled.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_PARAMETERS"},"CamelRetrieveGeneratedKeys":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Set its value to true to retrieve generated keys","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_RETRIEVE_GENERATED_KEYS"},"CamelGeneratedColumns":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String[] or int[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set it to specify the expected generated columns","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_GENERATED_COLUMNS"},"CamelGeneratedKeysRowCount":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of rows in the header that contains generated keys.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_GENERATED_KEYS_ROW_COUNT"},"CamelGeneratedKeysRows":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Rows that contains the generated keys.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_GENERATED_KEYS_DATA"}},"properties":{"dataSourceName":{"index":0,"kind":"path","displayName":"Data Source Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of DataSource to lookup in the Registry. If the name is dataSource or default, then Camel will attempt to lookup a default DataSource from the registry, meaning if there is a only one instance of DataSource found, then this DataSource will be used."},"allowNamedParameters":{"index":1,"kind":"parameter","displayName":"Allow Named Parameters","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to allow using named parameters in the queries."},"outputClass":{"index":2,"kind":"parameter","displayName":"Output Class","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList."},"outputType":{"index":3,"kind":"parameter","displayName":"Output Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.JdbcOutputType","enum":["SelectOne","SelectList","StreamList"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SelectList","description":"Determines the output the producer should use."},"parameters":{"index":4,"kind":"parameter","displayName":"Parameters","group":"producer","label":"","required":false,"type":"object","javaType":"java.util.Map","prefix":"statement.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Optional parameters to the java.sql.Statement. For example to set maxRows, fetchSize etc."},"readSize":{"index":5,"kind":"parameter","displayName":"Read Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The default maximum number of rows that can be read by a polling query. The default value is 0."},"resetAutoCommit":{"index":6,"kind":"parameter","displayName":"Reset Auto Commit","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Camel will set the autoCommit on the JDBC connection to be false, commit the change after executed the statement and reset the autoCommit flag of the connection at the end, if the resetAutoCommit is true. If the JDBC connection doesn't support to reset the autoCommit flag, you can set the resetAutoCommit flag to be false, and Camel will not try to reset the autoCommit flag. When used with XA transactions you most likely need to set it to false so that the transaction manager is in charge of committing this tx."},"transacted":{"index":7,"kind":"parameter","displayName":"Transacted","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether transactions are in use."},"useGetBytesForBlob":{"index":8,"kind":"parameter","displayName":"Use Get Bytes For Blob","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To read BLOB columns as bytes instead of string data. This may be needed for certain databases such as Oracle where you must read BLOB columns as bytes."},"useHeadersAsParameters":{"index":9,"kind":"parameter","displayName":"Use Headers As Parameters","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Set this option to true to use the prepareStatementStrategy with named parameters. This allows to define queries with named placeholders, and use headers with the dynamic values for the query placeholders."},"useJDBC4ColumnNameAndLabelSemantics":{"index":10,"kind":"parameter","displayName":"Use JDBC4 Column Name And Label Semantics","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name. JDBC 4.0 uses columnLabel to get the column name where as JDBC 3.0 uses both columnName or columnLabel. Unfortunately JDBC drivers behave differently so you can use this option to work out issues around your JDBC driver if you get problem using this component This option is default true."},"lazyStartProducer":{"index":11,"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."},"beanRowMapper":{"index":12,"kind":"parameter","displayName":"Bean Row Mapper","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.BeanRowMapper","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.component.jdbc.BeanRowMapper when using outputClass. The default implementation will lower case the row names and skip underscores, and dashes. For example CUST_ID is mapped as custId."},"connectionStrategy":{"index":13,"kind":"parameter","displayName":"Connection Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.ConnectionStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom strategy for working with connections. Do not use a custom strategy when using the spring-jdbc component because a special Spring ConnectionStrategy is used by default to support Spring Transactions."},"prepareStatementStrategy":{"index":14,"kind":"parameter","displayName":"Prepare Statement Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Allows the plugin to use a custom org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy to control preparation of the query and prepared statement."}}} , -{"component":{"kind":"component","name":"jetty","title":"Jetty","description":"Expose HTTP endpoints using Jetty 12.","deprecated":false,"firstVersion":"1.2.0","label":"http","javaType":"org.apache.camel.component.jetty12.JettyHttpComponent12","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-jetty","version":"4.8.1","scheme":"jetty","extendsScheme":"http","syntax":"jetty:httpUri","async":true,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelServletContextPath":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The servlet context path used","constantName":"org.apache.camel.component.jetty.JettyHttpConstants#SERVLET_CONTEXT_PATH"},"CamelHttpPath":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Request URI's path, the header will be used to build the request URI with the HTTP_URI.","constantName":"org.apache.camel.component.jetty.JettyHttpConstants#HTTP_PATH"}},"properties":{"httpUri":{"index":0,"kind":"path","displayName":"Http Uri","group":"common","label":"common","required":true,"type":"string","javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The url of the HTTP endpoint to call."},"headerFilterStrategy":{"index":1,"kind":"parameter","displayName":"Header Filter Strategy","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"httpBinding":{"index":2,"kind":"parameter","displayName":"Http Binding","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.http.common.HttpBinding","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpBinding to control the mapping between Camel message and HttpClient."},"chunked":{"index":3,"kind":"parameter","displayName":"Chunked","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response"},"disableStreamCache":{"index":4,"kind":"parameter","displayName":"Disable Stream Cache","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The producer (camel-http) will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is (the stream can only be read once) as the message body."},"transferException":{"index":5,"kind":"parameter","displayName":"Transfer Exception","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk."},"async":{"index":6,"kind":"parameter","displayName":"Async","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configure the consumer to work in async mode"},"continuationTimeout":{"index":7,"kind":"parameter","displayName":"Continuation Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of = 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine."},"enableCORS":{"index":8,"kind":"parameter","displayName":"Enable CORS","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, Jetty server will setup the CrossOriginFilter which supports the CORS out of box."},"enableJmx":{"index":9,"kind":"parameter","displayName":"Enable Jmx","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details."},"enableMultipartFilter":{"index":10,"kind":"parameter","displayName":"Enable Multipart Filter","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether org.apache.camel.component.jetty.MultiPartFilter is enabled or not. You should set this value to false when bridging endpoints, to ensure multipart requests is proxied/bridged as well."},"httpMethodRestrict":{"index":11,"kind":"parameter","displayName":"Http Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma."},"logException":{"index":12,"kind":"parameter","displayName":"Log Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side the exception's stack trace will be logged when the exception stack trace is not sent in the response's body."},"matchOnUriPrefix":{"index":13,"kind":"parameter","displayName":"Match On Uri Prefix","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found."},"muteException":{"index":14,"kind":"parameter","displayName":"Mute Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace."},"responseBufferSize":{"index":15,"kind":"parameter","displayName":"Response Buffer Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom buffer size on the jakarta.servlet.ServletResponse."},"sendDateHeader":{"index":16,"kind":"parameter","displayName":"Send Date Header","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, jetty server will send the date header to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected."},"sendServerVersion":{"index":17,"kind":"parameter","displayName":"Send Server Version","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If the option is true, jetty will send the server header with the jetty version information to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected."},"sessionSupport":{"index":18,"kind":"parameter","displayName":"Session Support","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable the session manager on the server side of Jetty."},"useContinuation":{"index":19,"kind":"parameter","displayName":"Use Continuation","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Whether or not to use Jetty continuations for the Jetty Server."},"bridgeErrorHandler":{"index":20,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"eagerCheckContentAvailable":{"index":21,"kind":"parameter","displayName":"Eager Check Content Available","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data."},"exceptionHandler":{"index":22,"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":{"index":23,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"fileSizeThreshold":{"index":24,"kind":"parameter","displayName":"File Size Threshold","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The size threshold after which files will be written to disk for multipart/form-data requests. By default the files are not written to disk"},"filesLocation":{"index":25,"kind":"parameter","displayName":"Files Location","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The directory location where files will be store for multipart/form-data requests. By default the files are written in the system temporary folder"},"filterInitParameters":{"index":26,"kind":"parameter","displayName":"Filter Init Parameters","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"filter.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Configuration of the filter init parameters. These parameters will be applied to the filter list before starting the jetty server."},"filters":{"index":27,"kind":"parameter","displayName":"Filters","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"Allows using a custom filters which is putted into a list and can be find in the Registry. Multiple values can be separated by comma."},"handlers":{"index":28,"kind":"parameter","displayName":"Handlers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"Specifies a comma-delimited set of Handler instances to lookup in your Registry. These handlers are added to the Jetty servlet context (for example, to add security). Important: You can not use different handlers with different Jetty endpoints using the same port number. The handlers is associated to the port number. If you need different handlers, then use different port numbers."},"idleTimeout":{"index":29,"kind":"parameter","displayName":"Idle Timeout","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"The max idle time (in milli seconds) is applied to an HTTP request for IO operations and delayed dispatch. Idle time 0 implies an infinite timeout, -1 (default) implies no HTTP channel timeout and the connection timeout is used instead."},"mapHttpMessageBody":{"index":30,"kind":"parameter","displayName":"Map Http Message Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping."},"mapHttpMessageFormUrlEncodedBody":{"index":31,"kind":"parameter","displayName":"Map Http Message Form Url Encoded Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping."},"mapHttpMessageHeaders":{"index":32,"kind":"parameter","displayName":"Map Http Message Headers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping."},"maxFileSize":{"index":33,"kind":"parameter","displayName":"Max File Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The maximum size allowed for uploaded files. -1 means no limit"},"maxRequestSize":{"index":34,"kind":"parameter","displayName":"Max Request Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The maximum size allowed for multipart/form-data requests. -1 means no limit"},"multipartFilter":{"index":35,"kind":"parameter","displayName":"Multipart Filter","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"jakarta.servlet.Filter","deprecated":false,"autowired":false,"secret":false,"description":"Allows using a custom multipart filter. Note: setting multipartFilterRef forces the value of enableMultipartFilter to true."},"optionsEnabled":{"index":36,"kind":"parameter","displayName":"Options Enabled","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off."},"traceEnabled":{"index":37,"kind":"parameter","displayName":"Trace Enabled","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off."},"sslContextParameters":{"index":38,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"To configure security using SSLContextParameters"}}} +{"component":{"kind":"component","name":"jetty","title":"Jetty","description":"Expose HTTP endpoints using Jetty 12.","deprecated":false,"firstVersion":"1.2.0","label":"http","javaType":"org.apache.camel.component.jetty12.JettyHttpComponent12","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-jetty","version":"4.8.2","scheme":"jetty","extendsScheme":"http","syntax":"jetty:httpUri","async":true,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelServletContextPath":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The servlet context path used","constantName":"org.apache.camel.component.jetty.JettyHttpConstants#SERVLET_CONTEXT_PATH"},"CamelHttpPath":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Request URI's path, the header will be used to build the request URI with the HTTP_URI.","constantName":"org.apache.camel.component.jetty.JettyHttpConstants#HTTP_PATH"}},"properties":{"httpUri":{"index":0,"kind":"path","displayName":"Http Uri","group":"common","label":"common","required":true,"type":"string","javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The url of the HTTP endpoint to call."},"headerFilterStrategy":{"index":1,"kind":"parameter","displayName":"Header Filter Strategy","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"httpBinding":{"index":2,"kind":"parameter","displayName":"Http Binding","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.http.common.HttpBinding","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpBinding to control the mapping between Camel message and HttpClient."},"chunked":{"index":3,"kind":"parameter","displayName":"Chunked","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response"},"disableStreamCache":{"index":4,"kind":"parameter","displayName":"Disable Stream Cache","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The producer (camel-http) will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is (the stream can only be read once) as the message body."},"transferException":{"index":5,"kind":"parameter","displayName":"Transfer Exception","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk."},"async":{"index":6,"kind":"parameter","displayName":"Async","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configure the consumer to work in async mode"},"continuationTimeout":{"index":7,"kind":"parameter","displayName":"Continuation Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of = 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine."},"enableCORS":{"index":8,"kind":"parameter","displayName":"Enable CORS","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, Jetty server will setup the CrossOriginFilter which supports the CORS out of box."},"enableJmx":{"index":9,"kind":"parameter","displayName":"Enable Jmx","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details."},"enableMultipartFilter":{"index":10,"kind":"parameter","displayName":"Enable Multipart Filter","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether org.apache.camel.component.jetty.MultiPartFilter is enabled or not. You should set this value to false when bridging endpoints, to ensure multipart requests is proxied/bridged as well."},"httpMethodRestrict":{"index":11,"kind":"parameter","displayName":"Http Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma."},"logException":{"index":12,"kind":"parameter","displayName":"Log Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side the exception's stack trace will be logged when the exception stack trace is not sent in the response's body."},"matchOnUriPrefix":{"index":13,"kind":"parameter","displayName":"Match On Uri Prefix","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found."},"muteException":{"index":14,"kind":"parameter","displayName":"Mute Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace."},"responseBufferSize":{"index":15,"kind":"parameter","displayName":"Response Buffer Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom buffer size on the jakarta.servlet.ServletResponse."},"sendDateHeader":{"index":16,"kind":"parameter","displayName":"Send Date Header","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, jetty server will send the date header to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected."},"sendServerVersion":{"index":17,"kind":"parameter","displayName":"Send Server Version","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If the option is true, jetty will send the server header with the jetty version information to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected."},"sessionSupport":{"index":18,"kind":"parameter","displayName":"Session Support","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable the session manager on the server side of Jetty."},"useContinuation":{"index":19,"kind":"parameter","displayName":"Use Continuation","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Whether or not to use Jetty continuations for the Jetty Server."},"bridgeErrorHandler":{"index":20,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"eagerCheckContentAvailable":{"index":21,"kind":"parameter","displayName":"Eager Check Content Available","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data."},"exceptionHandler":{"index":22,"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":{"index":23,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"fileSizeThreshold":{"index":24,"kind":"parameter","displayName":"File Size Threshold","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The size threshold after which files will be written to disk for multipart/form-data requests. By default the files are not written to disk"},"filesLocation":{"index":25,"kind":"parameter","displayName":"Files Location","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The directory location where files will be store for multipart/form-data requests. By default the files are written in the system temporary folder"},"filterInitParameters":{"index":26,"kind":"parameter","displayName":"Filter Init Parameters","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"filter.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Configuration of the filter init parameters. These parameters will be applied to the filter list before starting the jetty server."},"filters":{"index":27,"kind":"parameter","displayName":"Filters","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"Allows using a custom filters which is putted into a list and can be find in the Registry. Multiple values can be separated by comma."},"handlers":{"index":28,"kind":"parameter","displayName":"Handlers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"Specifies a comma-delimited set of Handler instances to lookup in your Registry. These handlers are added to the Jetty servlet context (for example, to add security). Important: You can not use different handlers with different Jetty endpoints using the same port number. The handlers is associated to the port number. If you need different handlers, then use different port numbers."},"idleTimeout":{"index":29,"kind":"parameter","displayName":"Idle Timeout","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"The max idle time (in milli seconds) is applied to an HTTP request for IO operations and delayed dispatch. Idle time 0 implies an infinite timeout, -1 (default) implies no HTTP channel timeout and the connection timeout is used instead."},"mapHttpMessageBody":{"index":30,"kind":"parameter","displayName":"Map Http Message Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping."},"mapHttpMessageFormUrlEncodedBody":{"index":31,"kind":"parameter","displayName":"Map Http Message Form Url Encoded Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping."},"mapHttpMessageHeaders":{"index":32,"kind":"parameter","displayName":"Map Http Message Headers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping."},"maxFileSize":{"index":33,"kind":"parameter","displayName":"Max File Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The maximum size allowed for uploaded files. -1 means no limit"},"maxRequestSize":{"index":34,"kind":"parameter","displayName":"Max Request Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The maximum size allowed for multipart/form-data requests. -1 means no limit"},"multipartFilter":{"index":35,"kind":"parameter","displayName":"Multipart Filter","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"jakarta.servlet.Filter","deprecated":false,"autowired":false,"secret":false,"description":"Allows using a custom multipart filter. Note: setting multipartFilterRef forces the value of enableMultipartFilter to true."},"optionsEnabled":{"index":36,"kind":"parameter","displayName":"Options Enabled","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off."},"traceEnabled":{"index":37,"kind":"parameter","displayName":"Trace Enabled","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off."},"sslContextParameters":{"index":38,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"To configure security using SSLContextParameters"}}} , -{"component":{"kind":"component","name":"jgroups","title":"JGroups","description":"Exchange messages with JGroups clusters.","deprecated":false,"firstVersion":"2.13.0","label":"clustering,messaging","javaType":"org.apache.camel.component.jgroups.JGroupsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jgroups","version":"4.8.1","scheme":"jgroups","extendsScheme":"","syntax":"jgroups:clusterName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"JGROUPS_CHANNEL_ADDRESS":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.jgroups.Address","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Address (org.jgroups.Address) of the channel associated with the endpoint.","constantName":"org.apache.camel.component.jgroups.JGroupsConstants#HEADER_JGROUPS_CHANNEL_ADDRESS"},"JGROUPS_DEST":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.jgroups.Address","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Consumer: The org.jgroups.Address instance extracted by org.jgroups.Message.getDest() method of the consumed message. Producer: The custom destination org.jgroups.Address of the message to be sent.","constantName":"org.apache.camel.component.jgroups.JGroupsConstants#HEADER_JGROUPS_DEST"},"JGROUPS_SRC":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.jgroups.Address","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Consumer : The org.jgroups.Address instance extracted by org.jgroups.Message.getSrc() method of the consumed message. Producer: The custom source org.jgroups.Address of the message to be sent.","constantName":"org.apache.camel.component.jgroups.JGroupsConstants#HEADER_JGROUPS_SRC"},"JGROUPS_ORIGINAL_MESSAGE":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.jgroups.Message","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The original org.jgroups.Message instance from which the body of the consumed message has been extracted.","constantName":"org.apache.camel.component.jgroups.JGroupsConstants#HEADER_JGROUPS_ORIGINAL_MESSAGE"}},"properties":{"clusterName":{"index":0,"kind":"path","displayName":"Cluster Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the JGroups cluster the component should connect to."},"channelProperties":{"index":1,"kind":"parameter","displayName":"Channel Properties","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies configuration properties of the JChannel used by the endpoint."},"enableViewMessages":{"index":2,"kind":"parameter","displayName":"Enable View Messages","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set to true, the consumer endpoint will receive org.jgroups.View messages as well (not only org.jgroups.Message instances). By default only regular messages are consumed by the endpoint."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":6,"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."}}} +{"component":{"kind":"component","name":"jgroups","title":"JGroups","description":"Exchange messages with JGroups clusters.","deprecated":false,"firstVersion":"2.13.0","label":"clustering,messaging","javaType":"org.apache.camel.component.jgroups.JGroupsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jgroups","version":"4.8.2","scheme":"jgroups","extendsScheme":"","syntax":"jgroups:clusterName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"JGROUPS_CHANNEL_ADDRESS":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.jgroups.Address","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Address (org.jgroups.Address) of the channel associated with the endpoint.","constantName":"org.apache.camel.component.jgroups.JGroupsConstants#HEADER_JGROUPS_CHANNEL_ADDRESS"},"JGROUPS_DEST":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.jgroups.Address","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Consumer: The org.jgroups.Address instance extracted by org.jgroups.Message.getDest() method of the consumed message. Producer: The custom destination org.jgroups.Address of the message to be sent.","constantName":"org.apache.camel.component.jgroups.JGroupsConstants#HEADER_JGROUPS_DEST"},"JGROUPS_SRC":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.jgroups.Address","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Consumer : The org.jgroups.Address instance extracted by org.jgroups.Message.getSrc() method of the consumed message. Producer: The custom source org.jgroups.Address of the message to be sent.","constantName":"org.apache.camel.component.jgroups.JGroupsConstants#HEADER_JGROUPS_SRC"},"JGROUPS_ORIGINAL_MESSAGE":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.jgroups.Message","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The original org.jgroups.Message instance from which the body of the consumed message has been extracted.","constantName":"org.apache.camel.component.jgroups.JGroupsConstants#HEADER_JGROUPS_ORIGINAL_MESSAGE"}},"properties":{"clusterName":{"index":0,"kind":"path","displayName":"Cluster Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the JGroups cluster the component should connect to."},"channelProperties":{"index":1,"kind":"parameter","displayName":"Channel Properties","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies configuration properties of the JChannel used by the endpoint."},"enableViewMessages":{"index":2,"kind":"parameter","displayName":"Enable View Messages","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set to true, the consumer endpoint will receive org.jgroups.View messages as well (not only org.jgroups.Message instances). By default only regular messages are consumed by the endpoint."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":6,"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."}}} , -{"component":{"kind":"component","name":"jgroups-raft","title":"JGroups raft","description":"Exchange messages with JGroups-raft clusters.","deprecated":false,"firstVersion":"2.24.0","label":"clustering,messaging","javaType":"org.apache.camel.component.jgroups.raft.JGroupsRaftComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jgroups-raft","version":"4.8.1","scheme":"jgroups-raft","extendsScheme":"","syntax":"jgroups-raft:clusterName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"JGROUPSRAFT_LOG_SIZE":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Raft log size in number of entries.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_LOG_SIZE"},"JGROUPSRAFT_COMMIT_INDEX":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit index.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_COMMIT_INDEX"},"JGROUPSRAFT_CURRENT_TERM":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The current raft term.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_CURRENT_TERM"},"JGROUPSRAFT_IS_LEADER":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Whether the node is the Raft Leader or not.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_IS_LEADER"},"JGROUPSRAFT_LAST_APPLIED":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index of the last log entry that was appended to the log.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_LAST_APPLIED"},"JGROUPSRAFT_LEADER_ADDRESS":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.jgroups.Address","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Address ot Raft Leader or not.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_LEADER_ADDRESS"},"JGROUPSRAFT_RAFT_ID":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Raft id of the node.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_RAFT_ID"},"JGROUPSRAFT_EVENT_TYPE":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.jgroups.raft.JGroupsRaftEventType","enum":["LEADER","FOLLOWER","APPLY","READ_CONTENT_FROM","WRITE_CONTENT_TO"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event type","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_EVENT_TYPE"},"JGROUPSRAFT_SET_OFFSET":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Offset to use in the byte buffer to be set().","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_SET_OFFSET"},"JGROUPSRAFT_SET_LENGTH":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Length to use in the byte buffer to be set().","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_SET_LENGTH"},"JGROUPSRAFT_SET_TIMEOUT":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timeout to be used in set() operation.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_SET_TIMEOUT"},"JGROUPSRAFT_SET_TIMEUNIT":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timeunit to be used in set() operation.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_SET_TIMEUNIT"}},"properties":{"clusterName":{"index":0,"kind":"path","displayName":"Cluster Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the JGroupsraft cluster the component should connect to."},"enableRoleChangeEvents":{"index":1,"kind":"parameter","displayName":"Enable Role Change Events","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set to true, the consumer endpoint will receive roleChange event as well (not just connecting and/or using the state machine). By default it is set to false."},"bridgeErrorHandler":{"index":2,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":3,"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":{"index":4,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":5,"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."}}} +{"component":{"kind":"component","name":"jgroups-raft","title":"JGroups raft","description":"Exchange messages with JGroups-raft clusters.","deprecated":false,"firstVersion":"2.24.0","label":"clustering,messaging","javaType":"org.apache.camel.component.jgroups.raft.JGroupsRaftComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jgroups-raft","version":"4.8.2","scheme":"jgroups-raft","extendsScheme":"","syntax":"jgroups-raft:clusterName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"JGROUPSRAFT_LOG_SIZE":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Raft log size in number of entries.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_LOG_SIZE"},"JGROUPSRAFT_COMMIT_INDEX":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit index.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_COMMIT_INDEX"},"JGROUPSRAFT_CURRENT_TERM":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The current raft term.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_CURRENT_TERM"},"JGROUPSRAFT_IS_LEADER":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Whether the node is the Raft Leader or not.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_IS_LEADER"},"JGROUPSRAFT_LAST_APPLIED":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index of the last log entry that was appended to the log.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_LAST_APPLIED"},"JGROUPSRAFT_LEADER_ADDRESS":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.jgroups.Address","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Address ot Raft Leader or not.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_LEADER_ADDRESS"},"JGROUPSRAFT_RAFT_ID":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Raft id of the node.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_RAFT_ID"},"JGROUPSRAFT_EVENT_TYPE":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.jgroups.raft.JGroupsRaftEventType","enum":["LEADER","FOLLOWER","APPLY","READ_CONTENT_FROM","WRITE_CONTENT_TO"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event type","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_EVENT_TYPE"},"JGROUPSRAFT_SET_OFFSET":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Offset to use in the byte buffer to be set().","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_SET_OFFSET"},"JGROUPSRAFT_SET_LENGTH":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Length to use in the byte buffer to be set().","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_SET_LENGTH"},"JGROUPSRAFT_SET_TIMEOUT":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timeout to be used in set() operation.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_SET_TIMEOUT"},"JGROUPSRAFT_SET_TIMEUNIT":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timeunit to be used in set() operation.","constantName":"org.apache.camel.component.jgroups.raft.JGroupsRaftConstants#HEADER_JGROUPSRAFT_SET_TIMEUNIT"}},"properties":{"clusterName":{"index":0,"kind":"path","displayName":"Cluster Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the JGroupsraft cluster the component should connect to."},"enableRoleChangeEvents":{"index":1,"kind":"parameter","displayName":"Enable Role Change Events","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set to true, the consumer endpoint will receive roleChange event as well (not just connecting and/or using the state machine). By default it is set to false."},"bridgeErrorHandler":{"index":2,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":3,"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":{"index":4,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":5,"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."}}} , -{"component":{"kind":"component","name":"jira","title":"Jira","description":"Interact with JIRA issue tracker.","deprecated":false,"firstVersion":"3.0","label":"document","javaType":"org.apache.camel.component.jira.JiraComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jira","version":"4.8.1","scheme":"jira","extendsScheme":"","syntax":"jira:type","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"IssueAssigneeId":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The assignee's id of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_ASSIGNEE_ID"},"IssueAssignee":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The assignee's name of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_ASSIGNEE"},"IssueComponents":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The comma separated list of the issue's components","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_COMPONENTS"},"IssueChanged":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the updated field (i.e Status)","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_CHANGED"},"IssueKey":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_KEY"},"IssuePriorityId":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The priority's id of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_PRIORITY_ID"},"IssuePriorityName":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The priority's name of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_PRIORITY_NAME"},"ProjectKey":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project's id of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_PROJECT_KEY"},"IssueSummary":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The summary of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_SUMMARY"},"IssueTransitionId":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The transition id","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_TRANSITION_ID"},"IssueTypeId":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type's id of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_TYPE_ID"},"IssueTypeName":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type's name of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_TYPE_NAME"},"IssueWatchedIssues":{"index":12,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of all issue keys that are watched in the time of update","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_WATCHED_ISSUES"},"IssueWatchersAdd":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The comma separated list of watchers to add to the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_WATCHERS_ADD"},"IssueWatchersRemove":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The watchers of the issue to remove","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_WATCHERS_REMOVE"},"ParentIssueKey":{"index":15,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the parent issue","constantName":"org.apache.camel.component.jira.JiraConstants#PARENT_ISSUE_KEY"},"ChildIssueKey":{"index":16,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the child issue","constantName":"org.apache.camel.component.jira.JiraConstants#CHILD_ISSUE_KEY"},"linkType":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of link","constantName":"org.apache.camel.component.jira.JiraConstants#LINK_TYPE"},"minutesSpent":{"index":18,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"-1","description":"The minutes spent","constantName":"org.apache.camel.component.jira.JiraConstants#MINUTES_SPENT"}},"properties":{"type":{"index":0,"kind":"path","displayName":"Type","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.jira.JiraType","enum":["ADDCOMMENT","ADDISSUE","ATTACH","DELETEISSUE","NEWISSUES","NEWCOMMENTS","WATCHUPDATES","UPDATEISSUE","TRANSITIONISSUE","WATCHERS","ADDISSUELINK","ADDWORKLOG","FETCHISSUE","FETCHCOMMENTS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation to perform. Consumers: NewIssues, NewComments. Producers: AddIssue, AttachFile, DeleteIssue, TransitionIssue, UpdateIssue, Watchers. See this class javadoc description for more information."},"delay":{"index":1,"kind":"parameter","displayName":"Delay","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"6000","configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"Time in milliseconds to elapse for the next poll."},"jiraUrl":{"index":2,"kind":"parameter","displayName":"Jira Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"The Jira server url, for example http://my_jira.com:8081."},"jql":{"index":3,"kind":"parameter","displayName":"Jql","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"JQL is the query language from JIRA which allows you to retrieve the data you want. For example jql=project=MyProject Where MyProject is the product key in Jira. It is important to use the RAW() and set the JQL inside it to prevent camel parsing it, example: RAW(project in (MYP, COM) AND resolution = Unresolved)"},"maxResults":{"index":4,"kind":"parameter","displayName":"Max Results","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"50","description":"Max number of issues to search for"},"sendEmptyMessageWhenIdle":{"index":5,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"sendOnlyUpdatedField":{"index":6,"kind":"parameter","displayName":"Send Only Updated Field","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Indicator for sending only changed fields in exchange body or issue object. By default consumer sends only changed fields."},"watchedFields":{"index":7,"kind":"parameter","displayName":"Watched Fields","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Status,Priority","description":"Comma separated list of fields to watch for changes. Status,Priority are the defaults."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":12,"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."},"backoffErrorThreshold":{"index":13,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":14,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":15,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"greedy":{"index":16,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":17,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":18,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":19,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":20,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":21,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":22,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":23,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":24,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":25,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":26,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(OAuth or Personal Access Token authentication) The access token generated by the Jira server."},"consumerKey":{"index":27,"kind":"parameter","displayName":"Consumer Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(OAuth only) The consumer key from Jira settings."},"password":{"index":28,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(Basic authentication only) The password or the API Token to authenticate to the Jira server. Use only if username basic authentication is used."},"privateKey":{"index":29,"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(OAuth only) The private key generated by the client to encrypt the conversation to the server."},"username":{"index":30,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(Basic authentication only) The username to authenticate to the Jira server. Use only if OAuth is not enabled on the Jira server. Do not set the username and OAuth token parameter, if they are both set, the username basic authentication takes precedence."},"verificationCode":{"index":31,"kind":"parameter","displayName":"Verification Code","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(OAuth only) The verification code from Jira generated in the first step of the authorization proccess."}}} +{"component":{"kind":"component","name":"jira","title":"Jira","description":"Interact with JIRA issue tracker.","deprecated":false,"firstVersion":"3.0","label":"document","javaType":"org.apache.camel.component.jira.JiraComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jira","version":"4.8.2","scheme":"jira","extendsScheme":"","syntax":"jira:type","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"IssueAssigneeId":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The assignee's id of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_ASSIGNEE_ID"},"IssueAssignee":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The assignee's name of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_ASSIGNEE"},"IssueComponents":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The comma separated list of the issue's components","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_COMPONENTS"},"IssueChanged":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the updated field (i.e Status)","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_CHANGED"},"IssueKey":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_KEY"},"IssuePriorityId":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The priority's id of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_PRIORITY_ID"},"IssuePriorityName":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The priority's name of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_PRIORITY_NAME"},"ProjectKey":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project's id of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_PROJECT_KEY"},"IssueSummary":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The summary of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_SUMMARY"},"IssueTransitionId":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The transition id","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_TRANSITION_ID"},"IssueTypeId":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type's id of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_TYPE_ID"},"IssueTypeName":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type's name of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_TYPE_NAME"},"IssueWatchedIssues":{"index":12,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of all issue keys that are watched in the time of update","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_WATCHED_ISSUES"},"IssueWatchersAdd":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The comma separated list of watchers to add to the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_WATCHERS_ADD"},"IssueWatchersRemove":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The watchers of the issue to remove","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_WATCHERS_REMOVE"},"ParentIssueKey":{"index":15,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the parent issue","constantName":"org.apache.camel.component.jira.JiraConstants#PARENT_ISSUE_KEY"},"ChildIssueKey":{"index":16,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the child issue","constantName":"org.apache.camel.component.jira.JiraConstants#CHILD_ISSUE_KEY"},"linkType":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of link","constantName":"org.apache.camel.component.jira.JiraConstants#LINK_TYPE"},"minutesSpent":{"index":18,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"-1","description":"The minutes spent","constantName":"org.apache.camel.component.jira.JiraConstants#MINUTES_SPENT"}},"properties":{"type":{"index":0,"kind":"path","displayName":"Type","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.jira.JiraType","enum":["ADDCOMMENT","ADDISSUE","ATTACH","DELETEISSUE","NEWISSUES","NEWCOMMENTS","WATCHUPDATES","UPDATEISSUE","TRANSITIONISSUE","WATCHERS","ADDISSUELINK","ADDWORKLOG","FETCHISSUE","FETCHCOMMENTS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation to perform. Consumers: NewIssues, NewComments. Producers: AddIssue, AttachFile, DeleteIssue, TransitionIssue, UpdateIssue, Watchers. See this class javadoc description for more information."},"delay":{"index":1,"kind":"parameter","displayName":"Delay","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"6000","configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"Time in milliseconds to elapse for the next poll."},"jiraUrl":{"index":2,"kind":"parameter","displayName":"Jira Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"The Jira server url, for example http://my_jira.com:8081."},"jql":{"index":3,"kind":"parameter","displayName":"Jql","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"JQL is the query language from JIRA which allows you to retrieve the data you want. For example jql=project=MyProject Where MyProject is the product key in Jira. It is important to use the RAW() and set the JQL inside it to prevent camel parsing it, example: RAW(project in (MYP, COM) AND resolution = Unresolved)"},"maxResults":{"index":4,"kind":"parameter","displayName":"Max Results","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"50","description":"Max number of issues to search for"},"sendEmptyMessageWhenIdle":{"index":5,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"sendOnlyUpdatedField":{"index":6,"kind":"parameter","displayName":"Send Only Updated Field","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Indicator for sending only changed fields in exchange body or issue object. By default consumer sends only changed fields."},"watchedFields":{"index":7,"kind":"parameter","displayName":"Watched Fields","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Status,Priority","description":"Comma separated list of fields to watch for changes. Status,Priority are the defaults."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":12,"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."},"backoffErrorThreshold":{"index":13,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":14,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":15,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"greedy":{"index":16,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":17,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":18,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":19,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":20,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":21,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":22,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":23,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":24,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":25,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":26,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(OAuth or Personal Access Token authentication) The access token generated by the Jira server."},"consumerKey":{"index":27,"kind":"parameter","displayName":"Consumer Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(OAuth only) The consumer key from Jira settings."},"password":{"index":28,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(Basic authentication only) The password or the API Token to authenticate to the Jira server. Use only if username basic authentication is used."},"privateKey":{"index":29,"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(OAuth only) The private key generated by the client to encrypt the conversation to the server."},"username":{"index":30,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(Basic authentication only) The username to authenticate to the Jira server. Use only if OAuth is not enabled on the Jira server. Do not set the username and OAuth token parameter, if they are both set, the username basic authentication takes precedence."},"verificationCode":{"index":31,"kind":"parameter","displayName":"Verification Code","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(OAuth only) The verification code from Jira generated in the first step of the authorization proccess."}}} , -{"component":{"kind":"component","name":"jms","title":"JMS","description":"Sent and receive messages to/from a JMS Queue or Topic.","deprecated":false,"firstVersion":"1.0.0","label":"messaging","javaType":"org.apache.camel.component.jms.JmsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jms","version":"4.8.1","scheme":"jms","extendsScheme":"","syntax":"jms:destinationType:destinationName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJmsDestination":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION"},"CamelJmsDestinationName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic to use as destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME"},"CamelJMSDestinationProduced":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic the message was sent to.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME_PRODUCED"},"JMSXGroupID":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS group ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_X_GROUP_ID"},"JMSMessageID":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS unique message ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_MESSAGE_ID"},"JMSCorrelationID":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID"},"JMSCorrelationIDAsBytes":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID as bytes.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID_AS_BYTES"},"JMSDeliveryMode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS delivery mode.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DELIVERY_MODE"},"JMSDestination":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DESTINATION"},"JMSExpiration":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS expiration.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_EXPIRATION"},"JMSPriority":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS priority (with 0 as the lowest priority and 9 as the highest).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_PRIORITY"},"JMSRedelivered":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is the JMS message redelivered.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REDELIVERED"},"JMSTimestamp":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS timestamp.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TIMESTAMP"},"JMSReplyTo":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS reply-to destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REPLY_TO"},"JMSType":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TYPE"},"JMSXUserID":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XUser id.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_XUSER_ID"},"CamelJmsMessageType":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text","Blob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_MESSAGE_TYPE"},"CamelJmsRequestTimeout":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"20_000","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_REQUEST_TIMEOUT"}},"properties":{"destinationType":{"index":0,"kind":"path","displayName":"Destination Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["queue","topic","temp-queue","temp-topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"queue","description":"The kind of destination to use"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the queue or topic to use as destination"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions with JMS 1.1."},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"","required":false,"type":"object","javaType":"jakarta.jms.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"disableReplyTo":{"index":4,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."},"durableSubscriptionName":{"index":5,"kind":"parameter","displayName":"Durable Subscription Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."},"jmsMessageType":{"index":6,"kind":"parameter","displayName":"Jms Message Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to force the use of a specific jakarta.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it."},"replyTo":{"index":7,"kind":"parameter","displayName":"Reply To","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)."},"testConnectionOnStartup":{"index":8,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"acknowledgementModeName":{"index":9,"kind":"parameter","displayName":"Acknowledgement Mode Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["SESSION_TRANSACTED","CLIENT_ACKNOWLEDGE","AUTO_ACKNOWLEDGE","DUPS_OK_ACKNOWLEDGE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO_ACKNOWLEDGE","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"},"artemisConsumerPriority":{"index":10,"kind":"parameter","displayName":"Artemis Consumer Priority","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Consumer priorities allow you to ensure that high priority consumers receive messages while they are active. Normally, active consumers connected to a queue receive messages from it in a round-robin fashion. When consumer priorities are in use, messages are delivered round-robin if multiple active consumers exist with the same high priority. Messages will only going to lower priority consumers when the high priority consumers do not have credit available to consume the message, or those high priority consumers have declined to accept the message (for instance because it does not meet the criteria of any selectors associated with the consumer)."},"asyncConsumer":{"index":11,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."},"autoStartup":{"index":12,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer container should auto-startup."},"cacheLevel":{"index":13,"kind":"parameter","displayName":"Cache Level","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details."},"cacheLevelName":{"index":14,"kind":"parameter","displayName":"Cache Level Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CACHE_AUTO","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information."},"concurrentConsumers":{"index":15,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"maxConcurrentConsumers":{"index":16,"kind":"parameter","displayName":"Max Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"replyToDeliveryPersistent":{"index":17,"kind":"parameter","displayName":"Reply To Delivery Persistent","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use persistent delivery by default for replies."},"selector":{"index":18,"kind":"parameter","displayName":"Selector","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS selector to use"},"subscriptionDurable":{"index":19,"kind":"parameter","displayName":"Subscription Durable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well."},"subscriptionName":{"index":20,"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.jms.JmsConfiguration","configurationField":"configuration","description":"Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0)."},"subscriptionShared":{"index":21,"kind":"parameter","displayName":"Subscription Shared","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker."},"acceptMessagesWhileStopping":{"index":22,"kind":"parameter","displayName":"Accept Messages While Stopping","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option, if you start and stop JMS routes at runtime, while there are still messages enqueued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected, and the JMS broker would have to attempt redeliveries, which yet again may be rejected, and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option."},"allowReplyManagerQuickStop":{"index":23,"kind":"parameter","displayName":"Allow Reply Manager Quick Stop","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping is enabled, and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag."},"consumerType":{"index":24,"kind":"parameter","displayName":"Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type to use, which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"defaultTaskExecutorType":{"index":25,"kind":"parameter","displayName":"Default Task Executor Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.DefaultTaskExecutorType","enum":["ThreadPool","SimpleAsync"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer, for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached thread-pool-like). If not set, it defaults to the previous behaviour, which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers."},"eagerLoadingOfProperties":{"index":26,"kind":"parameter","displayName":"Eager Loading Of Properties","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties. See also the option eagerPoisonBody."},"eagerPoisonBody":{"index":27,"kind":"parameter","displayName":"Eager Poison Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Poison JMS message due to ${exception.message}","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties."},"exceptionHandler":{"index":28,"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":{"index":29,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"exposeListenerSession":{"index":30,"kind":"parameter","displayName":"Expose Listener Session","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the listener session should be exposed when consuming messages."},"replyToConsumerType":{"index":31,"kind":"parameter","displayName":"Reply To Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type of the reply consumer (when doing request/reply), which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"replyToSameDestinationAllowed":{"index":32,"kind":"parameter","displayName":"Reply To Same Destination Allowed","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself."},"taskExecutor":{"index":33,"kind":"parameter","displayName":"Task Executor","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.springframework.core.task.TaskExecutor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to specify a custom task executor for consuming messages."},"deliveryDelay":{"index":34,"kind":"parameter","displayName":"Delivery Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets delivery delay to use for send calls for JMS. This option requires JMS 2.0 compliant broker."},"deliveryMode":{"index":35,"kind":"parameter","displayName":"Delivery Mode","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","enum":["1","2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."},"deliveryPersistent":{"index":36,"kind":"parameter","displayName":"Delivery Persistent","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether persistent delivery is used by default."},"explicitQosEnabled":{"index":37,"kind":"parameter","displayName":"Explicit Qos Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."},"formatDateHeadersToIso8601":{"index":38,"kind":"parameter","displayName":"Format Date Headers To Iso8601","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether JMS date properties should be formatted according to the ISO 8601 standard."},"preserveMessageQos":{"index":39,"kind":"parameter","displayName":"Preserve Message Qos","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."},"priority":{"index":40,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","enum":["1","2","3","4","5","6","7","8","9"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":4,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect."},"replyToConcurrentConsumers":{"index":41,"kind":"parameter","displayName":"Reply To Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToMaxConcurrentConsumers":{"index":42,"kind":"parameter","displayName":"Reply To Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToOnTimeoutMaxConcurrentConsumers":{"index":43,"kind":"parameter","displayName":"Reply To On Timeout Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS."},"replyToOverride":{"index":44,"kind":"parameter","displayName":"Reply To Override","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."},"replyToType":{"index":45,"kind":"parameter","displayName":"Reply To Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ReplyToType","enum":["Temporary","Shared","Exclusive"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary, Shared, or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details, and especially the notes about the implications if running in a clustered environment, and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive."},"requestTimeout":{"index":46,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."},"timeToLive":{"index":47,"kind":"parameter","displayName":"Time To Live","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending messages, specifies the time-to-live of the message (in milliseconds)."},"allowAdditionalHeaders":{"index":48,"kind":"parameter","displayName":"Allow Additional Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"This option is used to allow additional headers which may have values that are invalid according to JMS specification. For example, some message systems, such as WMQ, do this with header names using prefix JMS_IBM_MQMD_ containing values with byte array or other invalid types. You can specify multiple header names separated by comma, and use as suffix for wildcard matching."},"allowNullBody":{"index":49,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."},"alwaysCopyMessage":{"index":50,"kind":"parameter","displayName":"Always Copy Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set)"},"correlationProperty":{"index":51,"kind":"parameter","displayName":"Correlation Property","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages. If set messages will be correlated solely on the value of this property JMSCorrelationID property will be ignored and not set by Camel."},"disableTimeToLive":{"index":52,"kind":"parameter","displayName":"Disable Time To Live","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."},"forceSendOriginalMessage":{"index":53,"kind":"parameter","displayName":"Force Send Original Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received."},"includeSentJMSMessageID":{"index":54,"kind":"parameter","displayName":"Include Sent JMSMessage ID","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination."},"lazyStartProducer":{"index":55,"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."},"replyToCacheLevelName":{"index":56,"kind":"parameter","displayName":"Reply To Cache Level Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed, and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION."},"replyToDestinationSelectorName":{"index":57,"kind":"parameter","displayName":"Reply To Destination Selector Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is, if you are not using a temporary reply queue)."},"streamMessageTypeEnabled":{"index":58,"kind":"parameter","displayName":"Stream Message Type Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data."},"allowSerializedHeaders":{"index":59,"kind":"parameter","displayName":"Allow Serialized Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Controls whether or not to include serialized headers. Applies only when transferExchange is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."},"artemisStreamingEnabled":{"index":60,"kind":"parameter","displayName":"Artemis Streaming Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether optimizing for Apache Artemis streaming mode. This can reduce memory overhead when using Artemis with JMS StreamMessage types. This option must only be enabled if Apache Artemis is being used."},"asyncStartListener":{"index":61,"kind":"parameter","displayName":"Async Start Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to startup the JmsConsumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail-over. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry."},"asyncStopListener":{"index":62,"kind":"parameter","displayName":"Async Stop Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to stop the JmsConsumer message listener asynchronously, when stopping a route."},"destinationResolver":{"index":63,"kind":"parameter","displayName":"Destination Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.destination.DestinationResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example, to lookup the real destination in a JNDI registry)."},"errorHandler":{"index":64,"kind":"parameter","displayName":"Error Handler","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.util.ErrorHandler","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level, if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure, than having to code a custom errorHandler."},"exceptionListener":{"index":65,"kind":"parameter","displayName":"Exception Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.jms.ExceptionListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions."},"headerFilterStrategy":{"index":66,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"idleConsumerLimit":{"index":67,"kind":"parameter","displayName":"Idle Consumer Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specify the limit for the number of consumers that are allowed to be idle at any given time."},"idleTaskExecutionLimit":{"index":68,"kind":"parameter","displayName":"Idle Task Execution Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring."},"includeAllJMSXProperties":{"index":69,"kind":"parameter","displayName":"Include All JMSXProperties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to include all JMSX prefixed properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply."},"jmsKeyFormatStrategy":{"index":70,"kind":"parameter","displayName":"Jms Key Format Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsKeyFormatStrategy","enum":["default","passthrough"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation."},"mapJmsMessage":{"index":71,"kind":"parameter","displayName":"Map Jms Message","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc."},"maxMessagesPerTask":{"index":72,"kind":"parameter","displayName":"Max Messages Per Task","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max), then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required."},"messageConverter":{"index":73,"kind":"parameter","displayName":"Message Converter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.converter.MessageConverter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a jakarta.jms.Message."},"messageCreatedStrategy":{"index":74,"kind":"parameter","displayName":"Message Created Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageCreatedStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message."},"messageIdEnabled":{"index":75,"kind":"parameter","displayName":"Message Id Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending, specifies whether message IDs should be added. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value."},"messageListenerContainerFactory":{"index":76,"kind":"parameter","displayName":"Message Listener Container Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageListenerContainerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom."},"messageTimestampEnabled":{"index":77,"kind":"parameter","displayName":"Message Timestamp Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint the timestamp must be set to its normal value."},"pubSubNoLocal":{"index":78,"kind":"parameter","displayName":"Pub Sub No Local","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to inhibit the delivery of messages published by its own connection."},"receiveTimeout":{"index":79,"kind":"parameter","displayName":"Receive Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for receiving messages (in milliseconds)."},"recoveryInterval":{"index":80,"kind":"parameter","displayName":"Recovery Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds."},"requestTimeoutCheckerInterval":{"index":81,"kind":"parameter","displayName":"Request Timeout Checker Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs, then you can lower this interval, to check more frequently. The timeout is determined by the option requestTimeout."},"synchronous":{"index":82,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used"},"temporaryQueueResolver":{"index":83,"kind":"parameter","displayName":"Temporary Queue Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.TemporaryQueueResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable TemporaryQueueResolver that allows you to use your own resolver for creating temporary queues (some messaging systems has special requirements for creating temporary queues)."},"transferException":{"index":84,"kind":"parameter","displayName":"Transfer Exception","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!"},"transferExchange":{"index":85,"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body, Out body, Fault body, In headers, Out headers, Fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side, so Camel knows the payloads is an Exchange and not a regular payload. Use this with caution as the data is using Java Object serialization and requires the receiver to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumers having to use compatible Camel versions!"},"useMessageIDAsCorrelationID":{"index":86,"kind":"parameter","displayName":"Use Message IDAs Correlation ID","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages."},"waitForProvisionCorrelationToBeUpdatedCounter":{"index":87,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":50,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled."},"waitForProvisionCorrelationToBeUpdatedThreadSleepingTime":{"index":88,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for provisional correlation id to be updated."},"waitForTemporaryReplyToToBeUpdatedCounter":{"index":89,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":200,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for temporary replyTo queue to be created and ready when doing request/reply over JMS."},"waitForTemporaryReplyToToBeUpdatedThreadSleepingTime":{"index":90,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for temporary replyTo queue to be ready."},"errorHandlerLoggingLevel":{"index":91,"kind":"parameter","displayName":"Error Handler Logging Level","group":"logging","label":"consumer,logging","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to configure the default errorHandler logging level for logging uncaught exceptions."},"errorHandlerLogStackTrace":{"index":92,"kind":"parameter","displayName":"Error Handler Log Stack Trace","group":"logging","label":"consumer,logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to control whether stack-traces should be logged or not, by the default errorHandler."},"password":{"index":93,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"username":{"index":94,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"transacted":{"index":95,"kind":"parameter","displayName":"Transacted","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use transacted mode"},"transactedInOut":{"index":96,"kind":"parameter","displayName":"Transacted In Out","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether InOut operations (request reply) default to using transacted mode If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations. Note from Spring JMS: that within a JTA transaction, the parameters passed to createQueue, createTopic methods are not taken into account. Depending on the Java EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since Spring JMS operates on an existing JMS Session in this case. Setting this flag to true will use a short local JMS transaction when running outside of a managed transaction, and a synchronized local JMS transaction in case of a managed transaction (other than an XA transaction) being present. This has the effect of a local JMS transaction being managed alongside the main transaction (which might be a native JDBC transaction), with the JMS transaction committing right after the main transaction."},"lazyCreateTransactionManager":{"index":97,"kind":"parameter","displayName":"Lazy Create Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true."},"transactionManager":{"index":98,"kind":"parameter","displayName":"Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"object","javaType":"org.springframework.transaction.PlatformTransactionManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The Spring transaction manager to use."},"transactionName":{"index":99,"kind":"parameter","displayName":"Transaction Name","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The name of the transaction to use."},"transactionTimeout":{"index":100,"kind":"parameter","displayName":"Transaction Timeout","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout value of the transaction (in seconds), if using transacted mode."}}} +{"component":{"kind":"component","name":"jms","title":"JMS","description":"Sent and receive messages to/from a JMS Queue or Topic.","deprecated":false,"firstVersion":"1.0.0","label":"messaging","javaType":"org.apache.camel.component.jms.JmsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jms","version":"4.8.2","scheme":"jms","extendsScheme":"","syntax":"jms:destinationType:destinationName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJmsDestination":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION"},"CamelJmsDestinationName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic to use as destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME"},"CamelJMSDestinationProduced":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic the message was sent to.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME_PRODUCED"},"JMSXGroupID":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS group ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_X_GROUP_ID"},"JMSMessageID":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS unique message ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_MESSAGE_ID"},"JMSCorrelationID":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID"},"JMSCorrelationIDAsBytes":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID as bytes.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID_AS_BYTES"},"JMSDeliveryMode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS delivery mode.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DELIVERY_MODE"},"JMSDestination":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DESTINATION"},"JMSExpiration":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS expiration.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_EXPIRATION"},"JMSPriority":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS priority (with 0 as the lowest priority and 9 as the highest).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_PRIORITY"},"JMSRedelivered":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is the JMS message redelivered.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REDELIVERED"},"JMSTimestamp":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS timestamp.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TIMESTAMP"},"JMSReplyTo":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS reply-to destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REPLY_TO"},"JMSType":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TYPE"},"JMSXUserID":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XUser id.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_XUSER_ID"},"CamelJmsMessageType":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text","Blob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_MESSAGE_TYPE"},"CamelJmsRequestTimeout":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"20_000","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_REQUEST_TIMEOUT"}},"properties":{"destinationType":{"index":0,"kind":"path","displayName":"Destination Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["queue","topic","temp-queue","temp-topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"queue","description":"The kind of destination to use"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the queue or topic to use as destination"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions with JMS 1.1."},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"","required":false,"type":"object","javaType":"jakarta.jms.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"disableReplyTo":{"index":4,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."},"durableSubscriptionName":{"index":5,"kind":"parameter","displayName":"Durable Subscription Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."},"jmsMessageType":{"index":6,"kind":"parameter","displayName":"Jms Message Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to force the use of a specific jakarta.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it."},"replyTo":{"index":7,"kind":"parameter","displayName":"Reply To","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)."},"testConnectionOnStartup":{"index":8,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"acknowledgementModeName":{"index":9,"kind":"parameter","displayName":"Acknowledgement Mode Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["SESSION_TRANSACTED","CLIENT_ACKNOWLEDGE","AUTO_ACKNOWLEDGE","DUPS_OK_ACKNOWLEDGE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO_ACKNOWLEDGE","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"},"artemisConsumerPriority":{"index":10,"kind":"parameter","displayName":"Artemis Consumer Priority","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Consumer priorities allow you to ensure that high priority consumers receive messages while they are active. Normally, active consumers connected to a queue receive messages from it in a round-robin fashion. When consumer priorities are in use, messages are delivered round-robin if multiple active consumers exist with the same high priority. Messages will only going to lower priority consumers when the high priority consumers do not have credit available to consume the message, or those high priority consumers have declined to accept the message (for instance because it does not meet the criteria of any selectors associated with the consumer)."},"asyncConsumer":{"index":11,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."},"autoStartup":{"index":12,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer container should auto-startup."},"cacheLevel":{"index":13,"kind":"parameter","displayName":"Cache Level","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details."},"cacheLevelName":{"index":14,"kind":"parameter","displayName":"Cache Level Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CACHE_AUTO","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information."},"concurrentConsumers":{"index":15,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"maxConcurrentConsumers":{"index":16,"kind":"parameter","displayName":"Max Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"replyToDeliveryPersistent":{"index":17,"kind":"parameter","displayName":"Reply To Delivery Persistent","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use persistent delivery by default for replies."},"selector":{"index":18,"kind":"parameter","displayName":"Selector","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS selector to use"},"subscriptionDurable":{"index":19,"kind":"parameter","displayName":"Subscription Durable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well."},"subscriptionName":{"index":20,"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.jms.JmsConfiguration","configurationField":"configuration","description":"Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0)."},"subscriptionShared":{"index":21,"kind":"parameter","displayName":"Subscription Shared","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker."},"acceptMessagesWhileStopping":{"index":22,"kind":"parameter","displayName":"Accept Messages While Stopping","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option, if you start and stop JMS routes at runtime, while there are still messages enqueued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected, and the JMS broker would have to attempt redeliveries, which yet again may be rejected, and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option."},"allowReplyManagerQuickStop":{"index":23,"kind":"parameter","displayName":"Allow Reply Manager Quick Stop","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping is enabled, and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag."},"consumerType":{"index":24,"kind":"parameter","displayName":"Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type to use, which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"defaultTaskExecutorType":{"index":25,"kind":"parameter","displayName":"Default Task Executor Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.DefaultTaskExecutorType","enum":["ThreadPool","SimpleAsync"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer, for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached thread-pool-like). If not set, it defaults to the previous behaviour, which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers."},"eagerLoadingOfProperties":{"index":26,"kind":"parameter","displayName":"Eager Loading Of Properties","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties. See also the option eagerPoisonBody."},"eagerPoisonBody":{"index":27,"kind":"parameter","displayName":"Eager Poison Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Poison JMS message due to ${exception.message}","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties."},"exceptionHandler":{"index":28,"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":{"index":29,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"exposeListenerSession":{"index":30,"kind":"parameter","displayName":"Expose Listener Session","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the listener session should be exposed when consuming messages."},"replyToConsumerType":{"index":31,"kind":"parameter","displayName":"Reply To Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type of the reply consumer (when doing request/reply), which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."},"replyToSameDestinationAllowed":{"index":32,"kind":"parameter","displayName":"Reply To Same Destination Allowed","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself."},"taskExecutor":{"index":33,"kind":"parameter","displayName":"Task Executor","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.springframework.core.task.TaskExecutor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to specify a custom task executor for consuming messages."},"deliveryDelay":{"index":34,"kind":"parameter","displayName":"Delivery Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets delivery delay to use for send calls for JMS. This option requires JMS 2.0 compliant broker."},"deliveryMode":{"index":35,"kind":"parameter","displayName":"Delivery Mode","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","enum":["1","2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."},"deliveryPersistent":{"index":36,"kind":"parameter","displayName":"Delivery Persistent","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether persistent delivery is used by default."},"explicitQosEnabled":{"index":37,"kind":"parameter","displayName":"Explicit Qos Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."},"formatDateHeadersToIso8601":{"index":38,"kind":"parameter","displayName":"Format Date Headers To Iso8601","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether JMS date properties should be formatted according to the ISO 8601 standard."},"preserveMessageQos":{"index":39,"kind":"parameter","displayName":"Preserve Message Qos","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."},"priority":{"index":40,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","enum":["1","2","3","4","5","6","7","8","9"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":4,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect."},"replyToConcurrentConsumers":{"index":41,"kind":"parameter","displayName":"Reply To Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToMaxConcurrentConsumers":{"index":42,"kind":"parameter","displayName":"Reply To Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToOnTimeoutMaxConcurrentConsumers":{"index":43,"kind":"parameter","displayName":"Reply To On Timeout Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS."},"replyToOverride":{"index":44,"kind":"parameter","displayName":"Reply To Override","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."},"replyToType":{"index":45,"kind":"parameter","displayName":"Reply To Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ReplyToType","enum":["Temporary","Shared","Exclusive"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary, Shared, or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details, and especially the notes about the implications if running in a clustered environment, and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive."},"requestTimeout":{"index":46,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."},"timeToLive":{"index":47,"kind":"parameter","displayName":"Time To Live","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending messages, specifies the time-to-live of the message (in milliseconds)."},"allowAdditionalHeaders":{"index":48,"kind":"parameter","displayName":"Allow Additional Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"This option is used to allow additional headers which may have values that are invalid according to JMS specification. For example, some message systems, such as WMQ, do this with header names using prefix JMS_IBM_MQMD_ containing values with byte array or other invalid types. You can specify multiple header names separated by comma, and use as suffix for wildcard matching."},"allowNullBody":{"index":49,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."},"alwaysCopyMessage":{"index":50,"kind":"parameter","displayName":"Always Copy Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set)"},"correlationProperty":{"index":51,"kind":"parameter","displayName":"Correlation Property","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages. If set messages will be correlated solely on the value of this property JMSCorrelationID property will be ignored and not set by Camel."},"disableTimeToLive":{"index":52,"kind":"parameter","displayName":"Disable Time To Live","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."},"forceSendOriginalMessage":{"index":53,"kind":"parameter","displayName":"Force Send Original Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received."},"includeSentJMSMessageID":{"index":54,"kind":"parameter","displayName":"Include Sent JMSMessage ID","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination."},"lazyStartProducer":{"index":55,"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."},"replyToCacheLevelName":{"index":56,"kind":"parameter","displayName":"Reply To Cache Level Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed, and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION."},"replyToDestinationSelectorName":{"index":57,"kind":"parameter","displayName":"Reply To Destination Selector Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is, if you are not using a temporary reply queue)."},"streamMessageTypeEnabled":{"index":58,"kind":"parameter","displayName":"Stream Message Type Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data."},"allowSerializedHeaders":{"index":59,"kind":"parameter","displayName":"Allow Serialized Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Controls whether or not to include serialized headers. Applies only when transferExchange is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."},"artemisStreamingEnabled":{"index":60,"kind":"parameter","displayName":"Artemis Streaming Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether optimizing for Apache Artemis streaming mode. This can reduce memory overhead when using Artemis with JMS StreamMessage types. This option must only be enabled if Apache Artemis is being used."},"asyncStartListener":{"index":61,"kind":"parameter","displayName":"Async Start Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to startup the JmsConsumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail-over. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry."},"asyncStopListener":{"index":62,"kind":"parameter","displayName":"Async Stop Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to stop the JmsConsumer message listener asynchronously, when stopping a route."},"destinationResolver":{"index":63,"kind":"parameter","displayName":"Destination Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.destination.DestinationResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example, to lookup the real destination in a JNDI registry)."},"errorHandler":{"index":64,"kind":"parameter","displayName":"Error Handler","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.util.ErrorHandler","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level, if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure, than having to code a custom errorHandler."},"exceptionListener":{"index":65,"kind":"parameter","displayName":"Exception Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.jms.ExceptionListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions."},"headerFilterStrategy":{"index":66,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"idleConsumerLimit":{"index":67,"kind":"parameter","displayName":"Idle Consumer Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specify the limit for the number of consumers that are allowed to be idle at any given time."},"idleTaskExecutionLimit":{"index":68,"kind":"parameter","displayName":"Idle Task Execution Limit","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring."},"includeAllJMSXProperties":{"index":69,"kind":"parameter","displayName":"Include All JMSXProperties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to include all JMSX prefixed properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply."},"jmsKeyFormatStrategy":{"index":70,"kind":"parameter","displayName":"Jms Key Format Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsKeyFormatStrategy","enum":["default","passthrough"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation."},"mapJmsMessage":{"index":71,"kind":"parameter","displayName":"Map Jms Message","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc."},"maxMessagesPerTask":{"index":72,"kind":"parameter","displayName":"Max Messages Per Task","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max), then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required."},"messageConverter":{"index":73,"kind":"parameter","displayName":"Message Converter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.jms.support.converter.MessageConverter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a jakarta.jms.Message."},"messageCreatedStrategy":{"index":74,"kind":"parameter","displayName":"Message Created Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageCreatedStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message."},"messageIdEnabled":{"index":75,"kind":"parameter","displayName":"Message Id Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending, specifies whether message IDs should be added. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value."},"messageListenerContainerFactory":{"index":76,"kind":"parameter","displayName":"Message Listener Container Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.MessageListenerContainerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom."},"messageTimestampEnabled":{"index":77,"kind":"parameter","displayName":"Message Timestamp Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint the timestamp must be set to its normal value."},"pubSubNoLocal":{"index":78,"kind":"parameter","displayName":"Pub Sub No Local","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to inhibit the delivery of messages published by its own connection."},"receiveTimeout":{"index":79,"kind":"parameter","displayName":"Receive Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for receiving messages (in milliseconds)."},"recoveryInterval":{"index":80,"kind":"parameter","displayName":"Recovery Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds."},"requestTimeoutCheckerInterval":{"index":81,"kind":"parameter","displayName":"Request Timeout Checker Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs, then you can lower this interval, to check more frequently. The timeout is determined by the option requestTimeout."},"synchronous":{"index":82,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used"},"temporaryQueueResolver":{"index":83,"kind":"parameter","displayName":"Temporary Queue Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.TemporaryQueueResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"A pluggable TemporaryQueueResolver that allows you to use your own resolver for creating temporary queues (some messaging systems has special requirements for creating temporary queues)."},"transferException":{"index":84,"kind":"parameter","displayName":"Transfer Exception","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!"},"transferExchange":{"index":85,"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body, Out body, Fault body, In headers, Out headers, Fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side, so Camel knows the payloads is an Exchange and not a regular payload. Use this with caution as the data is using Java Object serialization and requires the receiver to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumers having to use compatible Camel versions!"},"useMessageIDAsCorrelationID":{"index":86,"kind":"parameter","displayName":"Use Message IDAs Correlation ID","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages."},"waitForProvisionCorrelationToBeUpdatedCounter":{"index":87,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":50,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled."},"waitForProvisionCorrelationToBeUpdatedThreadSleepingTime":{"index":88,"kind":"parameter","displayName":"Wait For Provision Correlation To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for provisional correlation id to be updated."},"waitForTemporaryReplyToToBeUpdatedCounter":{"index":89,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Counter","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":200,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Number of times to wait for temporary replyTo queue to be created and ready when doing request/reply over JMS."},"waitForTemporaryReplyToToBeUpdatedThreadSleepingTime":{"index":90,"kind":"parameter","displayName":"Wait For Temporary Reply To To Be Updated Thread Sleeping Time","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Interval in millis to sleep each time while waiting for temporary replyTo queue to be ready."},"errorHandlerLoggingLevel":{"index":91,"kind":"parameter","displayName":"Error Handler Logging Level","group":"logging","label":"consumer,logging","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to configure the default errorHandler logging level for logging uncaught exceptions."},"errorHandlerLogStackTrace":{"index":92,"kind":"parameter","displayName":"Error Handler Log Stack Trace","group":"logging","label":"consumer,logging","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows to control whether stack-traces should be logged or not, by the default errorHandler."},"password":{"index":93,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"username":{"index":94,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."},"transacted":{"index":95,"kind":"parameter","displayName":"Transacted","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use transacted mode"},"transactedInOut":{"index":96,"kind":"parameter","displayName":"Transacted In Out","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether InOut operations (request reply) default to using transacted mode If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations. Note from Spring JMS: that within a JTA transaction, the parameters passed to createQueue, createTopic methods are not taken into account. Depending on the Java EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since Spring JMS operates on an existing JMS Session in this case. Setting this flag to true will use a short local JMS transaction when running outside of a managed transaction, and a synchronized local JMS transaction in case of a managed transaction (other than an XA transaction) being present. This has the effect of a local JMS transaction being managed alongside the main transaction (which might be a native JDBC transaction), with the JMS transaction committing right after the main transaction."},"lazyCreateTransactionManager":{"index":97,"kind":"parameter","displayName":"Lazy Create Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true."},"transactionManager":{"index":98,"kind":"parameter","displayName":"Transaction Manager","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"object","javaType":"org.springframework.transaction.PlatformTransactionManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The Spring transaction manager to use."},"transactionName":{"index":99,"kind":"parameter","displayName":"Transaction Name","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The name of the transaction to use."},"transactionTimeout":{"index":100,"kind":"parameter","displayName":"Transaction Timeout","group":"transaction (advanced)","label":"transaction,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout value of the transaction (in seconds), if using transacted mode."}}} , -{"component":{"kind":"component","name":"jmx","title":"JMX","description":"Receive JMX notifications.","deprecated":false,"firstVersion":"2.6.0","label":"monitoring","javaType":"org.apache.camel.component.jmx.JMXComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jmx","version":"4.8.1","scheme":"jmx","extendsScheme":"","syntax":"jmx:serverURL","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":false},"headers":{"jmx.handback":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The handback.","constantName":"org.apache.camel.component.jmx.JMXConstants#JMX_HANDBACK"}},"properties":{"serverURL":{"index":0,"kind":"path","displayName":"Server URL","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Server url comes from the remaining endpoint. Use platform to connect to local JVM."},"format":{"index":1,"kind":"parameter","displayName":"Format","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["xml","raw"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"xml","description":"Format for the message body. Either xml or raw. If xml, the notification is serialized to xml. If raw, then the raw java object is set as the body."},"granularityPeriod":{"index":2,"kind":"parameter","displayName":"Granularity Period","group":"consumer","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","description":"The frequency to poll the bean to check the monitor (monitor types only)."},"monitorType":{"index":3,"kind":"parameter","displayName":"Monitor Type","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["counter","gauge","string"],"deprecated":false,"autowired":false,"secret":false,"description":"The type of monitor to create. One of string, gauge, counter (monitor types only)."},"objectDomain":{"index":4,"kind":"parameter","displayName":"Object Domain","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The domain for the mbean you're connecting to"},"objectName":{"index":5,"kind":"parameter","displayName":"Object Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name key for the mbean you're connecting to. This value is mutually exclusive with the object properties that get passed."},"observedAttribute":{"index":6,"kind":"parameter","displayName":"Observed Attribute","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The attribute to observe for the monitor bean or consumer."},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"executorService":{"index":10,"kind":"parameter","displayName":"Executor Service","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.concurrent.ExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom shared thread pool for the consumers. By default each consume has their own thread-pool to process and route notifications."},"handback":{"index":11,"kind":"parameter","displayName":"Handback","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Value to handback to the listener when a notification is received. This value will be put in the message header with the key JMXConstants#JMX_HANDBACK."},"notificationFilter":{"index":12,"kind":"parameter","displayName":"Notification Filter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.management.NotificationFilter","deprecated":false,"autowired":false,"secret":false,"description":"Reference to a bean that implements the NotificationFilter."},"objectProperties":{"index":13,"kind":"parameter","displayName":"Object Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"key.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Properties for the object name. These values will be used if the objectName param is not set"},"reconnectDelay":{"index":14,"kind":"parameter","displayName":"Reconnect Delay","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"description":"The number of seconds to wait before attempting to retry establishment of the initial connection or attempt to reconnect a lost connection"},"reconnectOnConnectionFailure":{"index":15,"kind":"parameter","displayName":"Reconnect On Connection Failure","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true the consumer will attempt to reconnect to the JMX server when any connection failure occurs. The consumer will attempt to re-establish the JMX connection every 'x' seconds until the connection is made-- where 'x' is the configured reconnectionDelay"},"testConnectionOnStartup":{"index":16,"kind":"parameter","displayName":"Test Connection On Startup","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If true the consumer will throw an exception if unable to establish the JMX connection upon startup. If false, the consumer will attempt to establish the JMX connection every 'x' seconds until the connection is made -- where 'x' is the configured reconnectionDelay"},"initThreshold":{"index":17,"kind":"parameter","displayName":"Init Threshold","group":"counter","label":"counter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Initial threshold for the monitor. The value must exceed this before notifications are fired (counter monitor only)."},"modulus":{"index":18,"kind":"parameter","displayName":"Modulus","group":"counter","label":"counter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The value at which the counter is reset to zero (counter monitor only)."},"offset":{"index":19,"kind":"parameter","displayName":"Offset","group":"counter","label":"counter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The amount to increment the threshold after it's been exceeded (counter monitor only)."},"differenceMode":{"index":20,"kind":"parameter","displayName":"Difference Mode","group":"gauge","label":"counter,gauge","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, then the value reported in the notification is the difference from the threshold as opposed to the value itself (counter and gauge monitor only)."},"notifyHigh":{"index":21,"kind":"parameter","displayName":"Notify High","group":"gauge","label":"gauge","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the gauge will fire a notification when the high threshold is exceeded (gauge monitor only)."},"notifyLow":{"index":22,"kind":"parameter","displayName":"Notify Low","group":"gauge","label":"gauge","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the gauge will fire a notification when the low threshold is exceeded (gauge monitor only)."},"thresholdHigh":{"index":23,"kind":"parameter","displayName":"Threshold High","group":"gauge","label":"gauge","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"description":"Value for the gauge's high threshold (gauge monitor only)."},"thresholdLow":{"index":24,"kind":"parameter","displayName":"Threshold Low","group":"gauge","label":"gauge","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"description":"Value for the gauge's low threshold (gauge monitor only)."},"password":{"index":25,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Credentials for making a remote connection"},"user":{"index":26,"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Credentials for making a remote connection"},"notifyDiffer":{"index":27,"kind":"parameter","displayName":"Notify Differ","group":"string","label":"consumer,string","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, will fire a notification when the string attribute differs from the string to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured."},"notifyMatch":{"index":28,"kind":"parameter","displayName":"Notify Match","group":"string","label":"consumer,string","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, will fire a notification when the string attribute matches the string to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured."},"stringToCompare":{"index":29,"kind":"parameter","displayName":"String To Compare","group":"string","label":"consumer,string","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Value for attribute to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured."}}} +{"component":{"kind":"component","name":"jmx","title":"JMX","description":"Receive JMX notifications.","deprecated":false,"firstVersion":"2.6.0","label":"monitoring","javaType":"org.apache.camel.component.jmx.JMXComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jmx","version":"4.8.2","scheme":"jmx","extendsScheme":"","syntax":"jmx:serverURL","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":false},"headers":{"jmx.handback":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The handback.","constantName":"org.apache.camel.component.jmx.JMXConstants#JMX_HANDBACK"}},"properties":{"serverURL":{"index":0,"kind":"path","displayName":"Server URL","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Server url comes from the remaining endpoint. Use platform to connect to local JVM."},"format":{"index":1,"kind":"parameter","displayName":"Format","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["xml","raw"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"xml","description":"Format for the message body. Either xml or raw. If xml, the notification is serialized to xml. If raw, then the raw java object is set as the body."},"granularityPeriod":{"index":2,"kind":"parameter","displayName":"Granularity Period","group":"consumer","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","description":"The frequency to poll the bean to check the monitor (monitor types only)."},"monitorType":{"index":3,"kind":"parameter","displayName":"Monitor Type","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["counter","gauge","string"],"deprecated":false,"autowired":false,"secret":false,"description":"The type of monitor to create. One of string, gauge, counter (monitor types only)."},"objectDomain":{"index":4,"kind":"parameter","displayName":"Object Domain","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The domain for the mbean you're connecting to"},"objectName":{"index":5,"kind":"parameter","displayName":"Object Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name key for the mbean you're connecting to. This value is mutually exclusive with the object properties that get passed."},"observedAttribute":{"index":6,"kind":"parameter","displayName":"Observed Attribute","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The attribute to observe for the monitor bean or consumer."},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"executorService":{"index":10,"kind":"parameter","displayName":"Executor Service","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.concurrent.ExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom shared thread pool for the consumers. By default each consume has their own thread-pool to process and route notifications."},"handback":{"index":11,"kind":"parameter","displayName":"Handback","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Value to handback to the listener when a notification is received. This value will be put in the message header with the key JMXConstants#JMX_HANDBACK."},"notificationFilter":{"index":12,"kind":"parameter","displayName":"Notification Filter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.management.NotificationFilter","deprecated":false,"autowired":false,"secret":false,"description":"Reference to a bean that implements the NotificationFilter."},"objectProperties":{"index":13,"kind":"parameter","displayName":"Object Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"key.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Properties for the object name. These values will be used if the objectName param is not set"},"reconnectDelay":{"index":14,"kind":"parameter","displayName":"Reconnect Delay","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"description":"The number of seconds to wait before attempting to retry establishment of the initial connection or attempt to reconnect a lost connection"},"reconnectOnConnectionFailure":{"index":15,"kind":"parameter","displayName":"Reconnect On Connection Failure","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true the consumer will attempt to reconnect to the JMX server when any connection failure occurs. The consumer will attempt to re-establish the JMX connection every 'x' seconds until the connection is made-- where 'x' is the configured reconnectionDelay"},"testConnectionOnStartup":{"index":16,"kind":"parameter","displayName":"Test Connection On Startup","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If true the consumer will throw an exception if unable to establish the JMX connection upon startup. If false, the consumer will attempt to establish the JMX connection every 'x' seconds until the connection is made -- where 'x' is the configured reconnectionDelay"},"initThreshold":{"index":17,"kind":"parameter","displayName":"Init Threshold","group":"counter","label":"counter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Initial threshold for the monitor. The value must exceed this before notifications are fired (counter monitor only)."},"modulus":{"index":18,"kind":"parameter","displayName":"Modulus","group":"counter","label":"counter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The value at which the counter is reset to zero (counter monitor only)."},"offset":{"index":19,"kind":"parameter","displayName":"Offset","group":"counter","label":"counter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The amount to increment the threshold after it's been exceeded (counter monitor only)."},"differenceMode":{"index":20,"kind":"parameter","displayName":"Difference Mode","group":"gauge","label":"counter,gauge","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, then the value reported in the notification is the difference from the threshold as opposed to the value itself (counter and gauge monitor only)."},"notifyHigh":{"index":21,"kind":"parameter","displayName":"Notify High","group":"gauge","label":"gauge","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the gauge will fire a notification when the high threshold is exceeded (gauge monitor only)."},"notifyLow":{"index":22,"kind":"parameter","displayName":"Notify Low","group":"gauge","label":"gauge","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the gauge will fire a notification when the low threshold is exceeded (gauge monitor only)."},"thresholdHigh":{"index":23,"kind":"parameter","displayName":"Threshold High","group":"gauge","label":"gauge","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"description":"Value for the gauge's high threshold (gauge monitor only)."},"thresholdLow":{"index":24,"kind":"parameter","displayName":"Threshold Low","group":"gauge","label":"gauge","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"description":"Value for the gauge's low threshold (gauge monitor only)."},"password":{"index":25,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Credentials for making a remote connection"},"user":{"index":26,"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Credentials for making a remote connection"},"notifyDiffer":{"index":27,"kind":"parameter","displayName":"Notify Differ","group":"string","label":"consumer,string","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, will fire a notification when the string attribute differs from the string to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured."},"notifyMatch":{"index":28,"kind":"parameter","displayName":"Notify Match","group":"string","label":"consumer,string","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, will fire a notification when the string attribute matches the string to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured."},"stringToCompare":{"index":29,"kind":"parameter","displayName":"String To Compare","group":"string","label":"consumer,string","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Value for attribute to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured."}}} , -{"component":{"kind":"component","name":"jolt","title":"JOLT","description":"JSON to JSON transformation using JOLT.","deprecated":false,"firstVersion":"2.16.0","label":"transformation","javaType":"org.apache.camel.component.jolt.JoltComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jolt","version":"4.8.1","scheme":"jolt","extendsScheme":"","syntax":"jolt:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelJoltResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resource URI","constantName":"org.apache.camel.component.jolt.JoltConstants#JOLT_RESOURCE_URI"},"CamelJoltContext":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The context","constantName":"org.apache.camel.component.jolt.JoltConstants#JOLT_CONTEXT"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowTemplateFromHeader":{"index":1,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":2,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"inputType":{"index":3,"kind":"parameter","displayName":"Input Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jolt.JoltInputOutputType","enum":["Hydrated","JsonString"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Hydrated","description":"Specifies if the input is hydrated JSON or a JSON String."},"outputType":{"index":4,"kind":"parameter","displayName":"Output Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jolt.JoltInputOutputType","enum":["Hydrated","JsonString"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Hydrated","description":"Specifies if the output should be hydrated JSON or a JSON String."},"transformDsl":{"index":5,"kind":"parameter","displayName":"Transform Dsl","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jolt.JoltTransformType","enum":["Chainr","Shiftr","Defaultr","Removr","Sortr"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Chainr","description":"Specifies the Transform DSL of the endpoint resource. If none is specified Chainr will be used."},"lazyStartProducer":{"index":6,"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."}}} +{"component":{"kind":"component","name":"jolt","title":"JOLT","description":"JSON to JSON transformation using JOLT.","deprecated":false,"firstVersion":"2.16.0","label":"transformation","javaType":"org.apache.camel.component.jolt.JoltComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jolt","version":"4.8.2","scheme":"jolt","extendsScheme":"","syntax":"jolt:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelJoltResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resource URI","constantName":"org.apache.camel.component.jolt.JoltConstants#JOLT_RESOURCE_URI"},"CamelJoltContext":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The context","constantName":"org.apache.camel.component.jolt.JoltConstants#JOLT_CONTEXT"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowTemplateFromHeader":{"index":1,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":2,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"inputType":{"index":3,"kind":"parameter","displayName":"Input Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jolt.JoltInputOutputType","enum":["Hydrated","JsonString"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Hydrated","description":"Specifies if the input is hydrated JSON or a JSON String."},"outputType":{"index":4,"kind":"parameter","displayName":"Output Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jolt.JoltInputOutputType","enum":["Hydrated","JsonString"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Hydrated","description":"Specifies if the output should be hydrated JSON or a JSON String."},"transformDsl":{"index":5,"kind":"parameter","displayName":"Transform Dsl","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jolt.JoltTransformType","enum":["Chainr","Shiftr","Defaultr","Removr","Sortr"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Chainr","description":"Specifies the Transform DSL of the endpoint resource. If none is specified Chainr will be used."},"lazyStartProducer":{"index":6,"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."}}} , -{"component":{"kind":"component","name":"jooq","title":"JOOQ","description":"Store and retrieve Java objects from an SQL database using JOOQ.","deprecated":false,"firstVersion":"3.0.0","label":"database","javaType":"org.apache.camel.component.jooq.JooqComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jooq","version":"4.8.1","scheme":"jooq","extendsScheme":"","syntax":"jooq:entityType","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"entityType":{"index":0,"kind":"path","displayName":"Entity Type","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jooq.JooqConfiguration","configurationField":"configuration","description":"JOOQ entity class"},"databaseConfiguration":{"index":1,"kind":"parameter","displayName":"Database Configuration","group":"common","label":"common","required":false,"type":"object","javaType":"org.jooq.Configuration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jooq.JooqConfiguration","configurationField":"configuration","description":"To use a specific database configuration"},"consumeDelete":{"index":2,"kind":"parameter","displayName":"Consume Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jooq.JooqConfiguration","configurationField":"configuration","description":"Delete entity after it is consumed"},"sendEmptyMessageWhenIdle":{"index":3,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":7,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"operation":{"index":8,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.jooq.JooqOperation","enum":["EXECUTE","FETCH","NONE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"NONE","configurationClass":"org.apache.camel.component.jooq.JooqConfiguration","configurationField":"configuration","description":"Type of operation to execute on query"},"query":{"index":9,"kind":"parameter","displayName":"Query","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jooq.JooqConfiguration","configurationField":"configuration","description":"To execute plain SQL query"},"lazyStartProducer":{"index":10,"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."},"backoffErrorThreshold":{"index":11,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":12,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":13,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":14,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":15,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":16,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":17,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":18,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":19,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":20,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":21,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":22,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":23,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":24,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} +{"component":{"kind":"component","name":"jooq","title":"JOOQ","description":"Store and retrieve Java objects from an SQL database using JOOQ.","deprecated":false,"firstVersion":"3.0.0","label":"database","javaType":"org.apache.camel.component.jooq.JooqComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jooq","version":"4.8.2","scheme":"jooq","extendsScheme":"","syntax":"jooq:entityType","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"entityType":{"index":0,"kind":"path","displayName":"Entity Type","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jooq.JooqConfiguration","configurationField":"configuration","description":"JOOQ entity class"},"databaseConfiguration":{"index":1,"kind":"parameter","displayName":"Database Configuration","group":"common","label":"common","required":false,"type":"object","javaType":"org.jooq.Configuration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jooq.JooqConfiguration","configurationField":"configuration","description":"To use a specific database configuration"},"consumeDelete":{"index":2,"kind":"parameter","displayName":"Consume Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jooq.JooqConfiguration","configurationField":"configuration","description":"Delete entity after it is consumed"},"sendEmptyMessageWhenIdle":{"index":3,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":7,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"operation":{"index":8,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.jooq.JooqOperation","enum":["EXECUTE","FETCH","NONE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"NONE","configurationClass":"org.apache.camel.component.jooq.JooqConfiguration","configurationField":"configuration","description":"Type of operation to execute on query"},"query":{"index":9,"kind":"parameter","displayName":"Query","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jooq.JooqConfiguration","configurationField":"configuration","description":"To execute plain SQL query"},"lazyStartProducer":{"index":10,"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."},"backoffErrorThreshold":{"index":11,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":12,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":13,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":14,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":15,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":16,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":17,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":18,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":19,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":20,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":21,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":22,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":23,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":24,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} , -{"component":{"kind":"component","name":"jpa","title":"JPA","description":"Store and retrieve Java objects from databases using Java Persistence API (JPA).","deprecated":false,"firstVersion":"1.0.0","label":"database","javaType":"org.apache.camel.component.jpa.JpaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jpa","version":"4.8.1","scheme":"jpa","extendsScheme":"","syntax":"jpa:entityType","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelEntityManager":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.persistence.EntityManager","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JPA EntityManager object.","constantName":"org.apache.camel.component.jpa.JpaConstants#ENTITY_MANAGER"},"CamelJpaParameters":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Alternative way for passing query parameters as an Exchange header.","constantName":"org.apache.camel.component.jpa.JpaConstants#JPA_PARAMETERS_HEADER"},"CamelJpaMaximumResults":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Defines the maximum number of results to retrieve on the query; takes precedence over the value set on the endpoint, if any.","constantName":"org.apache.camel.component.jpa.JpaConstants#JPA_MAXIMUM_RESULTS"},"CamelJpaFirstResult":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Defines the position of the first result to retrieve; takes precedence over the value set on the endpoint, if any.","constantName":"org.apache.camel.component.jpa.JpaConstants#JPA_FIRST_RESULT"}},"properties":{"entityType":{"index":0,"kind":"path","displayName":"Entity Type","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Entity class name"},"joinTransaction":{"index":1,"kind":"parameter","displayName":"Join Transaction","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"The camel-jpa component will join transaction by default. You can use this option to turn this off, for example, if you use LOCAL_RESOURCE and join transaction doesn't work with your JPA provider. This option can also be set globally on the JpaComponent, instead of having to set it on all endpoints."},"maximumResults":{"index":2,"kind":"parameter","displayName":"Maximum Results","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Set the maximum number of results to retrieve on the Query."},"namedQuery":{"index":3,"kind":"parameter","displayName":"Named Query","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a named query."},"nativeQuery":{"index":4,"kind":"parameter","displayName":"Native Query","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom native query. You may want to use the option resultClass also when using native queries."},"persistenceUnit":{"index":5,"kind":"parameter","displayName":"Persistence Unit","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"camel","description":"The JPA persistence unit used by default."},"query":{"index":6,"kind":"parameter","displayName":"Query","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom query."},"resultClass":{"index":7,"kind":"parameter","displayName":"Result Class","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"Defines the type of the returned payload (we will call entityManager.createNativeQuery(nativeQuery, resultClass) instead of entityManager.createNativeQuery(nativeQuery)). Without this option, we will return an object array. Only has an effect when using in conjunction with a native query when consuming data."},"consumeDelete":{"index":8,"kind":"parameter","displayName":"Consume Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If true, the entity is deleted after it is consumed; if false, the entity is not deleted."},"consumeLockEntity":{"index":9,"kind":"parameter","displayName":"Consume Lock Entity","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether to set an exclusive lock on each entity bean while processing the results from polling."},"deleteHandler":{"index":10,"kind":"parameter","displayName":"Delete Handler","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.jpa.DeleteHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom DeleteHandler to delete the row after the consumer is done processing the exchange"},"lockModeType":{"index":11,"kind":"parameter","displayName":"Lock Mode Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"jakarta.persistence.LockModeType","enum":["READ","WRITE","OPTIMISTIC","OPTIMISTIC_FORCE_INCREMENT","PESSIMISTIC_READ","PESSIMISTIC_WRITE","PESSIMISTIC_FORCE_INCREMENT","NONE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PESSIMISTIC_WRITE","description":"To configure the lock mode on the consumer."},"maxMessagesPerPoll":{"index":12,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"An integer value to define the maximum number of messages to gather per poll. By default, no maximum is set. It can be used to avoid polling many thousands of messages when starting up the server. Set a value of 0 or negative to disable."},"preDeleteHandler":{"index":13,"kind":"parameter","displayName":"Pre Delete Handler","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.jpa.DeleteHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom Pre-DeleteHandler to delete the row after the consumer has read the entity."},"sendEmptyMessageWhenIdle":{"index":14,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skipLockedEntity":{"index":15,"kind":"parameter","displayName":"Skip Locked Entity","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To configure whether to use NOWAIT on lock and silently skip the entity."},"transacted":{"index":16,"kind":"parameter","displayName":"Transacted","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to run the consumer in transacted mode, by which all messages will either commit or rollback, when the entire batch has been processed. The default behavior (false) is to commit all the previously successfully processed messages, and only roll back the last failed message."},"bridgeErrorHandler":{"index":17,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":18,"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":{"index":19,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"parameters":{"index":20,"kind":"parameter","displayName":"Parameters","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"parameters.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"This key/value mapping is used for building the query parameters. It is expected to be of the generic type java.util.Map where the keys are the named parameters of a given JPA query and the values are their corresponding effective values you want to select for. When it's used for producer, Simple expression can be used as a parameter value. It allows you to retrieve parameter values from the message body, header and etc."},"pollStrategy":{"index":21,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"findEntity":{"index":22,"kind":"parameter","displayName":"Find Entity","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled, then the producer will find a single entity by using the message body as a key and entityType as the class type. This can be used instead of a query to find a single entity."},"firstResult":{"index":23,"kind":"parameter","displayName":"First Result","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Set the position of the first result to retrieve."},"flushOnSend":{"index":24,"kind":"parameter","displayName":"Flush On Send","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Flushes the EntityManager after the entity bean has been persisted."},"outputTarget":{"index":25,"kind":"parameter","displayName":"Output Target","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To put the query (or find) result in a header or property instead of the body. If the value starts with the prefix property:, put the result into the so named property, otherwise into the header."},"remove":{"index":26,"kind":"parameter","displayName":"Remove","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Indicates to use entityManager.remove(entity)."},"singleResult":{"index":27,"kind":"parameter","displayName":"Single Result","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled, a query or a find which would return no results or more than one result, will throw an exception instead."},"useExecuteUpdate":{"index":28,"kind":"parameter","displayName":"Use Execute Update","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"To configure whether to use executeUpdate() when producer executes a query. When you use INSERT, UPDATE or a DELETE statement as a named query, you need to specify this option to 'true'."},"usePersist":{"index":29,"kind":"parameter","displayName":"Use Persist","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Indicates to use entityManager.persist(entity) instead of entityManager.merge(entity). Note: entityManager.persist(entity) doesn't work for detached entities (where the EntityManager has to execute an UPDATE instead of an INSERT query)!"},"lazyStartProducer":{"index":30,"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."},"usePassedInEntityManager":{"index":31,"kind":"parameter","displayName":"Use Passed In Entity Manager","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set to true, then Camel will use the EntityManager from the header JpaConstants.ENTITY_MANAGER instead of the configured entity manager on the component/endpoint. This allows end users to control which entity manager will be in use."},"entityManagerProperties":{"index":32,"kind":"parameter","displayName":"Entity Manager Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"emf.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Additional properties for the entity manager to use."},"sharedEntityManager":{"index":33,"kind":"parameter","displayName":"Shared Entity Manager","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to use Spring's SharedEntityManager for the consumer/producer. Note in most cases, joinTransaction should be set to false as this is not an EXTENDED EntityManager."},"backoffErrorThreshold":{"index":34,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":35,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":36,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":37,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":38,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":39,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":40,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":41,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":42,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":43,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":44,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":45,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":46,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":47,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} +{"component":{"kind":"component","name":"jpa","title":"JPA","description":"Store and retrieve Java objects from databases using Java Persistence API (JPA).","deprecated":false,"firstVersion":"1.0.0","label":"database","javaType":"org.apache.camel.component.jpa.JpaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jpa","version":"4.8.2","scheme":"jpa","extendsScheme":"","syntax":"jpa:entityType","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelEntityManager":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.persistence.EntityManager","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JPA EntityManager object.","constantName":"org.apache.camel.component.jpa.JpaConstants#ENTITY_MANAGER"},"CamelJpaParameters":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Alternative way for passing query parameters as an Exchange header.","constantName":"org.apache.camel.component.jpa.JpaConstants#JPA_PARAMETERS_HEADER"},"CamelJpaMaximumResults":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Defines the maximum number of results to retrieve on the query; takes precedence over the value set on the endpoint, if any.","constantName":"org.apache.camel.component.jpa.JpaConstants#JPA_MAXIMUM_RESULTS"},"CamelJpaFirstResult":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Defines the position of the first result to retrieve; takes precedence over the value set on the endpoint, if any.","constantName":"org.apache.camel.component.jpa.JpaConstants#JPA_FIRST_RESULT"}},"properties":{"entityType":{"index":0,"kind":"path","displayName":"Entity Type","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Entity class name"},"joinTransaction":{"index":1,"kind":"parameter","displayName":"Join Transaction","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"The camel-jpa component will join transaction by default. You can use this option to turn this off, for example, if you use LOCAL_RESOURCE and join transaction doesn't work with your JPA provider. This option can also be set globally on the JpaComponent, instead of having to set it on all endpoints."},"maximumResults":{"index":2,"kind":"parameter","displayName":"Maximum Results","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Set the maximum number of results to retrieve on the Query."},"namedQuery":{"index":3,"kind":"parameter","displayName":"Named Query","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a named query."},"nativeQuery":{"index":4,"kind":"parameter","displayName":"Native Query","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom native query. You may want to use the option resultClass also when using native queries."},"persistenceUnit":{"index":5,"kind":"parameter","displayName":"Persistence Unit","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"camel","description":"The JPA persistence unit used by default."},"query":{"index":6,"kind":"parameter","displayName":"Query","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom query."},"resultClass":{"index":7,"kind":"parameter","displayName":"Result Class","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"Defines the type of the returned payload (we will call entityManager.createNativeQuery(nativeQuery, resultClass) instead of entityManager.createNativeQuery(nativeQuery)). Without this option, we will return an object array. Only has an effect when using in conjunction with a native query when consuming data."},"consumeDelete":{"index":8,"kind":"parameter","displayName":"Consume Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If true, the entity is deleted after it is consumed; if false, the entity is not deleted."},"consumeLockEntity":{"index":9,"kind":"parameter","displayName":"Consume Lock Entity","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether to set an exclusive lock on each entity bean while processing the results from polling."},"deleteHandler":{"index":10,"kind":"parameter","displayName":"Delete Handler","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.jpa.DeleteHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom DeleteHandler to delete the row after the consumer is done processing the exchange"},"lockModeType":{"index":11,"kind":"parameter","displayName":"Lock Mode Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"jakarta.persistence.LockModeType","enum":["READ","WRITE","OPTIMISTIC","OPTIMISTIC_FORCE_INCREMENT","PESSIMISTIC_READ","PESSIMISTIC_WRITE","PESSIMISTIC_FORCE_INCREMENT","NONE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PESSIMISTIC_WRITE","description":"To configure the lock mode on the consumer."},"maxMessagesPerPoll":{"index":12,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"An integer value to define the maximum number of messages to gather per poll. By default, no maximum is set. It can be used to avoid polling many thousands of messages when starting up the server. Set a value of 0 or negative to disable."},"preDeleteHandler":{"index":13,"kind":"parameter","displayName":"Pre Delete Handler","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.jpa.DeleteHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom Pre-DeleteHandler to delete the row after the consumer has read the entity."},"sendEmptyMessageWhenIdle":{"index":14,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skipLockedEntity":{"index":15,"kind":"parameter","displayName":"Skip Locked Entity","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To configure whether to use NOWAIT on lock and silently skip the entity."},"transacted":{"index":16,"kind":"parameter","displayName":"Transacted","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to run the consumer in transacted mode, by which all messages will either commit or rollback, when the entire batch has been processed. The default behavior (false) is to commit all the previously successfully processed messages, and only roll back the last failed message."},"bridgeErrorHandler":{"index":17,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":18,"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":{"index":19,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"parameters":{"index":20,"kind":"parameter","displayName":"Parameters","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"parameters.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"This key/value mapping is used for building the query parameters. It is expected to be of the generic type java.util.Map where the keys are the named parameters of a given JPA query and the values are their corresponding effective values you want to select for. When it's used for producer, Simple expression can be used as a parameter value. It allows you to retrieve parameter values from the message body, header and etc."},"pollStrategy":{"index":21,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"findEntity":{"index":22,"kind":"parameter","displayName":"Find Entity","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled, then the producer will find a single entity by using the message body as a key and entityType as the class type. This can be used instead of a query to find a single entity."},"firstResult":{"index":23,"kind":"parameter","displayName":"First Result","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Set the position of the first result to retrieve."},"flushOnSend":{"index":24,"kind":"parameter","displayName":"Flush On Send","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Flushes the EntityManager after the entity bean has been persisted."},"outputTarget":{"index":25,"kind":"parameter","displayName":"Output Target","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To put the query (or find) result in a header or property instead of the body. If the value starts with the prefix property:, put the result into the so named property, otherwise into the header."},"remove":{"index":26,"kind":"parameter","displayName":"Remove","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Indicates to use entityManager.remove(entity)."},"singleResult":{"index":27,"kind":"parameter","displayName":"Single Result","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled, a query or a find which would return no results or more than one result, will throw an exception instead."},"useExecuteUpdate":{"index":28,"kind":"parameter","displayName":"Use Execute Update","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"To configure whether to use executeUpdate() when producer executes a query. When you use INSERT, UPDATE or a DELETE statement as a named query, you need to specify this option to 'true'."},"usePersist":{"index":29,"kind":"parameter","displayName":"Use Persist","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Indicates to use entityManager.persist(entity) instead of entityManager.merge(entity). Note: entityManager.persist(entity) doesn't work for detached entities (where the EntityManager has to execute an UPDATE instead of an INSERT query)!"},"lazyStartProducer":{"index":30,"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."},"usePassedInEntityManager":{"index":31,"kind":"parameter","displayName":"Use Passed In Entity Manager","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set to true, then Camel will use the EntityManager from the header JpaConstants.ENTITY_MANAGER instead of the configured entity manager on the component/endpoint. This allows end users to control which entity manager will be in use."},"entityManagerProperties":{"index":32,"kind":"parameter","displayName":"Entity Manager Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"emf.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Additional properties for the entity manager to use."},"sharedEntityManager":{"index":33,"kind":"parameter","displayName":"Shared Entity Manager","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to use Spring's SharedEntityManager for the consumer/producer. Note in most cases, joinTransaction should be set to false as this is not an EXTENDED EntityManager."},"backoffErrorThreshold":{"index":34,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":35,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":36,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":37,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":38,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":39,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":40,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":41,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":42,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":43,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":44,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":45,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":46,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":47,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} , -{"component":{"kind":"component","name":"jslt","title":"JSLT","description":"Query or transform JSON payloads using JSLT.","deprecated":false,"firstVersion":"3.1.0","label":"transformation","javaType":"org.apache.camel.component.jslt.JsltComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jslt","version":"4.8.1","scheme":"jslt","extendsScheme":"","syntax":"jslt:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelJsltString":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JSLT Template as String","constantName":"org.apache.camel.component.jslt.JsltConstants#HEADER_JSLT_STRING"},"CamelJsltResourceUri":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resource URI","constantName":"org.apache.camel.component.jslt.JsltConstants#HEADER_JSLT_RESOURCE_URI"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"mapBigDecimalAsFloats":{"index":4,"kind":"parameter","displayName":"Map Big Decimal As Floats","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the mapper will use the USE_BIG_DECIMAL_FOR_FLOATS in serialization features"},"objectMapper":{"index":5,"kind":"parameter","displayName":"Object Mapper","group":"producer","label":"","required":false,"type":"object","javaType":"com.fasterxml.jackson.databind.ObjectMapper","deprecated":false,"autowired":false,"secret":false,"description":"Setting a custom JSON Object Mapper to be used"},"prettyPrint":{"index":6,"kind":"parameter","displayName":"Pretty Print","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, JSON in output message is pretty printed."},"lazyStartProducer":{"index":7,"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."}}} +{"component":{"kind":"component","name":"jslt","title":"JSLT","description":"Query or transform JSON payloads using JSLT.","deprecated":false,"firstVersion":"3.1.0","label":"transformation","javaType":"org.apache.camel.component.jslt.JsltComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jslt","version":"4.8.2","scheme":"jslt","extendsScheme":"","syntax":"jslt:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelJsltString":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JSLT Template as String","constantName":"org.apache.camel.component.jslt.JsltConstants#HEADER_JSLT_STRING"},"CamelJsltResourceUri":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resource URI","constantName":"org.apache.camel.component.jslt.JsltConstants#HEADER_JSLT_RESOURCE_URI"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"mapBigDecimalAsFloats":{"index":4,"kind":"parameter","displayName":"Map Big Decimal As Floats","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the mapper will use the USE_BIG_DECIMAL_FOR_FLOATS in serialization features"},"objectMapper":{"index":5,"kind":"parameter","displayName":"Object Mapper","group":"producer","label":"","required":false,"type":"object","javaType":"com.fasterxml.jackson.databind.ObjectMapper","deprecated":false,"autowired":false,"secret":false,"description":"Setting a custom JSON Object Mapper to be used"},"prettyPrint":{"index":6,"kind":"parameter","displayName":"Pretty Print","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, JSON in output message is pretty printed."},"lazyStartProducer":{"index":7,"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."}}} , -{"component":{"kind":"component","name":"json-patch","title":"JsonPatch","description":"Transforms JSON using JSON patch (RFC 6902).","deprecated":false,"firstVersion":"3.12.0","label":"transformation","javaType":"org.apache.camel.component.jsonpatch.JsonPatchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-json-patch","version":"4.8.1","scheme":"json-patch","extendsScheme":"","syntax":"json-patch:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelJsonPatchResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resource URI","constantName":"org.apache.camel.component.jsonpatch.JsonPatchConstants#JSON_PATCH_RESOURCE_URI"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"contentCache":{"index":2,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"lazyStartProducer":{"index":3,"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."}}} +{"component":{"kind":"component","name":"json-patch","title":"JsonPatch","description":"Transforms JSON using JSON patch (RFC 6902).","deprecated":false,"firstVersion":"3.12.0","label":"transformation","javaType":"org.apache.camel.component.jsonpatch.JsonPatchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-json-patch","version":"4.8.2","scheme":"json-patch","extendsScheme":"","syntax":"json-patch:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelJsonPatchResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resource URI","constantName":"org.apache.camel.component.jsonpatch.JsonPatchConstants#JSON_PATCH_RESOURCE_URI"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"contentCache":{"index":2,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"lazyStartProducer":{"index":3,"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."}}} , -{"component":{"kind":"component","name":"json-validator","title":"JSON Schema Validator","description":"Validate JSON payloads using NetworkNT JSON Schema.","deprecated":false,"firstVersion":"2.20.0","label":"validation","javaType":"org.apache.camel.component.jsonvalidator.JsonValidatorComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-json-validator","version":"4.8.1","scheme":"json-validator","extendsScheme":"","syntax":"json-validator:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"contentCache":{"index":2,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"failOnNullBody":{"index":3,"kind":"parameter","displayName":"Fail On Null Body","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to fail if no body exists."},"failOnNullHeader":{"index":4,"kind":"parameter","displayName":"Fail On Null Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to fail if no header exists when validating against a header."},"headerName":{"index":5,"kind":"parameter","displayName":"Header Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To validate against a header instead of the message body."},"lazyStartProducer":{"index":6,"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."},"disabledDeserializationFeatures":{"index":7,"kind":"parameter","displayName":"Disabled Deserialization Features","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Comma-separated list of Jackson DeserializationFeature enum values which will be disabled for parsing exchange body"},"enabledDeserializationFeatures":{"index":8,"kind":"parameter","displayName":"Enabled Deserialization Features","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Comma-separated list of Jackson DeserializationFeature enum values which will be enabled for parsing exchange body"},"errorHandler":{"index":9,"kind":"parameter","displayName":"Error Handler","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jsonvalidator.JsonValidatorErrorHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom ValidatorErrorHandler. The default error handler captures the errors and throws an exception."},"objectMapper":{"index":10,"kind":"parameter","displayName":"Object Mapper","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.fasterxml.jackson.databind.ObjectMapper","deprecated":false,"autowired":false,"secret":false,"description":"The used Jackson object mapper"},"uriSchemaLoader":{"index":11,"kind":"parameter","displayName":"Uri Schema Loader","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jsonvalidator.JsonUriSchemaLoader","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom schema loader allowing for adding custom format validation. The default implementation will create a schema loader that tries to determine the schema version from the $schema property of the specified schema."}}} +{"component":{"kind":"component","name":"json-validator","title":"JSON Schema Validator","description":"Validate JSON payloads using NetworkNT JSON Schema.","deprecated":false,"firstVersion":"2.20.0","label":"validation","javaType":"org.apache.camel.component.jsonvalidator.JsonValidatorComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-json-validator","version":"4.8.2","scheme":"json-validator","extendsScheme":"","syntax":"json-validator:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"contentCache":{"index":2,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"failOnNullBody":{"index":3,"kind":"parameter","displayName":"Fail On Null Body","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to fail if no body exists."},"failOnNullHeader":{"index":4,"kind":"parameter","displayName":"Fail On Null Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to fail if no header exists when validating against a header."},"headerName":{"index":5,"kind":"parameter","displayName":"Header Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To validate against a header instead of the message body."},"lazyStartProducer":{"index":6,"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."},"disabledDeserializationFeatures":{"index":7,"kind":"parameter","displayName":"Disabled Deserialization Features","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Comma-separated list of Jackson DeserializationFeature enum values which will be disabled for parsing exchange body"},"enabledDeserializationFeatures":{"index":8,"kind":"parameter","displayName":"Enabled Deserialization Features","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Comma-separated list of Jackson DeserializationFeature enum values which will be enabled for parsing exchange body"},"errorHandler":{"index":9,"kind":"parameter","displayName":"Error Handler","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jsonvalidator.JsonValidatorErrorHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom ValidatorErrorHandler. The default error handler captures the errors and throws an exception."},"objectMapper":{"index":10,"kind":"parameter","displayName":"Object Mapper","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.fasterxml.jackson.databind.ObjectMapper","deprecated":false,"autowired":false,"secret":false,"description":"The used Jackson object mapper"},"uriSchemaLoader":{"index":11,"kind":"parameter","displayName":"Uri Schema Loader","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jsonvalidator.JsonUriSchemaLoader","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom schema loader allowing for adding custom format validation. The default implementation will create a schema loader that tries to determine the schema version from the $schema property of the specified schema."}}} , -{"component":{"kind":"component","name":"jsonata","title":"JSONata","description":"Transforms JSON payload using JSONata transformation.","deprecated":false,"firstVersion":"3.5.0","label":"transformation","javaType":"org.apache.camel.component.jsonata.JsonataComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jsonata","version":"4.8.1","scheme":"jsonata","extendsScheme":"","syntax":"jsonata:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"contentCache":{"index":2,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"inputType":{"index":3,"kind":"parameter","displayName":"Input Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jsonata.JsonataInputOutputType","enum":["Jackson","JsonString"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Jackson","description":"Specifies if the input should be Jackson JsonNode or a JSON String."},"outputType":{"index":4,"kind":"parameter","displayName":"Output Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jsonata.JsonataInputOutputType","enum":["Jackson","JsonString"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Jackson","description":"Specifies if the output should be Jackson JsonNode or a JSON String."},"lazyStartProducer":{"index":5,"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."},"frameBinding":{"index":6,"kind":"parameter","displayName":"Frame Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jsonata.JsonataFrameBinding","deprecated":false,"autowired":false,"secret":false,"description":"To configure the Jsonata frame binding. Allows custom functions to be added."}}} +{"component":{"kind":"component","name":"jsonata","title":"JSONata","description":"Transforms JSON payload using JSONata transformation.","deprecated":false,"firstVersion":"3.5.0","label":"transformation","javaType":"org.apache.camel.component.jsonata.JsonataComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jsonata","version":"4.8.2","scheme":"jsonata","extendsScheme":"","syntax":"jsonata:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"contentCache":{"index":2,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"inputType":{"index":3,"kind":"parameter","displayName":"Input Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jsonata.JsonataInputOutputType","enum":["Jackson","JsonString"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Jackson","description":"Specifies if the input should be Jackson JsonNode or a JSON String."},"outputType":{"index":4,"kind":"parameter","displayName":"Output Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jsonata.JsonataInputOutputType","enum":["Jackson","JsonString"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Jackson","description":"Specifies if the output should be Jackson JsonNode or a JSON String."},"lazyStartProducer":{"index":5,"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."},"frameBinding":{"index":6,"kind":"parameter","displayName":"Frame Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jsonata.JsonataFrameBinding","deprecated":false,"autowired":false,"secret":false,"description":"To configure the Jsonata frame binding. Allows custom functions to be added."}}} , -{"component":{"kind":"component","name":"jt400","title":"JT400","description":"Exchanges messages with an IBM i system using data queues, message queues, or program call. IBM i is the replacement for AS/400 and iSeries servers.","deprecated":false,"firstVersion":"1.5.0","label":"messaging","javaType":"org.apache.camel.component.jt400.Jt400Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jt400","version":"4.8.1","scheme":"jt400","extendsScheme":"","syntax":"jt400:userID:password@systemName/QSYS.LIB/objectPath.type","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"SENDER_INFORMATION":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Data queues: Returns the sender information for this data queue entry, or an empty string if not available.Message queues: The job identifier of the sending job","constantName":"org.apache.camel.component.jt400.Jt400Constants#SENDER_INFORMATION"},"KEY":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data queue key.","constantName":"org.apache.camel.component.jt400.Jt400Constants#KEY"},"CamelJt400Message":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.ibm.as400.access.QueuedMessage","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message received","constantName":"org.apache.camel.component.jt400.Jt400Constants#MESSAGE"},"CamelJt400MessageID":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message identifier","constantName":"org.apache.camel.component.jt400.Jt400Constants#MESSAGE_ID"},"CamelJt400MessageFile":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message file name","constantName":"org.apache.camel.component.jt400.Jt400Constants#MESSAGE_FILE"},"CamelJt400MessageType":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message type (corresponds to constants defined in the AS400Message class)","constantName":"org.apache.camel.component.jt400.Jt400Constants#MESSAGE_TYPE"},"CamelJt400MessageSeverity":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message severity (Valid values are between 0 and 99, or -1 if it is not set)","constantName":"org.apache.camel.component.jt400.Jt400Constants#MESSAGE_SEVERITY"},"CamelJt400MessageDefaultReply":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The default message reply, when the message is an inquiry message","constantName":"org.apache.camel.component.jt400.Jt400Constants#MESSAGE_DFT_RPY"},"CamelJt400MessageReplyToKey":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Consumer: The key of the message that will be replied to (if the sendingReply parameter is set to true). Producer: If set, and if the message body is not empty, a new message will not be sent to the provided message queue. Instead, a response will be sent to the message identified by the given key. This is set automatically when reading from the message queue if the sendingReply parameter is set to true.","constantName":"org.apache.camel.component.jt400.Jt400Constants#MESSAGE_REPLYTO_KEY"}},"properties":{"userID":{"index":0,"kind":"path","displayName":"User ID","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Returns the ID of the IBM i user."},"password":{"index":1,"kind":"path","displayName":"Password","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Returns the password of the IBM i user."},"systemName":{"index":2,"kind":"path","displayName":"System Name","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Returns the name of the IBM i system."},"objectPath":{"index":3,"kind":"path","displayName":"Object Path","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Returns the fully qualified integrated file system path name of the target object of this endpoint."},"type":{"index":4,"kind":"path","displayName":"Type","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.jt400.Jt400Type","enum":["DTAQ","PGM","SRVPGM","MSGQ"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Whether to work with data queues or remote program call"},"ccsid":{"index":5,"kind":"parameter","displayName":"Ccsid","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Sets the CCSID to use for the connection with the IBM i system."},"format":{"index":6,"kind":"parameter","displayName":"Format","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jt400.Jt400Configuration.Format","enum":["text","binary"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"text","configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Sets the data format for sending messages."},"guiAvailable":{"index":7,"kind":"parameter","displayName":"Gui Available","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Sets whether IBM i prompting is enabled in the environment running Camel."},"keyed":{"index":8,"kind":"parameter","displayName":"Keyed","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Whether to use keyed or non-keyed data queues."},"searchKey":{"index":9,"kind":"parameter","displayName":"Search Key","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Search key for keyed data queues."},"messageAction":{"index":10,"kind":"parameter","displayName":"Message Action","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.jt400.Jt400Configuration.MessageAction","enum":["OLD","REMOVE","SAME"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"OLD","configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Action to be taken on messages when read from a message queue. Messages can be marked as old (OLD), removed from the queue (REMOVE), or neither (SAME)."},"readTimeout":{"index":11,"kind":"parameter","displayName":"Read Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Timeout in millis the consumer will wait while trying to read a new message of the data queue."},"searchType":{"index":12,"kind":"parameter","displayName":"Search Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.jt400.Jt400Configuration.SearchType","enum":["EQ","NE","LT","LE","GT","GE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"EQ","configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Search type such as EQ for equal etc."},"sendEmptyMessageWhenIdle":{"index":13,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"sendingReply":{"index":14,"kind":"parameter","displayName":"Sending Reply","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"If true, the consumer endpoint will set the Jt400Constants.MESSAGE_REPLYTO_KEY header of the camel message for any IBM i inquiry messages received. If that message is then routed to a producer endpoint, the action will not be processed as sending a message to the queue, but rather a reply to the specific inquiry message."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":18,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"outputFieldsIdxArray":{"index":19,"kind":"parameter","displayName":"Output Fields Idx Array","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Integer[]","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Specifies which fields (program parameters) are output parameters."},"outputFieldsLengthArray":{"index":20,"kind":"parameter","displayName":"Output Fields Length Array","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Integer[]","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Specifies the fields (program parameters) length as in the IBM i program definition."},"procedureName":{"index":21,"kind":"parameter","displayName":"Procedure Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Procedure name from a service program to call"},"lazyStartProducer":{"index":22,"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."},"backoffErrorThreshold":{"index":23,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":24,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":25,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":26,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":27,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":28,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":29,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":30,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":31,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":32,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":33,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":34,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":35,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":36,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"secured":{"index":37,"kind":"parameter","displayName":"Secured","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Whether connections to IBM i are secured with SSL."}}} +{"component":{"kind":"component","name":"jt400","title":"JT400","description":"Exchanges messages with an IBM i system using data queues, message queues, or program call. IBM i is the replacement for AS/400 and iSeries servers.","deprecated":false,"firstVersion":"1.5.0","label":"messaging","javaType":"org.apache.camel.component.jt400.Jt400Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jt400","version":"4.8.2","scheme":"jt400","extendsScheme":"","syntax":"jt400:userID:password@systemName/QSYS.LIB/objectPath.type","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"SENDER_INFORMATION":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Data queues: Returns the sender information for this data queue entry, or an empty string if not available.Message queues: The job identifier of the sending job","constantName":"org.apache.camel.component.jt400.Jt400Constants#SENDER_INFORMATION"},"KEY":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data queue key.","constantName":"org.apache.camel.component.jt400.Jt400Constants#KEY"},"CamelJt400Message":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"com.ibm.as400.access.QueuedMessage","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message received","constantName":"org.apache.camel.component.jt400.Jt400Constants#MESSAGE"},"CamelJt400MessageID":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message identifier","constantName":"org.apache.camel.component.jt400.Jt400Constants#MESSAGE_ID"},"CamelJt400MessageFile":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message file name","constantName":"org.apache.camel.component.jt400.Jt400Constants#MESSAGE_FILE"},"CamelJt400MessageType":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message type (corresponds to constants defined in the AS400Message class)","constantName":"org.apache.camel.component.jt400.Jt400Constants#MESSAGE_TYPE"},"CamelJt400MessageSeverity":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message severity (Valid values are between 0 and 99, or -1 if it is not set)","constantName":"org.apache.camel.component.jt400.Jt400Constants#MESSAGE_SEVERITY"},"CamelJt400MessageDefaultReply":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The default message reply, when the message is an inquiry message","constantName":"org.apache.camel.component.jt400.Jt400Constants#MESSAGE_DFT_RPY"},"CamelJt400MessageReplyToKey":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Consumer: The key of the message that will be replied to (if the sendingReply parameter is set to true). Producer: If set, and if the message body is not empty, a new message will not be sent to the provided message queue. Instead, a response will be sent to the message identified by the given key. This is set automatically when reading from the message queue if the sendingReply parameter is set to true.","constantName":"org.apache.camel.component.jt400.Jt400Constants#MESSAGE_REPLYTO_KEY"}},"properties":{"userID":{"index":0,"kind":"path","displayName":"User ID","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Returns the ID of the IBM i user."},"password":{"index":1,"kind":"path","displayName":"Password","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Returns the password of the IBM i user."},"systemName":{"index":2,"kind":"path","displayName":"System Name","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Returns the name of the IBM i system."},"objectPath":{"index":3,"kind":"path","displayName":"Object Path","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Returns the fully qualified integrated file system path name of the target object of this endpoint."},"type":{"index":4,"kind":"path","displayName":"Type","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.jt400.Jt400Type","enum":["DTAQ","PGM","SRVPGM","MSGQ"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Whether to work with data queues or remote program call"},"ccsid":{"index":5,"kind":"parameter","displayName":"Ccsid","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Sets the CCSID to use for the connection with the IBM i system."},"format":{"index":6,"kind":"parameter","displayName":"Format","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jt400.Jt400Configuration.Format","enum":["text","binary"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"text","configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Sets the data format for sending messages."},"guiAvailable":{"index":7,"kind":"parameter","displayName":"Gui Available","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Sets whether IBM i prompting is enabled in the environment running Camel."},"keyed":{"index":8,"kind":"parameter","displayName":"Keyed","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Whether to use keyed or non-keyed data queues."},"searchKey":{"index":9,"kind":"parameter","displayName":"Search Key","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Search key for keyed data queues."},"messageAction":{"index":10,"kind":"parameter","displayName":"Message Action","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.jt400.Jt400Configuration.MessageAction","enum":["OLD","REMOVE","SAME"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"OLD","configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Action to be taken on messages when read from a message queue. Messages can be marked as old (OLD), removed from the queue (REMOVE), or neither (SAME)."},"readTimeout":{"index":11,"kind":"parameter","displayName":"Read Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Timeout in millis the consumer will wait while trying to read a new message of the data queue."},"searchType":{"index":12,"kind":"parameter","displayName":"Search Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.jt400.Jt400Configuration.SearchType","enum":["EQ","NE","LT","LE","GT","GE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"EQ","configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Search type such as EQ for equal etc."},"sendEmptyMessageWhenIdle":{"index":13,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"sendingReply":{"index":14,"kind":"parameter","displayName":"Sending Reply","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"If true, the consumer endpoint will set the Jt400Constants.MESSAGE_REPLYTO_KEY header of the camel message for any IBM i inquiry messages received. If that message is then routed to a producer endpoint, the action will not be processed as sending a message to the queue, but rather a reply to the specific inquiry message."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":18,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"outputFieldsIdxArray":{"index":19,"kind":"parameter","displayName":"Output Fields Idx Array","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Integer[]","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Specifies which fields (program parameters) are output parameters."},"outputFieldsLengthArray":{"index":20,"kind":"parameter","displayName":"Output Fields Length Array","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Integer[]","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Specifies the fields (program parameters) length as in the IBM i program definition."},"procedureName":{"index":21,"kind":"parameter","displayName":"Procedure Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Procedure name from a service program to call"},"lazyStartProducer":{"index":22,"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."},"backoffErrorThreshold":{"index":23,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":24,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":25,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":26,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":27,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":28,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":29,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":30,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":31,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":32,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":33,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":34,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":35,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":36,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"secured":{"index":37,"kind":"parameter","displayName":"Secured","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jt400.Jt400Configuration","configurationField":"configuration","description":"Whether connections to IBM i are secured with SSL."}}} , -{"component":{"kind":"component","name":"jte","title":"JTE","description":"Transform messages using a Java based template engine (JTE).","deprecated":false,"firstVersion":"4.4.0","label":"transformation","javaType":"org.apache.camel.component.jte.JteComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jte","version":"4.8.1","scheme":"jte","extendsScheme":"","syntax":"jte:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelJteResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to use instead of the endpoint configured.","constantName":"org.apache.camel.component.jte.JteConstants#JTE_RESOURCE_URI"},"CamelJteTemplate":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.jte.JteConstants#JTE_TEMPLATE"},"CamelJteDataModel":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data model","constantName":"org.apache.camel.component.jte.JteConstants#JTE_DATA_MODEL"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"lazyStartProducer":{"index":4,"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."}}} +{"component":{"kind":"component","name":"jte","title":"JTE","description":"Transform messages using a Java based template engine (JTE).","deprecated":false,"firstVersion":"4.4.0","label":"transformation","javaType":"org.apache.camel.component.jte.JteComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jte","version":"4.8.2","scheme":"jte","extendsScheme":"","syntax":"jte:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelJteResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to use instead of the endpoint configured.","constantName":"org.apache.camel.component.jte.JteConstants#JTE_RESOURCE_URI"},"CamelJteTemplate":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.jte.JteConstants#JTE_TEMPLATE"},"CamelJteDataModel":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data model","constantName":"org.apache.camel.component.jte.JteConstants#JTE_DATA_MODEL"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"lazyStartProducer":{"index":4,"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."}}} , -{"component":{"kind":"component","name":"kafka","title":"Kafka","description":"Sent and receive messages to/from an Apache Kafka broker.","deprecated":false,"firstVersion":"2.13.0","label":"messaging","javaType":"org.apache.camel.component.kafka.KafkaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kafka","version":"4.8.1","scheme":"kafka","extendsScheme":"","syntax":"kafka:topic","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"kafka.PARTITION_KEY":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Explicitly specify the partition","constantName":"org.apache.camel.component.kafka.KafkaConstants#PARTITION_KEY"},"kafka.PARTITION":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The partition where the message was stored","constantName":"org.apache.camel.component.kafka.KafkaConstants#PARTITION"},"kafka.KEY":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":true,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The key of the message in order to ensure that all related message goes in the same partition. Consumer: The key of the message if configured","constantName":"org.apache.camel.component.kafka.KafkaConstants#KEY"},"kafka.TOPIC":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The topic from where the message originated","constantName":"org.apache.camel.component.kafka.KafkaConstants#TOPIC"},"kafka.OVERRIDE_TOPIC":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The topic to which send the message (override and takes precedence), and the header is not preserved.","constantName":"org.apache.camel.component.kafka.KafkaConstants#OVERRIDE_TOPIC"},"kafka.OFFSET":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The offset of the message","constantName":"org.apache.camel.component.kafka.KafkaConstants#OFFSET"},"kafka.HEADERS":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.kafka.common.header.Headers","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The record headers","constantName":"org.apache.camel.component.kafka.KafkaConstants#HEADERS"},"kafka.LAST_RECORD_BEFORE_COMMIT":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Whether or not it's the last record before commit (only available if autoCommitEnable endpoint parameter is false)","constantName":"org.apache.camel.component.kafka.KafkaConstants#LAST_RECORD_BEFORE_COMMIT"},"kafka.LAST_POLL_RECORD":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates the last record within the current poll request (only available if autoCommitEnable endpoint parameter is false or allowManualCommit is true)","constantName":"org.apache.camel.component.kafka.KafkaConstants#LAST_POLL_RECORD"},"kafka.TIMESTAMP":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message","constantName":"org.apache.camel.component.kafka.KafkaConstants#TIMESTAMP"},"kafka.OVERRIDE_TIMESTAMP":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ProducerRecord also has an associated timestamp. If the user did provide a timestamp, the producer will stamp the record with the provided timestamp and the header is not preserved.","constantName":"org.apache.camel.component.kafka.KafkaConstants#OVERRIDE_TIMESTAMP"},"kafka.RECORD_META":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata (only configured if recordMetadata endpoint parameter is true)","constantName":"org.apache.camel.component.kafka.KafkaConstants#KAFKA_RECORD_META"},"CamelKafkaManualCommit":{"index":12,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.kafka.consumer.KafkaManualCommit","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Can be used for forcing manual offset commit when using Kafka consumer.","constantName":"org.apache.camel.component.kafka.KafkaConstants#MANUAL_COMMIT"}},"properties":{"topic":{"index":0,"kind":"path","displayName":"Topic","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Name of the topic to use. On the consumer you can use comma to separate multiple topics. A producer can only send a message to a single topic."},"additionalProperties":{"index":1,"kind":"parameter","displayName":"Additional Properties","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.Map","prefix":"additionalProperties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Sets additional properties for either kafka consumer or kafka producer in case they can't be set directly on the camel configurations (e.g.: new Kafka properties that are not reflected yet in Camel configurations), the properties have to be prefixed with additionalProperties.., e.g.: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro"},"brokers":{"index":2,"kind":"parameter","displayName":"Brokers","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"URL of the Kafka brokers to use. The format is host1:port1,host2:port2, and the list can be a subset of brokers or a VIP pointing to a subset of brokers. This option is known as bootstrap.servers in the Kafka documentation."},"clientId":{"index":3,"kind":"parameter","displayName":"Client Id","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The client id is a user-specified string sent in each request to help trace calls. It should logically identify the application making the request."},"headerFilterStrategy":{"index":4,"kind":"parameter","displayName":"Header Filter Strategy","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"reconnectBackoffMaxMs":{"index":5,"kind":"parameter","displayName":"Reconnect Backoff Max Ms","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect. If provided, the backoff per host will increase exponentially for each consecutive connection failure, up to this maximum. After calculating the backoff increase, 20% random jitter is added to avoid connection storms."},"retryBackoffMaxMs":{"index":6,"kind":"parameter","displayName":"Retry Backoff Max Ms","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum amount of time in milliseconds to wait when retrying a request to the broker that has repeatedly failed. If provided, the backoff per client will increase exponentially for each failed request, up to this maximum. To prevent all clients from being synchronized upon retry, a randomized jitter with a factor of 0.2 will be applied to the backoff, resulting in the backoff falling within a range between 20% below and 20% above the computed value. If retry.backoff.ms is set to be higher than retry.backoff.max.ms, then retry.backoff.max.ms will be used as a constant backoff from the beginning without any exponential increase"},"retryBackoffMs":{"index":7,"kind":"parameter","displayName":"Retry Backoff Ms","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The amount of time to wait before attempting to retry a failed request to a given topic partition. This avoids repeatedly sending requests in a tight loop under some failure scenarios. This value is the initial backoff value and will increase exponentially for each failed request, up to the retry.backoff.max.ms value."},"shutdownTimeout":{"index":8,"kind":"parameter","displayName":"Shutdown Timeout","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Timeout in milliseconds to wait gracefully for the consumer or producer to shut down and terminate its worker threads."},"allowManualCommit":{"index":9,"kind":"parameter","displayName":"Allow Manual Commit","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Whether to allow doing manual commits via KafkaManualCommit. If this option is enabled then an instance of KafkaManualCommit is stored on the Exchange message header, which allows end users to access this API and perform manual offset commits via the Kafka consumer."},"autoCommitEnable":{"index":10,"kind":"parameter","displayName":"Auto Commit Enable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"If true, periodically commit to ZooKeeper the offset of messages already fetched by the consumer. This committed offset will be used when the process fails as the position from which the new consumer will begin."},"autoCommitIntervalMs":{"index":11,"kind":"parameter","displayName":"Auto Commit Interval Ms","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The frequency in ms that the consumer offsets are committed to zookeeper."},"autoOffsetReset":{"index":12,"kind":"parameter","displayName":"Auto Offset Reset","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["latest","earliest","none"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"latest","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"What to do when there is no initial offset in ZooKeeper or if an offset is out of range: earliest : automatically reset the offset to the earliest offset latest: automatically reset the offset to the latest offset fail: throw exception to the consumer"},"batching":{"index":13,"kind":"parameter","displayName":"Batching","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Whether to use batching for processing or streaming. The default is false, which uses streaming"},"breakOnFirstError":{"index":14,"kind":"parameter","displayName":"Break On First Error","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"This options controls what happens when a consumer is processing an exchange and it fails. If the option is false then the consumer continues to the next message and processes it. If the option is true then the consumer breaks out. Using the default NoopCommitManager will cause the consumer to not commit the offset so that the message is re-attempted. The consumer should use the KafkaManualCommit to determine the best way to handle the message. Using either the SyncCommitManager or the AsyncCommitManager, the consumer will seek back to the offset of the message that caused a failure, and then re-attempt to process this message. However, this can lead to endless processing of the same message if it's bound to fail every time, e.g., a poison message. Therefore, it's recommended to deal with that, for example, by using Camel's error handler."},"checkCrcs":{"index":15,"kind":"parameter","displayName":"Check Crcs","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Automatically check the CRC32 of the records consumed. This ensures no on-the-wire or on-disk corruption to the messages occurred. This check adds some overhead, so it may be disabled in cases seeking extreme performance."},"commitTimeoutMs":{"index":16,"kind":"parameter","displayName":"Commit Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum time, in milliseconds, that the code will wait for a synchronous commit to complete"},"consumerRequestTimeoutMs":{"index":17,"kind":"parameter","displayName":"Consumer Request Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The configuration controls the maximum amount of time the client will wait for the response of a request. If the response is not received before the timeout elapsed, the client will resend the request if necessary or fail the request if retries are exhausted."},"consumersCount":{"index":18,"kind":"parameter","displayName":"Consumers Count","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The number of consumers that connect to kafka server. Each consumer is run on a separate thread that retrieves and process the incoming data."},"fetchMaxBytes":{"index":19,"kind":"parameter","displayName":"Fetch Max Bytes","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"52428800","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum amount of data the server should return for a fetch request. This is not an absolute maximum, if the first message in the first non-empty partition of the fetch is larger than this value, the message will still be returned to ensure that the consumer can make progress. The maximum message size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (topic config). Note that the consumer performs multiple fetches in parallel."},"fetchMinBytes":{"index":20,"kind":"parameter","displayName":"Fetch Min Bytes","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The minimum amount of data the server should return for a fetch request. If insufficient data is available, the request will wait for that much data to accumulate before answering the request."},"fetchWaitMaxMs":{"index":21,"kind":"parameter","displayName":"Fetch Wait Max Ms","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum amount of time the server will block before answering the fetch request if there isn't enough data to immediately satisfy fetch.min.bytes"},"groupId":{"index":22,"kind":"parameter","displayName":"Group Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"A string that uniquely identifies the group of consumer processes to which this consumer belongs. By setting the same group id, multiple processes can indicate that they are all part of the same consumer group. This option is required for consumers."},"groupInstanceId":{"index":23,"kind":"parameter","displayName":"Group Instance Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"A unique identifier of the consumer instance provided by the end user. Only non-empty strings are permitted. If set, the consumer is treated as a static member, which means that only one instance with this ID is allowed in the consumer group at any time. This can be used in combination with a larger session timeout to avoid group rebalances caused by transient unavailability (e.g., process restarts). If not set, the consumer will join the group as a dynamic member, which is the traditional behavior."},"headerDeserializer":{"index":24,"kind":"parameter","displayName":"Header Deserializer","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.kafka.serde.KafkaHeaderDeserializer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"To use a custom KafkaHeaderDeserializer to deserialize kafka headers values"},"heartbeatIntervalMs":{"index":25,"kind":"parameter","displayName":"Heartbeat Interval Ms","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The expected time between heartbeats to the consumer coordinator when using Kafka's group management facilities. Heartbeats are used to ensure that the consumer's session stays active and to facilitate rebalancing when new consumers join or leave the group. The value must be set lower than session.timeout.ms, but typically should be set no higher than 1/3 of that value. It can be adjusted even lower to control the expected time for normal rebalances."},"keyDeserializer":{"index":26,"kind":"parameter","displayName":"Key Deserializer","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.common.serialization.StringDeserializer","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Deserializer class for the key that implements the Deserializer interface."},"maxPartitionFetchBytes":{"index":27,"kind":"parameter","displayName":"Max Partition Fetch Bytes","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1048576","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum amount of data per-partition the server will return. The maximum total memory used for a request will be #partitions max.partition.fetch.bytes. This size must be at least as large as the maximum message size the server allows or else it is possible for the producer to send messages larger than the consumer can fetch. If that happens, the consumer can get stuck trying to fetch a large message on a certain partition."},"maxPollIntervalMs":{"index":28,"kind":"parameter","displayName":"Max Poll Interval Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum delay between invocations of poll() when using consumer group management. This places an upper bound on the amount of time that the consumer can be idle before fetching more records. If poll() is not called before expiration of this timeout, then the consumer is considered failed, and the group will re-balance to reassign the partitions to another member."},"maxPollRecords":{"index":29,"kind":"parameter","displayName":"Max Poll Records","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum number of records returned in a single call to poll()"},"offsetRepository":{"index":30,"kind":"parameter","displayName":"Offset Repository","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.spi.StateRepository","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The offset repository to use to locally store the offset of each partition of the topic. Defining one will disable the autocommit."},"partitionAssignor":{"index":31,"kind":"parameter","displayName":"Partition Assignor","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.clients.consumer.RangeAssignor","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The class name of the partition assignment strategy that the client will use to distribute partition ownership amongst consumer instances when group management is used"},"pollOnError":{"index":32,"kind":"parameter","displayName":"Poll On Error","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.kafka.PollOnError","enum":["DISCARD","ERROR_HANDLER","RECONNECT","RETRY","STOP"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ERROR_HANDLER","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"What to do if kafka threw an exception while polling for new messages. Will by default use the value from the component configuration unless an explicit value has been configured on the endpoint level. DISCARD will discard the message and continue to poll the next message. ERROR_HANDLER will use Camel's error handler to process the exception, and afterwards continue to poll the next message. RECONNECT will re-connect the consumer and try polling the message again. RETRY will let the consumer retry poll the same message again. STOP will stop the consumer (it has to be manually started/restarted if the consumer should be able to consume messages again)"},"pollTimeoutMs":{"index":33,"kind":"parameter","displayName":"Poll Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The timeout used when polling the KafkaConsumer."},"preValidateHostAndPort":{"index":34,"kind":"parameter","displayName":"Pre Validate Host And Port","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Whether to eager validate that broker host:port is valid and can be DNS resolved to known host during starting this consumer. If the validation fails, then an exception is thrown, which makes Camel fail fast. Disabling this will postpone the validation after the consumer is started, and Camel will keep re-connecting in case of validation or DNS resolution error."},"seekTo":{"index":35,"kind":"parameter","displayName":"Seek To","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.kafka.SeekPolicy","enum":["BEGINNING","END"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Set if KafkaConsumer should read from the beginning or the end on startup: SeekPolicy.BEGINNING: read from the beginning. SeekPolicy.END: read from the end."},"sessionTimeoutMs":{"index":36,"kind":"parameter","displayName":"Session Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"45000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The timeout used to detect failures when using Kafka's group management facilities."},"specificAvroReader":{"index":37,"kind":"parameter","displayName":"Specific Avro Reader","group":"consumer","label":"schema,consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"This enables the use of a specific Avro reader for use with the in multiple Schema registries documentation with Avro Deserializers implementation. This option is only available externally (not standard Apache Kafka)"},"topicIsPattern":{"index":38,"kind":"parameter","displayName":"Topic Is Pattern","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Whether the topic is a pattern (regular expression). This can be used to subscribe to dynamic number of topics matching the pattern."},"valueDeserializer":{"index":39,"kind":"parameter","displayName":"Value Deserializer","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.common.serialization.StringDeserializer","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Deserializer class for value that implements the Deserializer interface."},"bridgeErrorHandler":{"index":40,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":41,"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":{"index":42,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"isolationLevel":{"index":43,"kind":"parameter","displayName":"Isolation Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["read_uncommitted","read_committed"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"read_uncommitted","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Controls how to read messages written transactionally. If set to read_committed, consumer.poll() will only return transactional messages which have been committed. If set to read_uncommitted (the default), consumer.poll() will return all messages, even transactional messages which have been aborted. Non-transactional messages will be returned unconditionally in either mode. Messages will always be returned in offset order. Hence, in read_committed mode, consumer.poll() will only return messages up to the last stable offset (LSO), which is the one less than the offset of the first open transaction. In particular, any messages appearing after messages belonging to ongoing transactions will be withheld until the relevant transaction has been completed. As a result, read_committed consumers will not be able to read up to the high watermark when there are in flight transactions. Further, when in read_committed the seekToEnd method will return the LSO"},"kafkaManualCommitFactory":{"index":44,"kind":"parameter","displayName":"Kafka Manual Commit Factory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.kafka.consumer.KafkaManualCommitFactory","deprecated":false,"autowired":false,"secret":false,"description":"Factory to use for creating KafkaManualCommit instances. This allows to plugin a custom factory to create custom KafkaManualCommit instances in case special logic is needed when doing manual commits that deviates from the default implementation that comes out of the box."},"batchWithIndividualHeaders":{"index":45,"kind":"parameter","displayName":"Batch With Individual Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"If this feature is enabled and a single element of a batch is an Exchange or Message, the producer will generate individual kafka header values for it by using the batch Message to determine the values. Normal behavior consists of always using the same header values (which are determined by the parent Exchange which contains the Iterable or Iterator)."},"bufferMemorySize":{"index":46,"kind":"parameter","displayName":"Buffer Memory Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"33554432","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The total bytes of memory the producer can use to buffer records waiting to be sent to the server. If records are sent faster than they can be delivered to the server, the producer will either block or throw an exception based on the preference specified by block.on.buffer.full.This setting should correspond roughly to the total memory the producer will use, but is not a hard bound since not all memory the producer uses is used for buffering. Some additional memory will be used for compression (if compression is enabled) as well as for maintaining in-flight requests."},"compressionCodec":{"index":47,"kind":"parameter","displayName":"Compression Codec","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["none","gzip","snappy","lz4","zstd"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"This parameter allows you to specify the compression codec for all data generated by this producer. Valid values are none, gzip, snappy, lz4 and zstd."},"connectionMaxIdleMs":{"index":48,"kind":"parameter","displayName":"Connection Max Idle Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"540000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Close idle connections after the number of milliseconds specified by this config."},"deliveryTimeoutMs":{"index":49,"kind":"parameter","displayName":"Delivery Timeout Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"120000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"An upper bound on the time to report success or failure after a call to send() returns. This limits the total time that a record will be delayed prior to sending, the time to await acknowledgement from the broker (if expected), and the time allowed for retriable send failures."},"enableIdempotence":{"index":50,"kind":"parameter","displayName":"Enable Idempotence","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"When set to 'true', the producer will ensure that exactly one copy of each message is written in the stream. If 'false', producer retries due to broker failures, etc., may write duplicates of the retried message in the stream. Note that enabling idempotence requires max.in.flight.requests.per.connection to be less than or equal to 5 (with message ordering preserved for any allowable value), retries to be greater than 0, and acks must be 'all'. Idempotence is enabled by default if no conflicting configurations are set. If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled. If idempotence is explicitly enabled and conflicting configurations are set, a ConfigException is thrown."},"headerSerializer":{"index":51,"kind":"parameter","displayName":"Header Serializer","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.kafka.serde.KafkaHeaderSerializer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"To use a custom KafkaHeaderSerializer to serialize kafka headers values"},"key":{"index":52,"kind":"parameter","displayName":"Key","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The record key (or null if no key is specified). If this option has been configured then it take precedence over header KafkaConstants#KEY"},"keySerializer":{"index":53,"kind":"parameter","displayName":"Key Serializer","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.common.serialization.StringSerializer","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The serializer class for keys (defaults to the same as for messages if nothing is given)."},"lingerMs":{"index":54,"kind":"parameter","displayName":"Linger Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The producer groups together any records that arrive in between request transmissions into a single, batched, request. Normally, this occurs only under load when records arrive faster than they can be sent out. However, in some circumstances, the client may want to reduce the number of requests even under a moderate load. This setting achieves this by adding a small amount of artificial delay. That is, rather than immediately sending out a record, the producer will wait for up to the given delay to allow other records to be sent so that they can be batched together. This can be thought of as analogous to Nagle's algorithm in TCP. This setting gives the upper bound on the delay for batching: once we get batch.size worth of records for a partition, it will be sent immediately regardless of this setting, however, if we have fewer than this many bytes accumulated for this partition, we will 'linger' for the specified time waiting for more records to show up. This setting defaults to 0 (i.e., no delay). Setting linger.ms=5, for example, would have the effect of reducing the number of requests sent but would add up to 5ms of latency to records sent in the absence of load."},"maxBlockMs":{"index":55,"kind":"parameter","displayName":"Max Block Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The configuration controls how long the KafkaProducer's send(), partitionsFor(), initTransactions(), sendOffsetsToTransaction(), commitTransaction() and abortTransaction() methods will block. For send() this timeout bounds the total time waiting for both metadata fetch and buffer allocation (blocking in the user-supplied serializers or partitioner is not counted against this timeout). For partitionsFor() this time out bounds the time spent waiting for metadata if it is unavailable. The transaction-related methods always block, but may time out if the transaction coordinator could not be discovered or did not respond within the timeout."},"maxInFlightRequest":{"index":56,"kind":"parameter","displayName":"Max In Flight Request","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum number of unacknowledged requests the client will send on a single connection before blocking. Note that if this setting is set to be greater than 1 and there are failed sends, there is a risk of message re-ordering due to retries (i.e., if retries are enabled)."},"maxRequestSize":{"index":57,"kind":"parameter","displayName":"Max Request Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1048576","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum size of a request. This is also effectively a cap on the maximum record size. Note that the server has its own cap on record size which may be different from this. This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests."},"metadataMaxAgeMs":{"index":58,"kind":"parameter","displayName":"Metadata Max Age Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"300000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions."},"metricReporters":{"index":59,"kind":"parameter","displayName":"Metric Reporters","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"A list of classes to use as metrics reporters. Implementing the MetricReporter interface allows plugging in classes that will be notified of new metric creation. The JmxReporter is always included to register JMX statistics."},"metricsSampleWindowMs":{"index":60,"kind":"parameter","displayName":"Metrics Sample Window Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The window of time a metrics sample is computed over."},"noOfMetricsSample":{"index":61,"kind":"parameter","displayName":"No Of Metrics Sample","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The number of samples maintained to compute metrics."},"partitioner":{"index":62,"kind":"parameter","displayName":"Partitioner","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The partitioner class for partitioning messages amongst sub-topics. The default partitioner is based on the hash of the key."},"partitionerIgnoreKeys":{"index":63,"kind":"parameter","displayName":"Partitioner Ignore Keys","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Whether the message keys should be ignored when computing the partition. This setting has effect only when partitioner is not set"},"partitionKey":{"index":64,"kind":"parameter","displayName":"Partition Key","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The partition to which the record will be sent (or null if no partition was specified). If this option has been configured then it take precedence over header KafkaConstants#PARTITION_KEY"},"producerBatchSize":{"index":65,"kind":"parameter","displayName":"Producer Batch Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"16384","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition. This helps performance on both the client and the server. This configuration controls the default batch size in bytes. No attempt will be made to batch records larger than this size. Requests sent to brokers will contain multiple batches, one for each partition with data available to be sent. A small batch size will make batching less common and may reduce throughput (a batch size of zero will disable batching entirely). A very large batch size may use memory a bit more wastefully as we will always allocate a buffer of the specified batch size in anticipation of additional records."},"queueBufferingMaxMessages":{"index":66,"kind":"parameter","displayName":"Queue Buffering Max Messages","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum number of unsent messages that can be queued up the producer when using async mode before either the producer must be blocked or data must be dropped."},"receiveBufferBytes":{"index":67,"kind":"parameter","displayName":"Receive Buffer Bytes","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"65536","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The size of the TCP receive buffer (SO_RCVBUF) to use when reading data."},"reconnectBackoffMs":{"index":68,"kind":"parameter","displayName":"Reconnect Backoff Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"50","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all requests sent by the consumer to the broker."},"recordMetadata":{"index":69,"kind":"parameter","displayName":"Record Metadata","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Whether the producer should store the RecordMetadata results from sending to Kafka. The results are stored in a List containing the RecordMetadata metadata's. The list is stored on a header with the key KafkaConstants#KAFKA_RECORDMETA"},"requestRequiredAcks":{"index":70,"kind":"parameter","displayName":"Request Required Acks","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["all","-1","0","1"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"all","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The number of acknowledgments the producer requires the leader to have received before considering a request complete. This controls the durability of records that are sent. The following settings are allowed: acks=0 If set to zero, then the producer will not wait for any acknowledgment from the server at all. The record will be immediately added to the socket buffer and considered sent. No guarantee can be made that the server has received the record in this case, and the retry configuration will not take effect (as the client won't generally know of any failures). The offset given back for each record will always be set to -1. acks=1 This will mean the leader will write the record to its local log but will respond without awaiting full acknowledgment from all followers. In this case should the leader fail immediately after acknowledging the record, but before the followers have replicated it, then the record will be lost. acks=all This means the leader will wait for the full set of in-sync replicas to acknowledge the record. This guarantees that the record will not be lost as long as at least one in-sync replica remains alive. This is the strongest available guarantee. This is equivalent to the acks=-1 setting. Note that enabling idempotence requires this config value to be 'all'. If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled."},"requestTimeoutMs":{"index":71,"kind":"parameter","displayName":"Request Timeout Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The amount of time the broker will wait trying to meet the request.required.acks requirement before sending back an error to the client."},"retries":{"index":72,"kind":"parameter","displayName":"Retries","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Setting a value greater than zero will cause the client to resend any record that has failed to be sent due to a potentially transient error. Note that this retry is no different from if the client re-sending the record upon receiving the error. Produce requests will be failed before the number of retries has been exhausted if the timeout configured by delivery.timeout.ms expires first before successful acknowledgement. Users should generally prefer to leave this config unset and instead use delivery.timeout.ms to control retry behavior. Enabling idempotence requires this config value to be greater than 0. If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled. Allowing retries while setting enable.idempotence to false and max.in.flight.requests.per.connection to 1 will potentially change the ordering of records, because if two batches are sent to a single partition, and the first fails and is retried but the second succeeds; then the records in the second batch may appear first."},"sendBufferBytes":{"index":73,"kind":"parameter","displayName":"Send Buffer Bytes","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"131072","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Socket write buffer size"},"useIterator":{"index":74,"kind":"parameter","displayName":"Use Iterator","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Sets whether sending to kafka should send the message body as a single record, or use a java.util.Iterator to send multiple records to kafka (if the message body can be iterated)."},"valueSerializer":{"index":75,"kind":"parameter","displayName":"Value Serializer","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.common.serialization.StringSerializer","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The serializer class for messages."},"workerPool":{"index":76,"kind":"parameter","displayName":"Worker Pool","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.util.concurrent.ExecutorService","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"To use a custom worker pool for continue routing Exchange after kafka server has acknowledged the message that was sent to it from KafkaProducer using asynchronous non-blocking processing. If using this option, then you must handle the lifecycle of the thread pool to shut the pool down when no longer needed."},"workerPoolCoreSize":{"index":77,"kind":"parameter","displayName":"Worker Pool Core Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Number of core threads for the worker pool for continue routing Exchange after kafka server has acknowledged the message that was sent to it from KafkaProducer using asynchronous non-blocking processing."},"workerPoolMaxSize":{"index":78,"kind":"parameter","displayName":"Worker Pool Max Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Maximum number of threads for the worker pool for continue routing Exchange after kafka server has acknowledged the message that was sent to it from KafkaProducer using asynchronous non-blocking processing."},"lazyStartProducer":{"index":79,"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."},"kafkaClientFactory":{"index":80,"kind":"parameter","displayName":"Kafka Client Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.kafka.KafkaClientFactory","deprecated":false,"autowired":false,"secret":false,"description":"Factory to use for creating org.apache.kafka.clients.consumer.KafkaConsumer and org.apache.kafka.clients.producer.KafkaProducer instances. This allows to configure a custom factory to create instances with logic that extends the vanilla Kafka clients."},"synchronous":{"index":81,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used"},"interceptorClasses":{"index":82,"kind":"parameter","displayName":"Interceptor Classes","group":"monitoring","label":"common,monitoring","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Sets interceptors for producer or consumers. Producer interceptors have to be classes implementing org.apache.kafka.clients.producer.ProducerInterceptor Consumer interceptors have to be classes implementing org.apache.kafka.clients.consumer.ConsumerInterceptor Note that if you use Producer interceptor on a consumer it will throw a class cast exception in runtime"},"schemaRegistryURL":{"index":83,"kind":"parameter","displayName":"Schema Registry URL","group":"schema","label":"schema","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"URL of the schema registry servers to use. The format is host1:port1,host2:port2. This is known as schema.registry.url in multiple Schema registries documentation. This option is only available externally (not standard Apache Kafka)"},"kerberosBeforeReloginMinTime":{"index":84,"kind":"parameter","displayName":"Kerberos Before Relogin Min Time","group":"security","label":"common,security","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Login thread sleep time between refresh attempts."},"kerberosConfigLocation":{"index":85,"kind":"parameter","displayName":"Kerberos Config Location","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Location of the kerberos config file."},"kerberosInitCmd":{"index":86,"kind":"parameter","displayName":"Kerberos Init Cmd","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"/usr/bin/kinit","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Kerberos kinit command path. Default is /usr/bin/kinit"},"kerberosPrincipalToLocalRules":{"index":87,"kind":"parameter","displayName":"Kerberos Principal To Local Rules","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEFAULT","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"A list of rules for mapping from principal names to short names (typically operating system usernames). The rules are evaluated in order, and the first rule that matches a principal name is used to map it to a short name. Any later rules in the list are ignored. By default, principal names of the form {username}/{hostname}{REALM} are mapped to {username}. For more details on the format, please see the Security Authorization and ACLs documentation (at the Apache Kafka project website). Multiple values can be separated by comma"},"kerberosRenewJitter":{"index":88,"kind":"parameter","displayName":"Kerberos Renew Jitter","group":"security","label":"common,security","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0.05","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Percentage of random jitter added to the renewal time."},"kerberosRenewWindowFactor":{"index":89,"kind":"parameter","displayName":"Kerberos Renew Window Factor","group":"security","label":"common,security","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0.8","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Login thread will sleep until the specified window factor of time from last refresh to ticket's expiry has been reached, at which time it will try to renew the ticket."},"saslJaasConfig":{"index":90,"kind":"parameter","displayName":"Sasl Jaas Config","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Expose the kafka sasl.jaas.config parameter Example: org.apache.kafka.common.security.plain.PlainLoginModule required username=USERNAME password=PASSWORD;"},"saslKerberosServiceName":{"index":91,"kind":"parameter","displayName":"Sasl Kerberos Service Name","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config."},"saslMechanism":{"index":92,"kind":"parameter","displayName":"Sasl Mechanism","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"GSSAPI","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The Simple Authentication and Security Layer (SASL) Mechanism used. For the valid values see http://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml"},"securityProtocol":{"index":93,"kind":"parameter","displayName":"Security Protocol","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"PLAINTEXT","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Protocol used to communicate with brokers. SASL_PLAINTEXT, PLAINTEXT, SASL_SSL and SSL are supported"},"sslCipherSuites":{"index":94,"kind":"parameter","displayName":"Ssl Cipher Suites","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"A list of cipher suites. This is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol. By default, all the available cipher suites are supported."},"sslContextParameters":{"index":95,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"common,security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"SSL configuration using a Camel SSLContextParameters object. If configured, it's applied before the other SSL endpoint parameters. NOTE: Kafka only supports loading keystore from file locations, so prefix the location with file: in the KeyStoreParameters.resource option."},"sslEnabledProtocols":{"index":96,"kind":"parameter","displayName":"Ssl Enabled Protocols","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The list of protocols enabled for SSL connections. The default is TLSv1.2,TLSv1.3 when running with Java 11 or newer, TLSv1.2 otherwise. With the default value for Java 11, clients and servers will prefer TLSv1.3 if both support it and fallback to TLSv1.2 otherwise (assuming both support at least TLSv1.2). This default should be fine for most cases. Also see the config documentation for SslProtocol."},"sslEndpointAlgorithm":{"index":97,"kind":"parameter","displayName":"Ssl Endpoint Algorithm","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The endpoint identification algorithm to validate server hostname using server certificate. Use none or false to disable server hostname verification."},"sslKeymanagerAlgorithm":{"index":98,"kind":"parameter","displayName":"Ssl Keymanager Algorithm","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"SunX509","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine."},"sslKeyPassword":{"index":99,"kind":"parameter","displayName":"Ssl Key Password","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The password of the private key in the key store file or the PEM key specified in sslKeystoreKey. This is required for clients only if two-way authentication is configured."},"sslKeystoreLocation":{"index":100,"kind":"parameter","displayName":"Ssl Keystore Location","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The location of the key store file. This is optional for the client and can be used for two-way authentication for the client."},"sslKeystorePassword":{"index":101,"kind":"parameter","displayName":"Ssl Keystore Password","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The store password for the key store file. This is optional for the client and only needed if sslKeystoreLocation is configured. Key store password is not supported for PEM format."},"sslKeystoreType":{"index":102,"kind":"parameter","displayName":"Ssl Keystore Type","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"JKS","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The file format of the key store file. This is optional for the client. The default value is JKS"},"sslProtocol":{"index":103,"kind":"parameter","displayName":"Ssl Protocol","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The SSL protocol used to generate the SSLContext. The default is TLSv1.3 when running with Java 11 or newer, TLSv1.2 otherwise. This value should be fine for most use cases. Allowed values in recent JVMs are TLSv1.2 and TLSv1.3. TLS, TLSv1.1, SSL, SSLv2 and SSLv3 may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities. With the default value for this config and sslEnabledProtocols, clients will downgrade to TLSv1.2 if the server does not support TLSv1.3. If this config is set to TLSv1.2, clients will not use TLSv1.3 even if it is one of the values in sslEnabledProtocols and the server only supports TLSv1.3."},"sslProvider":{"index":104,"kind":"parameter","displayName":"Ssl Provider","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The name of the security provider used for SSL connections. Default value is the default security provider of the JVM."},"sslTrustmanagerAlgorithm":{"index":105,"kind":"parameter","displayName":"Ssl Trustmanager Algorithm","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"PKIX","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine."},"sslTruststoreLocation":{"index":106,"kind":"parameter","displayName":"Ssl Truststore Location","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The location of the trust store file."},"sslTruststorePassword":{"index":107,"kind":"parameter","displayName":"Ssl Truststore Password","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The password for the trust store file. If a password is not set, trust store file configured will still be used, but integrity checking is disabled. Trust store password is not supported for PEM format."},"sslTruststoreType":{"index":108,"kind":"parameter","displayName":"Ssl Truststore Type","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"JKS","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The file format of the trust store file. The default value is JKS."}}} +{"component":{"kind":"component","name":"kafka","title":"Kafka","description":"Sent and receive messages to/from an Apache Kafka broker.","deprecated":false,"firstVersion":"2.13.0","label":"messaging","javaType":"org.apache.camel.component.kafka.KafkaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kafka","version":"4.8.2","scheme":"kafka","extendsScheme":"","syntax":"kafka:topic","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"kafka.PARTITION_KEY":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Explicitly specify the partition","constantName":"org.apache.camel.component.kafka.KafkaConstants#PARTITION_KEY"},"kafka.PARTITION":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The partition where the message was stored","constantName":"org.apache.camel.component.kafka.KafkaConstants#PARTITION"},"kafka.KEY":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":true,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The key of the message in order to ensure that all related message goes in the same partition. Consumer: The key of the message if configured","constantName":"org.apache.camel.component.kafka.KafkaConstants#KEY"},"kafka.TOPIC":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The topic from where the message originated","constantName":"org.apache.camel.component.kafka.KafkaConstants#TOPIC"},"kafka.OVERRIDE_TOPIC":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The topic to which send the message (override and takes precedence), and the header is not preserved.","constantName":"org.apache.camel.component.kafka.KafkaConstants#OVERRIDE_TOPIC"},"kafka.OFFSET":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The offset of the message","constantName":"org.apache.camel.component.kafka.KafkaConstants#OFFSET"},"kafka.HEADERS":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.kafka.common.header.Headers","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The record headers","constantName":"org.apache.camel.component.kafka.KafkaConstants#HEADERS"},"kafka.LAST_RECORD_BEFORE_COMMIT":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Whether or not it's the last record before commit (only available if autoCommitEnable endpoint parameter is false)","constantName":"org.apache.camel.component.kafka.KafkaConstants#LAST_RECORD_BEFORE_COMMIT"},"kafka.LAST_POLL_RECORD":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates the last record within the current poll request (only available if autoCommitEnable endpoint parameter is false or allowManualCommit is true)","constantName":"org.apache.camel.component.kafka.KafkaConstants#LAST_POLL_RECORD"},"kafka.TIMESTAMP":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message","constantName":"org.apache.camel.component.kafka.KafkaConstants#TIMESTAMP"},"kafka.OVERRIDE_TIMESTAMP":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ProducerRecord also has an associated timestamp. If the user did provide a timestamp, the producer will stamp the record with the provided timestamp and the header is not preserved.","constantName":"org.apache.camel.component.kafka.KafkaConstants#OVERRIDE_TIMESTAMP"},"kafka.RECORD_META":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metadata (only configured if recordMetadata endpoint parameter is true)","constantName":"org.apache.camel.component.kafka.KafkaConstants#KAFKA_RECORD_META"},"CamelKafkaManualCommit":{"index":12,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.kafka.consumer.KafkaManualCommit","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Can be used for forcing manual offset commit when using Kafka consumer.","constantName":"org.apache.camel.component.kafka.KafkaConstants#MANUAL_COMMIT"}},"properties":{"topic":{"index":0,"kind":"path","displayName":"Topic","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Name of the topic to use. On the consumer you can use comma to separate multiple topics. A producer can only send a message to a single topic."},"additionalProperties":{"index":1,"kind":"parameter","displayName":"Additional Properties","group":"common","label":"common","required":false,"type":"object","javaType":"java.util.Map","prefix":"additionalProperties.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Sets additional properties for either kafka consumer or kafka producer in case they can't be set directly on the camel configurations (e.g.: new Kafka properties that are not reflected yet in Camel configurations), the properties have to be prefixed with additionalProperties.., e.g.: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro"},"brokers":{"index":2,"kind":"parameter","displayName":"Brokers","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"URL of the Kafka brokers to use. The format is host1:port1,host2:port2, and the list can be a subset of brokers or a VIP pointing to a subset of brokers. This option is known as bootstrap.servers in the Kafka documentation."},"clientId":{"index":3,"kind":"parameter","displayName":"Client Id","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The client id is a user-specified string sent in each request to help trace calls. It should logically identify the application making the request."},"headerFilterStrategy":{"index":4,"kind":"parameter","displayName":"Header Filter Strategy","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"reconnectBackoffMaxMs":{"index":5,"kind":"parameter","displayName":"Reconnect Backoff Max Ms","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect. If provided, the backoff per host will increase exponentially for each consecutive connection failure, up to this maximum. After calculating the backoff increase, 20% random jitter is added to avoid connection storms."},"retryBackoffMaxMs":{"index":6,"kind":"parameter","displayName":"Retry Backoff Max Ms","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum amount of time in milliseconds to wait when retrying a request to the broker that has repeatedly failed. If provided, the backoff per client will increase exponentially for each failed request, up to this maximum. To prevent all clients from being synchronized upon retry, a randomized jitter with a factor of 0.2 will be applied to the backoff, resulting in the backoff falling within a range between 20% below and 20% above the computed value. If retry.backoff.ms is set to be higher than retry.backoff.max.ms, then retry.backoff.max.ms will be used as a constant backoff from the beginning without any exponential increase"},"retryBackoffMs":{"index":7,"kind":"parameter","displayName":"Retry Backoff Ms","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The amount of time to wait before attempting to retry a failed request to a given topic partition. This avoids repeatedly sending requests in a tight loop under some failure scenarios. This value is the initial backoff value and will increase exponentially for each failed request, up to the retry.backoff.max.ms value."},"shutdownTimeout":{"index":8,"kind":"parameter","displayName":"Shutdown Timeout","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Timeout in milliseconds to wait gracefully for the consumer or producer to shut down and terminate its worker threads."},"allowManualCommit":{"index":9,"kind":"parameter","displayName":"Allow Manual Commit","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Whether to allow doing manual commits via KafkaManualCommit. If this option is enabled then an instance of KafkaManualCommit is stored on the Exchange message header, which allows end users to access this API and perform manual offset commits via the Kafka consumer."},"autoCommitEnable":{"index":10,"kind":"parameter","displayName":"Auto Commit Enable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"If true, periodically commit to ZooKeeper the offset of messages already fetched by the consumer. This committed offset will be used when the process fails as the position from which the new consumer will begin."},"autoCommitIntervalMs":{"index":11,"kind":"parameter","displayName":"Auto Commit Interval Ms","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The frequency in ms that the consumer offsets are committed to zookeeper."},"autoOffsetReset":{"index":12,"kind":"parameter","displayName":"Auto Offset Reset","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["latest","earliest","none"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"latest","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"What to do when there is no initial offset in ZooKeeper or if an offset is out of range: earliest : automatically reset the offset to the earliest offset latest: automatically reset the offset to the latest offset fail: throw exception to the consumer"},"batching":{"index":13,"kind":"parameter","displayName":"Batching","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Whether to use batching for processing or streaming. The default is false, which uses streaming"},"breakOnFirstError":{"index":14,"kind":"parameter","displayName":"Break On First Error","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"This options controls what happens when a consumer is processing an exchange and it fails. If the option is false then the consumer continues to the next message and processes it. If the option is true then the consumer breaks out. Using the default NoopCommitManager will cause the consumer to not commit the offset so that the message is re-attempted. The consumer should use the KafkaManualCommit to determine the best way to handle the message. Using either the SyncCommitManager or the AsyncCommitManager, the consumer will seek back to the offset of the message that caused a failure, and then re-attempt to process this message. However, this can lead to endless processing of the same message if it's bound to fail every time, e.g., a poison message. Therefore, it's recommended to deal with that, for example, by using Camel's error handler."},"checkCrcs":{"index":15,"kind":"parameter","displayName":"Check Crcs","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Automatically check the CRC32 of the records consumed. This ensures no on-the-wire or on-disk corruption to the messages occurred. This check adds some overhead, so it may be disabled in cases seeking extreme performance."},"commitTimeoutMs":{"index":16,"kind":"parameter","displayName":"Commit Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum time, in milliseconds, that the code will wait for a synchronous commit to complete"},"consumerRequestTimeoutMs":{"index":17,"kind":"parameter","displayName":"Consumer Request Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The configuration controls the maximum amount of time the client will wait for the response of a request. If the response is not received before the timeout elapsed, the client will resend the request if necessary or fail the request if retries are exhausted."},"consumersCount":{"index":18,"kind":"parameter","displayName":"Consumers Count","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The number of consumers that connect to kafka server. Each consumer is run on a separate thread that retrieves and process the incoming data."},"fetchMaxBytes":{"index":19,"kind":"parameter","displayName":"Fetch Max Bytes","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"52428800","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum amount of data the server should return for a fetch request. This is not an absolute maximum, if the first message in the first non-empty partition of the fetch is larger than this value, the message will still be returned to ensure that the consumer can make progress. The maximum message size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (topic config). Note that the consumer performs multiple fetches in parallel."},"fetchMinBytes":{"index":20,"kind":"parameter","displayName":"Fetch Min Bytes","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The minimum amount of data the server should return for a fetch request. If insufficient data is available, the request will wait for that much data to accumulate before answering the request."},"fetchWaitMaxMs":{"index":21,"kind":"parameter","displayName":"Fetch Wait Max Ms","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum amount of time the server will block before answering the fetch request if there isn't enough data to immediately satisfy fetch.min.bytes"},"groupId":{"index":22,"kind":"parameter","displayName":"Group Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"A string that uniquely identifies the group of consumer processes to which this consumer belongs. By setting the same group id, multiple processes can indicate that they are all part of the same consumer group. This option is required for consumers."},"groupInstanceId":{"index":23,"kind":"parameter","displayName":"Group Instance Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"A unique identifier of the consumer instance provided by the end user. Only non-empty strings are permitted. If set, the consumer is treated as a static member, which means that only one instance with this ID is allowed in the consumer group at any time. This can be used in combination with a larger session timeout to avoid group rebalances caused by transient unavailability (e.g., process restarts). If not set, the consumer will join the group as a dynamic member, which is the traditional behavior."},"headerDeserializer":{"index":24,"kind":"parameter","displayName":"Header Deserializer","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.kafka.serde.KafkaHeaderDeserializer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"To use a custom KafkaHeaderDeserializer to deserialize kafka headers values"},"heartbeatIntervalMs":{"index":25,"kind":"parameter","displayName":"Heartbeat Interval Ms","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The expected time between heartbeats to the consumer coordinator when using Kafka's group management facilities. Heartbeats are used to ensure that the consumer's session stays active and to facilitate rebalancing when new consumers join or leave the group. The value must be set lower than session.timeout.ms, but typically should be set no higher than 1/3 of that value. It can be adjusted even lower to control the expected time for normal rebalances."},"keyDeserializer":{"index":26,"kind":"parameter","displayName":"Key Deserializer","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.common.serialization.StringDeserializer","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Deserializer class for the key that implements the Deserializer interface."},"maxPartitionFetchBytes":{"index":27,"kind":"parameter","displayName":"Max Partition Fetch Bytes","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1048576","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum amount of data per-partition the server will return. The maximum total memory used for a request will be #partitions max.partition.fetch.bytes. This size must be at least as large as the maximum message size the server allows or else it is possible for the producer to send messages larger than the consumer can fetch. If that happens, the consumer can get stuck trying to fetch a large message on a certain partition."},"maxPollIntervalMs":{"index":28,"kind":"parameter","displayName":"Max Poll Interval Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum delay between invocations of poll() when using consumer group management. This places an upper bound on the amount of time that the consumer can be idle before fetching more records. If poll() is not called before expiration of this timeout, then the consumer is considered failed, and the group will re-balance to reassign the partitions to another member."},"maxPollRecords":{"index":29,"kind":"parameter","displayName":"Max Poll Records","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum number of records returned in a single call to poll()"},"offsetRepository":{"index":30,"kind":"parameter","displayName":"Offset Repository","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.spi.StateRepository","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The offset repository to use to locally store the offset of each partition of the topic. Defining one will disable the autocommit."},"partitionAssignor":{"index":31,"kind":"parameter","displayName":"Partition Assignor","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.clients.consumer.RangeAssignor","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The class name of the partition assignment strategy that the client will use to distribute partition ownership amongst consumer instances when group management is used"},"pollOnError":{"index":32,"kind":"parameter","displayName":"Poll On Error","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.kafka.PollOnError","enum":["DISCARD","ERROR_HANDLER","RECONNECT","RETRY","STOP"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ERROR_HANDLER","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"What to do if kafka threw an exception while polling for new messages. Will by default use the value from the component configuration unless an explicit value has been configured on the endpoint level. DISCARD will discard the message and continue to poll the next message. ERROR_HANDLER will use Camel's error handler to process the exception, and afterwards continue to poll the next message. RECONNECT will re-connect the consumer and try polling the message again. RETRY will let the consumer retry poll the same message again. STOP will stop the consumer (it has to be manually started/restarted if the consumer should be able to consume messages again)"},"pollTimeoutMs":{"index":33,"kind":"parameter","displayName":"Poll Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The timeout used when polling the KafkaConsumer."},"preValidateHostAndPort":{"index":34,"kind":"parameter","displayName":"Pre Validate Host And Port","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Whether to eager validate that broker host:port is valid and can be DNS resolved to known host during starting this consumer. If the validation fails, then an exception is thrown, which makes Camel fail fast. Disabling this will postpone the validation after the consumer is started, and Camel will keep re-connecting in case of validation or DNS resolution error."},"seekTo":{"index":35,"kind":"parameter","displayName":"Seek To","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.kafka.SeekPolicy","enum":["BEGINNING","END"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Set if KafkaConsumer should read from the beginning or the end on startup: SeekPolicy.BEGINNING: read from the beginning. SeekPolicy.END: read from the end."},"sessionTimeoutMs":{"index":36,"kind":"parameter","displayName":"Session Timeout Ms","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"45000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The timeout used to detect failures when using Kafka's group management facilities."},"specificAvroReader":{"index":37,"kind":"parameter","displayName":"Specific Avro Reader","group":"consumer","label":"schema,consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"This enables the use of a specific Avro reader for use with the in multiple Schema registries documentation with Avro Deserializers implementation. This option is only available externally (not standard Apache Kafka)"},"topicIsPattern":{"index":38,"kind":"parameter","displayName":"Topic Is Pattern","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Whether the topic is a pattern (regular expression). This can be used to subscribe to dynamic number of topics matching the pattern."},"valueDeserializer":{"index":39,"kind":"parameter","displayName":"Value Deserializer","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.common.serialization.StringDeserializer","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Deserializer class for value that implements the Deserializer interface."},"bridgeErrorHandler":{"index":40,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":41,"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":{"index":42,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"isolationLevel":{"index":43,"kind":"parameter","displayName":"Isolation Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["read_uncommitted","read_committed"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"read_uncommitted","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Controls how to read messages written transactionally. If set to read_committed, consumer.poll() will only return transactional messages which have been committed. If set to read_uncommitted (the default), consumer.poll() will return all messages, even transactional messages which have been aborted. Non-transactional messages will be returned unconditionally in either mode. Messages will always be returned in offset order. Hence, in read_committed mode, consumer.poll() will only return messages up to the last stable offset (LSO), which is the one less than the offset of the first open transaction. In particular, any messages appearing after messages belonging to ongoing transactions will be withheld until the relevant transaction has been completed. As a result, read_committed consumers will not be able to read up to the high watermark when there are in flight transactions. Further, when in read_committed the seekToEnd method will return the LSO"},"kafkaManualCommitFactory":{"index":44,"kind":"parameter","displayName":"Kafka Manual Commit Factory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.kafka.consumer.KafkaManualCommitFactory","deprecated":false,"autowired":false,"secret":false,"description":"Factory to use for creating KafkaManualCommit instances. This allows to plugin a custom factory to create custom KafkaManualCommit instances in case special logic is needed when doing manual commits that deviates from the default implementation that comes out of the box."},"batchWithIndividualHeaders":{"index":45,"kind":"parameter","displayName":"Batch With Individual Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"If this feature is enabled and a single element of a batch is an Exchange or Message, the producer will generate individual kafka header values for it by using the batch Message to determine the values. Normal behavior consists of always using the same header values (which are determined by the parent Exchange which contains the Iterable or Iterator)."},"bufferMemorySize":{"index":46,"kind":"parameter","displayName":"Buffer Memory Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"33554432","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The total bytes of memory the producer can use to buffer records waiting to be sent to the server. If records are sent faster than they can be delivered to the server, the producer will either block or throw an exception based on the preference specified by block.on.buffer.full.This setting should correspond roughly to the total memory the producer will use, but is not a hard bound since not all memory the producer uses is used for buffering. Some additional memory will be used for compression (if compression is enabled) as well as for maintaining in-flight requests."},"compressionCodec":{"index":47,"kind":"parameter","displayName":"Compression Codec","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["none","gzip","snappy","lz4","zstd"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"This parameter allows you to specify the compression codec for all data generated by this producer. Valid values are none, gzip, snappy, lz4 and zstd."},"connectionMaxIdleMs":{"index":48,"kind":"parameter","displayName":"Connection Max Idle Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"540000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Close idle connections after the number of milliseconds specified by this config."},"deliveryTimeoutMs":{"index":49,"kind":"parameter","displayName":"Delivery Timeout Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"120000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"An upper bound on the time to report success or failure after a call to send() returns. This limits the total time that a record will be delayed prior to sending, the time to await acknowledgement from the broker (if expected), and the time allowed for retriable send failures."},"enableIdempotence":{"index":50,"kind":"parameter","displayName":"Enable Idempotence","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"When set to 'true', the producer will ensure that exactly one copy of each message is written in the stream. If 'false', producer retries due to broker failures, etc., may write duplicates of the retried message in the stream. Note that enabling idempotence requires max.in.flight.requests.per.connection to be less than or equal to 5 (with message ordering preserved for any allowable value), retries to be greater than 0, and acks must be 'all'. Idempotence is enabled by default if no conflicting configurations are set. If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled. If idempotence is explicitly enabled and conflicting configurations are set, a ConfigException is thrown."},"headerSerializer":{"index":51,"kind":"parameter","displayName":"Header Serializer","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.kafka.serde.KafkaHeaderSerializer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"To use a custom KafkaHeaderSerializer to serialize kafka headers values"},"key":{"index":52,"kind":"parameter","displayName":"Key","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The record key (or null if no key is specified). If this option has been configured then it take precedence over header KafkaConstants#KEY"},"keySerializer":{"index":53,"kind":"parameter","displayName":"Key Serializer","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.common.serialization.StringSerializer","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The serializer class for keys (defaults to the same as for messages if nothing is given)."},"lingerMs":{"index":54,"kind":"parameter","displayName":"Linger Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The producer groups together any records that arrive in between request transmissions into a single, batched, request. Normally, this occurs only under load when records arrive faster than they can be sent out. However, in some circumstances, the client may want to reduce the number of requests even under a moderate load. This setting achieves this by adding a small amount of artificial delay. That is, rather than immediately sending out a record, the producer will wait for up to the given delay to allow other records to be sent so that they can be batched together. This can be thought of as analogous to Nagle's algorithm in TCP. This setting gives the upper bound on the delay for batching: once we get batch.size worth of records for a partition, it will be sent immediately regardless of this setting, however, if we have fewer than this many bytes accumulated for this partition, we will 'linger' for the specified time waiting for more records to show up. This setting defaults to 0 (i.e., no delay). Setting linger.ms=5, for example, would have the effect of reducing the number of requests sent but would add up to 5ms of latency to records sent in the absence of load."},"maxBlockMs":{"index":55,"kind":"parameter","displayName":"Max Block Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The configuration controls how long the KafkaProducer's send(), partitionsFor(), initTransactions(), sendOffsetsToTransaction(), commitTransaction() and abortTransaction() methods will block. For send() this timeout bounds the total time waiting for both metadata fetch and buffer allocation (blocking in the user-supplied serializers or partitioner is not counted against this timeout). For partitionsFor() this time out bounds the time spent waiting for metadata if it is unavailable. The transaction-related methods always block, but may time out if the transaction coordinator could not be discovered or did not respond within the timeout."},"maxInFlightRequest":{"index":56,"kind":"parameter","displayName":"Max In Flight Request","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum number of unacknowledged requests the client will send on a single connection before blocking. Note that if this setting is set to be greater than 1 and there are failed sends, there is a risk of message re-ordering due to retries (i.e., if retries are enabled)."},"maxRequestSize":{"index":57,"kind":"parameter","displayName":"Max Request Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1048576","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum size of a request. This is also effectively a cap on the maximum record size. Note that the server has its own cap on record size which may be different from this. This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests."},"metadataMaxAgeMs":{"index":58,"kind":"parameter","displayName":"Metadata Max Age Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"300000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions."},"metricReporters":{"index":59,"kind":"parameter","displayName":"Metric Reporters","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"A list of classes to use as metrics reporters. Implementing the MetricReporter interface allows plugging in classes that will be notified of new metric creation. The JmxReporter is always included to register JMX statistics."},"metricsSampleWindowMs":{"index":60,"kind":"parameter","displayName":"Metrics Sample Window Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The window of time a metrics sample is computed over."},"noOfMetricsSample":{"index":61,"kind":"parameter","displayName":"No Of Metrics Sample","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The number of samples maintained to compute metrics."},"partitioner":{"index":62,"kind":"parameter","displayName":"Partitioner","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The partitioner class for partitioning messages amongst sub-topics. The default partitioner is based on the hash of the key."},"partitionerIgnoreKeys":{"index":63,"kind":"parameter","displayName":"Partitioner Ignore Keys","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Whether the message keys should be ignored when computing the partition. This setting has effect only when partitioner is not set"},"partitionKey":{"index":64,"kind":"parameter","displayName":"Partition Key","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The partition to which the record will be sent (or null if no partition was specified). If this option has been configured then it take precedence over header KafkaConstants#PARTITION_KEY"},"producerBatchSize":{"index":65,"kind":"parameter","displayName":"Producer Batch Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"16384","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition. This helps performance on both the client and the server. This configuration controls the default batch size in bytes. No attempt will be made to batch records larger than this size. Requests sent to brokers will contain multiple batches, one for each partition with data available to be sent. A small batch size will make batching less common and may reduce throughput (a batch size of zero will disable batching entirely). A very large batch size may use memory a bit more wastefully as we will always allocate a buffer of the specified batch size in anticipation of additional records."},"queueBufferingMaxMessages":{"index":66,"kind":"parameter","displayName":"Queue Buffering Max Messages","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The maximum number of unsent messages that can be queued up the producer when using async mode before either the producer must be blocked or data must be dropped."},"receiveBufferBytes":{"index":67,"kind":"parameter","displayName":"Receive Buffer Bytes","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"65536","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The size of the TCP receive buffer (SO_RCVBUF) to use when reading data."},"reconnectBackoffMs":{"index":68,"kind":"parameter","displayName":"Reconnect Backoff Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"50","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all requests sent by the consumer to the broker."},"recordMetadata":{"index":69,"kind":"parameter","displayName":"Record Metadata","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Whether the producer should store the RecordMetadata results from sending to Kafka. The results are stored in a List containing the RecordMetadata metadata's. The list is stored on a header with the key KafkaConstants#KAFKA_RECORDMETA"},"requestRequiredAcks":{"index":70,"kind":"parameter","displayName":"Request Required Acks","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["all","-1","0","1"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"all","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The number of acknowledgments the producer requires the leader to have received before considering a request complete. This controls the durability of records that are sent. The following settings are allowed: acks=0 If set to zero, then the producer will not wait for any acknowledgment from the server at all. The record will be immediately added to the socket buffer and considered sent. No guarantee can be made that the server has received the record in this case, and the retry configuration will not take effect (as the client won't generally know of any failures). The offset given back for each record will always be set to -1. acks=1 This will mean the leader will write the record to its local log but will respond without awaiting full acknowledgment from all followers. In this case should the leader fail immediately after acknowledging the record, but before the followers have replicated it, then the record will be lost. acks=all This means the leader will wait for the full set of in-sync replicas to acknowledge the record. This guarantees that the record will not be lost as long as at least one in-sync replica remains alive. This is the strongest available guarantee. This is equivalent to the acks=-1 setting. Note that enabling idempotence requires this config value to be 'all'. If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled."},"requestTimeoutMs":{"index":71,"kind":"parameter","displayName":"Request Timeout Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The amount of time the broker will wait trying to meet the request.required.acks requirement before sending back an error to the client."},"retries":{"index":72,"kind":"parameter","displayName":"Retries","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Setting a value greater than zero will cause the client to resend any record that has failed to be sent due to a potentially transient error. Note that this retry is no different from if the client re-sending the record upon receiving the error. Produce requests will be failed before the number of retries has been exhausted if the timeout configured by delivery.timeout.ms expires first before successful acknowledgement. Users should generally prefer to leave this config unset and instead use delivery.timeout.ms to control retry behavior. Enabling idempotence requires this config value to be greater than 0. If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled. Allowing retries while setting enable.idempotence to false and max.in.flight.requests.per.connection to 1 will potentially change the ordering of records, because if two batches are sent to a single partition, and the first fails and is retried but the second succeeds; then the records in the second batch may appear first."},"sendBufferBytes":{"index":73,"kind":"parameter","displayName":"Send Buffer Bytes","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"131072","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Socket write buffer size"},"useIterator":{"index":74,"kind":"parameter","displayName":"Use Iterator","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Sets whether sending to kafka should send the message body as a single record, or use a java.util.Iterator to send multiple records to kafka (if the message body can be iterated)."},"valueSerializer":{"index":75,"kind":"parameter","displayName":"Value Serializer","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.kafka.common.serialization.StringSerializer","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The serializer class for messages."},"workerPool":{"index":76,"kind":"parameter","displayName":"Worker Pool","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.util.concurrent.ExecutorService","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"To use a custom worker pool for continue routing Exchange after kafka server has acknowledged the message that was sent to it from KafkaProducer using asynchronous non-blocking processing. If using this option, then you must handle the lifecycle of the thread pool to shut the pool down when no longer needed."},"workerPoolCoreSize":{"index":77,"kind":"parameter","displayName":"Worker Pool Core Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Number of core threads for the worker pool for continue routing Exchange after kafka server has acknowledged the message that was sent to it from KafkaProducer using asynchronous non-blocking processing."},"workerPoolMaxSize":{"index":78,"kind":"parameter","displayName":"Worker Pool Max Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Maximum number of threads for the worker pool for continue routing Exchange after kafka server has acknowledged the message that was sent to it from KafkaProducer using asynchronous non-blocking processing."},"lazyStartProducer":{"index":79,"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."},"kafkaClientFactory":{"index":80,"kind":"parameter","displayName":"Kafka Client Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.kafka.KafkaClientFactory","deprecated":false,"autowired":false,"secret":false,"description":"Factory to use for creating org.apache.kafka.clients.consumer.KafkaConsumer and org.apache.kafka.clients.producer.KafkaProducer instances. This allows to configure a custom factory to create instances with logic that extends the vanilla Kafka clients."},"synchronous":{"index":81,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used"},"interceptorClasses":{"index":82,"kind":"parameter","displayName":"Interceptor Classes","group":"monitoring","label":"common,monitoring","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Sets interceptors for producer or consumers. Producer interceptors have to be classes implementing org.apache.kafka.clients.producer.ProducerInterceptor Consumer interceptors have to be classes implementing org.apache.kafka.clients.consumer.ConsumerInterceptor Note that if you use Producer interceptor on a consumer it will throw a class cast exception in runtime"},"schemaRegistryURL":{"index":83,"kind":"parameter","displayName":"Schema Registry URL","group":"schema","label":"schema","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"URL of the schema registry servers to use. The format is host1:port1,host2:port2. This is known as schema.registry.url in multiple Schema registries documentation. This option is only available externally (not standard Apache Kafka)"},"kerberosBeforeReloginMinTime":{"index":84,"kind":"parameter","displayName":"Kerberos Before Relogin Min Time","group":"security","label":"common,security","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Login thread sleep time between refresh attempts."},"kerberosConfigLocation":{"index":85,"kind":"parameter","displayName":"Kerberos Config Location","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Location of the kerberos config file."},"kerberosInitCmd":{"index":86,"kind":"parameter","displayName":"Kerberos Init Cmd","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"/usr/bin/kinit","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Kerberos kinit command path. Default is /usr/bin/kinit"},"kerberosPrincipalToLocalRules":{"index":87,"kind":"parameter","displayName":"Kerberos Principal To Local Rules","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEFAULT","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"A list of rules for mapping from principal names to short names (typically operating system usernames). The rules are evaluated in order, and the first rule that matches a principal name is used to map it to a short name. Any later rules in the list are ignored. By default, principal names of the form {username}/{hostname}{REALM} are mapped to {username}. For more details on the format, please see the Security Authorization and ACLs documentation (at the Apache Kafka project website). Multiple values can be separated by comma"},"kerberosRenewJitter":{"index":88,"kind":"parameter","displayName":"Kerberos Renew Jitter","group":"security","label":"common,security","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0.05","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Percentage of random jitter added to the renewal time."},"kerberosRenewWindowFactor":{"index":89,"kind":"parameter","displayName":"Kerberos Renew Window Factor","group":"security","label":"common,security","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0.8","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Login thread will sleep until the specified window factor of time from last refresh to ticket's expiry has been reached, at which time it will try to renew the ticket."},"saslJaasConfig":{"index":90,"kind":"parameter","displayName":"Sasl Jaas Config","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Expose the kafka sasl.jaas.config parameter Example: org.apache.kafka.common.security.plain.PlainLoginModule required username=USERNAME password=PASSWORD;"},"saslKerberosServiceName":{"index":91,"kind":"parameter","displayName":"Sasl Kerberos Service Name","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config."},"saslMechanism":{"index":92,"kind":"parameter","displayName":"Sasl Mechanism","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"GSSAPI","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The Simple Authentication and Security Layer (SASL) Mechanism used. For the valid values see http://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml"},"securityProtocol":{"index":93,"kind":"parameter","displayName":"Security Protocol","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"PLAINTEXT","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"Protocol used to communicate with brokers. SASL_PLAINTEXT, PLAINTEXT, SASL_SSL and SSL are supported"},"sslCipherSuites":{"index":94,"kind":"parameter","displayName":"Ssl Cipher Suites","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"A list of cipher suites. This is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol. By default, all the available cipher suites are supported."},"sslContextParameters":{"index":95,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"common,security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"SSL configuration using a Camel SSLContextParameters object. If configured, it's applied before the other SSL endpoint parameters. NOTE: Kafka only supports loading keystore from file locations, so prefix the location with file: in the KeyStoreParameters.resource option."},"sslEnabledProtocols":{"index":96,"kind":"parameter","displayName":"Ssl Enabled Protocols","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The list of protocols enabled for SSL connections. The default is TLSv1.2,TLSv1.3 when running with Java 11 or newer, TLSv1.2 otherwise. With the default value for Java 11, clients and servers will prefer TLSv1.3 if both support it and fallback to TLSv1.2 otherwise (assuming both support at least TLSv1.2). This default should be fine for most cases. Also see the config documentation for SslProtocol."},"sslEndpointAlgorithm":{"index":97,"kind":"parameter","displayName":"Ssl Endpoint Algorithm","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The endpoint identification algorithm to validate server hostname using server certificate. Use none or false to disable server hostname verification."},"sslKeymanagerAlgorithm":{"index":98,"kind":"parameter","displayName":"Ssl Keymanager Algorithm","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"SunX509","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine."},"sslKeyPassword":{"index":99,"kind":"parameter","displayName":"Ssl Key Password","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The password of the private key in the key store file or the PEM key specified in sslKeystoreKey. This is required for clients only if two-way authentication is configured."},"sslKeystoreLocation":{"index":100,"kind":"parameter","displayName":"Ssl Keystore Location","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The location of the key store file. This is optional for the client and can be used for two-way authentication for the client."},"sslKeystorePassword":{"index":101,"kind":"parameter","displayName":"Ssl Keystore Password","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The store password for the key store file. This is optional for the client and only needed if sslKeystoreLocation is configured. Key store password is not supported for PEM format."},"sslKeystoreType":{"index":102,"kind":"parameter","displayName":"Ssl Keystore Type","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"JKS","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The file format of the key store file. This is optional for the client. The default value is JKS"},"sslProtocol":{"index":103,"kind":"parameter","displayName":"Ssl Protocol","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The SSL protocol used to generate the SSLContext. The default is TLSv1.3 when running with Java 11 or newer, TLSv1.2 otherwise. This value should be fine for most use cases. Allowed values in recent JVMs are TLSv1.2 and TLSv1.3. TLS, TLSv1.1, SSL, SSLv2 and SSLv3 may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities. With the default value for this config and sslEnabledProtocols, clients will downgrade to TLSv1.2 if the server does not support TLSv1.3. If this config is set to TLSv1.2, clients will not use TLSv1.3 even if it is one of the values in sslEnabledProtocols and the server only supports TLSv1.3."},"sslProvider":{"index":104,"kind":"parameter","displayName":"Ssl Provider","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The name of the security provider used for SSL connections. Default value is the default security provider of the JVM."},"sslTrustmanagerAlgorithm":{"index":105,"kind":"parameter","displayName":"Ssl Trustmanager Algorithm","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"PKIX","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine."},"sslTruststoreLocation":{"index":106,"kind":"parameter","displayName":"Ssl Truststore Location","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The location of the trust store file."},"sslTruststorePassword":{"index":107,"kind":"parameter","displayName":"Ssl Truststore Password","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The password for the trust store file. If a password is not set, trust store file configured will still be used, but integrity checking is disabled. Trust store password is not supported for PEM format."},"sslTruststoreType":{"index":108,"kind":"parameter","displayName":"Ssl Truststore Type","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"JKS","configurationClass":"org.apache.camel.component.kafka.KafkaConfiguration","configurationField":"configuration","description":"The file format of the trust store file. The default value is JKS."}}} , -{"component":{"kind":"component","name":"knative","title":"Knative","description":"Send and receive events from Knative.","deprecated":false,"firstVersion":"3.15.0","label":"cloud","javaType":"org.apache.camel.component.knative.KnativeComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-knative","version":"4.8.1","scheme":"knative","extendsScheme":"","syntax":"knative:type/typeId","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"type":{"index":0,"kind":"path","displayName":"Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.knative.spi.Knative.Type","enum":["endpoint","channel","event"],"deprecated":false,"autowired":false,"secret":false,"description":"The Knative resource type"},"typeId":{"index":1,"kind":"path","displayName":"Type Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The identifier of the Knative resource"},"ceOverride":{"index":2,"kind":"parameter","displayName":"Ce Override","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","prefix":"ce.override.","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"CloudEvent headers to override"},"cloudEventsSpecVersion":{"index":3,"kind":"parameter","displayName":"Cloud Events Spec Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["1.0","1.0.1","1.0.2"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"1.0","configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"Set the version of the cloudevents spec."},"cloudEventsType":{"index":4,"kind":"parameter","displayName":"Cloud Events Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.camel.event","configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"Set the event-type information of the produced events."},"environment":{"index":5,"kind":"parameter","displayName":"Environment","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.knative.spi.KnativeEnvironment","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"The environment"},"filters":{"index":6,"kind":"parameter","displayName":"Filters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","prefix":"filter.","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"Set the filters."},"sinkBinding":{"index":7,"kind":"parameter","displayName":"Sink Binding","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.knative.spi.KnativeSinkBinding","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"The SinkBinding configuration."},"transportOptions":{"index":8,"kind":"parameter","displayName":"Transport Options","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","prefix":"transport.","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"Set the transport options."},"replyWithCloudEvent":{"index":9,"kind":"parameter","displayName":"Reply With Cloud Event","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"Transforms the reply into a cloud event that will be processed by the caller. When listening to events from a Knative Broker, if this flag is enabled, replies will be published to the same Broker where the request comes from (beware that if you don't change the type of the received message, you may create a loop and receive your same reply). When this flag is disabled, CloudEvent headers are removed from the reply."},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"reply":{"index":13,"kind":"parameter","displayName":"Reply","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"If the consumer should construct a full reply to knative request."},"lazyStartProducer":{"index":14,"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."},"apiVersion":{"index":15,"kind":"parameter","displayName":"Api Version","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"The version of the k8s resource referenced by the endpoint."},"kind":{"index":16,"kind":"parameter","displayName":"Kind","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"The type of the k8s resource referenced by the endpoint."},"name":{"index":17,"kind":"parameter","displayName":"Name","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"The name of the k8s resource referenced by the endpoint."}}} +{"component":{"kind":"component","name":"knative","title":"Knative","description":"Send and receive events from Knative.","deprecated":false,"firstVersion":"3.15.0","label":"cloud","javaType":"org.apache.camel.component.knative.KnativeComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-knative","version":"4.8.2","scheme":"knative","extendsScheme":"","syntax":"knative:type/typeId","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"type":{"index":0,"kind":"path","displayName":"Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.knative.spi.Knative.Type","enum":["endpoint","channel","event"],"deprecated":false,"autowired":false,"secret":false,"description":"The Knative resource type"},"typeId":{"index":1,"kind":"path","displayName":"Type Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The identifier of the Knative resource"},"ceOverride":{"index":2,"kind":"parameter","displayName":"Ce Override","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","prefix":"ce.override.","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"CloudEvent headers to override"},"cloudEventsSpecVersion":{"index":3,"kind":"parameter","displayName":"Cloud Events Spec Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["1.0","1.0.1","1.0.2"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"1.0","configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"Set the version of the cloudevents spec."},"cloudEventsType":{"index":4,"kind":"parameter","displayName":"Cloud Events Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"org.apache.camel.event","configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"Set the event-type information of the produced events."},"environment":{"index":5,"kind":"parameter","displayName":"Environment","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.knative.spi.KnativeEnvironment","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"The environment"},"filters":{"index":6,"kind":"parameter","displayName":"Filters","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","prefix":"filter.","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"Set the filters."},"sinkBinding":{"index":7,"kind":"parameter","displayName":"Sink Binding","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.knative.spi.KnativeSinkBinding","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"The SinkBinding configuration."},"transportOptions":{"index":8,"kind":"parameter","displayName":"Transport Options","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","prefix":"transport.","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"Set the transport options."},"replyWithCloudEvent":{"index":9,"kind":"parameter","displayName":"Reply With Cloud Event","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"Transforms the reply into a cloud event that will be processed by the caller. When listening to events from a Knative Broker, if this flag is enabled, replies will be published to the same Broker where the request comes from (beware that if you don't change the type of the received message, you may create a loop and receive your same reply). When this flag is disabled, CloudEvent headers are removed from the reply."},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"reply":{"index":13,"kind":"parameter","displayName":"Reply","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"If the consumer should construct a full reply to knative request."},"lazyStartProducer":{"index":14,"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."},"apiVersion":{"index":15,"kind":"parameter","displayName":"Api Version","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"The version of the k8s resource referenced by the endpoint."},"kind":{"index":16,"kind":"parameter","displayName":"Kind","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"The type of the k8s resource referenced by the endpoint."},"name":{"index":17,"kind":"parameter","displayName":"Name","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.knative.KnativeConfiguration","configurationField":"configuration","description":"The name of the k8s resource referenced by the endpoint."}}} , -{"component":{"kind":"component","name":"kubernetes-config-maps","title":"Kubernetes ConfigMap","description":"Perform operations on Kubernetes ConfigMaps and get notified on ConfigMaps changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.config_maps.KubernetesConfigMapsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-config-maps","extendsScheme":"","syntax":"kubernetes-config-maps:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesConfigMapsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ConfigMap labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CONFIGMAPS_LABELS"},"CamelKubernetesConfigMapName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ConfigMap name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CONFIGMAP_NAME"},"CamelKubernetesConfigData":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ConfigMap Data","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CONFIGMAP_DATA"},"CamelKubernetesConfigMapsAnnotations":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ConfigMap annotations","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CONFIGMAPS_ANNOTATIONS"},"CamelKubernetesEventAction":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-config-maps","title":"Kubernetes ConfigMap","description":"Perform operations on Kubernetes ConfigMaps and get notified on ConfigMaps changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.config_maps.KubernetesConfigMapsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-config-maps","extendsScheme":"","syntax":"kubernetes-config-maps:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesConfigMapsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ConfigMap labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CONFIGMAPS_LABELS"},"CamelKubernetesConfigMapName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ConfigMap name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CONFIGMAP_NAME"},"CamelKubernetesConfigData":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ConfigMap Data","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CONFIGMAP_DATA"},"CamelKubernetesConfigMapsAnnotations":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ConfigMap annotations","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CONFIGMAPS_ANNOTATIONS"},"CamelKubernetesEventAction":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-cronjob","title":"Kubernetes Cronjob","description":"Perform operations on Kubernetes CronJob.","deprecated":false,"firstVersion":"4.3.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.cronjob.KubernetesCronJobComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-cronjob","extendsScheme":"","syntax":"kubernetes-cronjob:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesCronJobLabels":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Cronjob labels.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRON_JOB_LABELS"},"CamelKubernetesCronJobName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Cronjob name.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRON_JOB_NAME"},"CamelKubernetesCronJobSpec":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.batch.v1.CronJobSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a Job.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRON_JOB_SPEC"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-cronjob","title":"Kubernetes Cronjob","description":"Perform operations on Kubernetes CronJob.","deprecated":false,"firstVersion":"4.3.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.cronjob.KubernetesCronJobComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-cronjob","extendsScheme":"","syntax":"kubernetes-cronjob:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesCronJobLabels":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Cronjob labels.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRON_JOB_LABELS"},"CamelKubernetesCronJobName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Cronjob name.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRON_JOB_NAME"},"CamelKubernetesCronJobSpec":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.batch.v1.CronJobSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a Job.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRON_JOB_SPEC"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-custom-resources","title":"Kubernetes Custom Resources","description":"Perform operations on Kubernetes Custom Resources and get notified on Deployment changes.","deprecated":false,"firstVersion":"3.7.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.customresources.KubernetesCustomResourcesComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-custom-resources","extendsScheme":"","syntax":"kubernetes-custom-resources:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesCRDInstanceName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_INSTANCE_NAME"},"CamelKubernetesCRDEventTimestamp":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_EVENT_TIMESTAMP"},"CamelKubernetesCRDEventAction":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_EVENT_ACTION"},"CamelKubernetesCRDName":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Consumer CRD Resource name we would like to watch","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_NAME"},"CamelKubernetesCRDGroup":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Consumer CRD Resource Group we would like to watch","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_GROUP"},"CamelKubernetesCRDScope":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Consumer CRD Resource Scope we would like to watch","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_SCOPE"},"CamelKubernetesCRDVersion":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Consumer CRD Resource Version we would like to watch","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_VERSION"},"CamelKubernetesCRDPlural":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Consumer CRD Resource Plural we would like to watch","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_PLURAL"},"CamelKubernetesCRDLabels":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CRD resource labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_LABELS"},"CamelKubernetesCRDInstance":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The manifest of the CRD resource to create as JSON string","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_INSTANCE"},"CamelKubernetesDeleteResult":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The result of the delete operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DELETE_RESULT"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-custom-resources","title":"Kubernetes Custom Resources","description":"Perform operations on Kubernetes Custom Resources and get notified on Deployment changes.","deprecated":false,"firstVersion":"3.7.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.customresources.KubernetesCustomResourcesComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-custom-resources","extendsScheme":"","syntax":"kubernetes-custom-resources:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesCRDInstanceName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_INSTANCE_NAME"},"CamelKubernetesCRDEventTimestamp":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_EVENT_TIMESTAMP"},"CamelKubernetesCRDEventAction":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_EVENT_ACTION"},"CamelKubernetesCRDName":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Consumer CRD Resource name we would like to watch","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_NAME"},"CamelKubernetesCRDGroup":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Consumer CRD Resource Group we would like to watch","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_GROUP"},"CamelKubernetesCRDScope":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Consumer CRD Resource Scope we would like to watch","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_SCOPE"},"CamelKubernetesCRDVersion":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Consumer CRD Resource Version we would like to watch","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_VERSION"},"CamelKubernetesCRDPlural":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Consumer CRD Resource Plural we would like to watch","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_PLURAL"},"CamelKubernetesCRDLabels":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The CRD resource labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_LABELS"},"CamelKubernetesCRDInstance":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The manifest of the CRD resource to create as JSON string","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_CRD_INSTANCE"},"CamelKubernetesDeleteResult":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The result of the delete operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DELETE_RESULT"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-deployments","title":"Kubernetes Deployments","description":"Perform operations on Kubernetes Deployments and get notified on Deployment changes.","deprecated":false,"firstVersion":"2.20.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.deployments.KubernetesDeploymentsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-deployments","extendsScheme":"","syntax":"kubernetes-deployments:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesDeploymentsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENTS_LABELS"},"CamelKubernetesDeploymentsAnnotations":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENTS_ANNOTATIONS"},"CamelKubernetesDeploymentName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENT_NAME"},"CamelKubernetesDeploymentSpec":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.apps.DeploymentSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a deployment","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENT_SPEC"},"CamelKubernetesDeploymentReplicas":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The desired instance count","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENT_REPLICAS"},"CamelKubernetesEventAction":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-deployments","title":"Kubernetes Deployments","description":"Perform operations on Kubernetes Deployments and get notified on Deployment changes.","deprecated":false,"firstVersion":"2.20.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.deployments.KubernetesDeploymentsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-deployments","extendsScheme":"","syntax":"kubernetes-deployments:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesDeploymentsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENTS_LABELS"},"CamelKubernetesDeploymentsAnnotations":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENTS_ANNOTATIONS"},"CamelKubernetesDeploymentName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENT_NAME"},"CamelKubernetesDeploymentSpec":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.apps.DeploymentSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a deployment","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENT_SPEC"},"CamelKubernetesDeploymentReplicas":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The desired instance count","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENT_REPLICAS"},"CamelKubernetesEventAction":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-events","title":"Kubernetes Event","description":"Perform operations on Kubernetes Events and get notified on Events changes.","deprecated":false,"firstVersion":"3.20.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.events.KubernetesEventsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-events","extendsScheme":"","syntax":"kubernetes-events:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesEventsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENTS_LABELS"},"CamelKubernetesEventTime":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"server time","description":"The event time in ISO-8601 extended offset date-time format, such as '2011-12-03T10:15:3001:00'.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIME"},"CamelKubernetesEventAction":{"index":13,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventType":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event type","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TYPE"},"CamelKubernetesEventReason":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event reason","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_REASON"},"CamelKubernetesEventNote":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event note","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_NOTE"},"CamelKubernetesEventRegarding":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.ObjectReference","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event regarding","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_REGARDING"},"CamelKubernetesEventRelated":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.ObjectReference","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event related","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_RELATED"},"CamelKubernetesEventReportingController":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event reporting controller","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_REPORTING_CONTROLLER"},"CamelKubernetesEventReportingInstance":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event reporting instance","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_REPORTING_INSTANCE"},"CamelKubernetesEventName":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_NAME"},"CamelKubernetesEventTimestamp":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-events","title":"Kubernetes Event","description":"Perform operations on Kubernetes Events and get notified on Events changes.","deprecated":false,"firstVersion":"3.20.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.events.KubernetesEventsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-events","extendsScheme":"","syntax":"kubernetes-events:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesEventsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENTS_LABELS"},"CamelKubernetesEventTime":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"server time","description":"The event time in ISO-8601 extended offset date-time format, such as '2011-12-03T10:15:3001:00'.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIME"},"CamelKubernetesEventAction":{"index":13,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventType":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event type","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TYPE"},"CamelKubernetesEventReason":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event reason","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_REASON"},"CamelKubernetesEventNote":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event note","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_NOTE"},"CamelKubernetesEventRegarding":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.ObjectReference","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event regarding","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_REGARDING"},"CamelKubernetesEventRelated":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.ObjectReference","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event related","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_RELATED"},"CamelKubernetesEventReportingController":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event reporting controller","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_REPORTING_CONTROLLER"},"CamelKubernetesEventReportingInstance":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event reporting instance","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_REPORTING_INSTANCE"},"CamelKubernetesEventName":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_NAME"},"CamelKubernetesEventTimestamp":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-hpa","title":"Kubernetes HPA","description":"Perform operations on Kubernetes Horizontal Pod Autoscalers (HPA) and get notified on HPA changes.","deprecated":false,"firstVersion":"2.23.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.hpa.KubernetesHPAComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-hpa","extendsScheme":"","syntax":"kubernetes-hpa:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesHPAName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HPA name.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_HPA_NAME"},"CamelKubernetesHPASpec":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.autoscaling.v1.HorizontalPodAutoscalerSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a HPA.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_HPA_SPEC"},"CamelKubernetesHPALabels":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HPA labels.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_HPA_LABELS"},"CamelKubernetesEventAction":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-hpa","title":"Kubernetes HPA","description":"Perform operations on Kubernetes Horizontal Pod Autoscalers (HPA) and get notified on HPA changes.","deprecated":false,"firstVersion":"2.23.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.hpa.KubernetesHPAComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-hpa","extendsScheme":"","syntax":"kubernetes-hpa:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesHPAName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HPA name.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_HPA_NAME"},"CamelKubernetesHPASpec":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.autoscaling.v1.HorizontalPodAutoscalerSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a HPA.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_HPA_SPEC"},"CamelKubernetesHPALabels":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HPA labels.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_HPA_LABELS"},"CamelKubernetesEventAction":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-job","title":"Kubernetes Job","description":"Perform operations on Kubernetes Jobs.","deprecated":false,"firstVersion":"2.23.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.job.KubernetesJobComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-job","extendsScheme":"","syntax":"kubernetes-job:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesJobName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Job name.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_JOB_NAME"},"CamelKubernetesJobSpec":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.batch.v1.JobSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a Job.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_JOB_SPEC"},"CamelKubernetesJobLabels":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Job labels.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_JOB_LABELS"},"CamelKubernetesJobAnnotations":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Job annotations.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_JOB_ANNOTATIONS"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-job","title":"Kubernetes Job","description":"Perform operations on Kubernetes Jobs.","deprecated":false,"firstVersion":"2.23.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.job.KubernetesJobComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-job","extendsScheme":"","syntax":"kubernetes-job:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesJobName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Job name.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_JOB_NAME"},"CamelKubernetesJobSpec":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.batch.v1.JobSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a Job.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_JOB_SPEC"},"CamelKubernetesJobLabels":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Job labels.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_JOB_LABELS"},"CamelKubernetesJobAnnotations":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Job annotations.","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_JOB_ANNOTATIONS"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-namespaces","title":"Kubernetes Namespaces","description":"Perform operations on Kubernetes Namespaces and get notified on Namespace changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.namespaces.KubernetesNamespacesComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-namespaces","extendsScheme":"","syntax":"kubernetes-namespaces:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesNamespaceLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_LABELS"},"CamelKubernetesEventAction":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-namespaces","title":"Kubernetes Namespaces","description":"Perform operations on Kubernetes Namespaces and get notified on Namespace changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.namespaces.KubernetesNamespacesComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-namespaces","extendsScheme":"","syntax":"kubernetes-namespaces:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesNamespaceLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_LABELS"},"CamelKubernetesEventAction":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-nodes","title":"Kubernetes Nodes","description":"Perform operations on Kubernetes Nodes and get notified on Node changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.nodes.KubernetesNodesComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-nodes","extendsScheme":"","syntax":"kubernetes-nodes:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNodesLabels":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The node labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NODES_LABELS"},"CamelKubernetesNodeName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The node name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NODE_NAME"},"CamelKubernetesNodeSpec":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.NodeSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a node","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NODE_SPEC"},"CamelKubernetesEventAction":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-nodes","title":"Kubernetes Nodes","description":"Perform operations on Kubernetes Nodes and get notified on Node changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.nodes.KubernetesNodesComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-nodes","extendsScheme":"","syntax":"kubernetes-nodes:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNodesLabels":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The node labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NODES_LABELS"},"CamelKubernetesNodeName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The node name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NODE_NAME"},"CamelKubernetesNodeSpec":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.NodeSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a node","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NODE_SPEC"},"CamelKubernetesEventAction":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-persistent-volumes","title":"Kubernetes Persistent Volume","description":"Perform operations on Kubernetes Persistent Volumes and get notified on Persistent Volume changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.persistent_volumes.KubernetesPersistentVolumesComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-persistent-volumes","extendsScheme":"","syntax":"kubernetes-persistent-volumes:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesPersistentVolumesLabels":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The persistent volume labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_PERSISTENT_VOLUMES_LABELS"},"CamelKubernetesPersistentVolumeName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The persistent volume name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_PERSISTENT_VOLUME_NAME"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-persistent-volumes","title":"Kubernetes Persistent Volume","description":"Perform operations on Kubernetes Persistent Volumes and get notified on Persistent Volume changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.persistent_volumes.KubernetesPersistentVolumesComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-persistent-volumes","extendsScheme":"","syntax":"kubernetes-persistent-volumes:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesPersistentVolumesLabels":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The persistent volume labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_PERSISTENT_VOLUMES_LABELS"},"CamelKubernetesPersistentVolumeName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The persistent volume name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_PERSISTENT_VOLUME_NAME"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-persistent-volumes-claims","title":"Kubernetes Persistent Volume Claim","description":"Perform operations on Kubernetes Persistent Volumes Claims and get notified on Persistent Volumes Claim changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.persistent_volumes_claims.KubernetesPersistentVolumesClaimsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-persistent-volumes-claims","extendsScheme":"","syntax":"kubernetes-persistent-volumes-claims:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesPersistentVolumesClaimsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The persistent volume claim labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_PERSISTENT_VOLUMES_CLAIMS_LABELS"},"CamelKubernetesPersistentVolumeClaimName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The persistent volume claim name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_PERSISTENT_VOLUME_CLAIM_NAME"},"CamelKubernetesPersistentVolumeClaimSpec":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.PersistentVolumeClaimSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a persistent volume claim","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_PERSISTENT_VOLUME_CLAIM_SPEC"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-persistent-volumes-claims","title":"Kubernetes Persistent Volume Claim","description":"Perform operations on Kubernetes Persistent Volumes Claims and get notified on Persistent Volumes Claim changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.persistent_volumes_claims.KubernetesPersistentVolumesClaimsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-persistent-volumes-claims","extendsScheme":"","syntax":"kubernetes-persistent-volumes-claims:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesPersistentVolumesClaimsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The persistent volume claim labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_PERSISTENT_VOLUMES_CLAIMS_LABELS"},"CamelKubernetesPersistentVolumeClaimName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The persistent volume claim name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_PERSISTENT_VOLUME_CLAIM_NAME"},"CamelKubernetesPersistentVolumeClaimSpec":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.PersistentVolumeClaimSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a persistent volume claim","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_PERSISTENT_VOLUME_CLAIM_SPEC"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-pods","title":"Kubernetes Pods","description":"Perform operations on Kubernetes Pods and get notified on Pod changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.pods.KubernetesPodsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-pods","extendsScheme":"","syntax":"kubernetes-pods:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesPodsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The pod labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_PODS_LABELS"},"CamelKubernetesPodName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The pod name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_POD_NAME"},"CamelKubernetesPodSpec":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.PodSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a pod","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_POD_SPEC"},"CamelKubernetesEventAction":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-pods","title":"Kubernetes Pods","description":"Perform operations on Kubernetes Pods and get notified on Pod changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.pods.KubernetesPodsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-pods","extendsScheme":"","syntax":"kubernetes-pods:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesPodsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The pod labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_PODS_LABELS"},"CamelKubernetesPodName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The pod name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_POD_NAME"},"CamelKubernetesPodSpec":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.PodSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a pod","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_POD_SPEC"},"CamelKubernetesEventAction":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-replication-controllers","title":"Kubernetes Replication Controller","description":"Perform operations on Kubernetes Replication Controllers and get notified on Replication Controllers changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.replication_controllers.KubernetesReplicationControllersComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-replication-controllers","extendsScheme":"","syntax":"kubernetes-replication-controllers:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesReplicationControllersLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The replication controller labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_REPLICATION_CONTROLLERS_LABELS"},"CamelKubernetesReplicationControllerName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The replication controller name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_REPLICATION_CONTROLLER_NAME"},"CamelKubernetesReplicationControllerSpec":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.ReplicationControllerSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a replication controller","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_REPLICATION_CONTROLLER_SPEC"},"CamelKubernetesReplicationControllerReplicas":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of replicas for a replication controller during the Scale operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_REPLICATION_CONTROLLER_REPLICAS"},"CamelKubernetesEventAction":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-replication-controllers","title":"Kubernetes Replication Controller","description":"Perform operations on Kubernetes Replication Controllers and get notified on Replication Controllers changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.replication_controllers.KubernetesReplicationControllersComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-replication-controllers","extendsScheme":"","syntax":"kubernetes-replication-controllers:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesReplicationControllersLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The replication controller labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_REPLICATION_CONTROLLERS_LABELS"},"CamelKubernetesReplicationControllerName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The replication controller name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_REPLICATION_CONTROLLER_NAME"},"CamelKubernetesReplicationControllerSpec":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.ReplicationControllerSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a replication controller","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_REPLICATION_CONTROLLER_SPEC"},"CamelKubernetesReplicationControllerReplicas":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of replicas for a replication controller during the Scale operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_REPLICATION_CONTROLLER_REPLICAS"},"CamelKubernetesEventAction":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-resources-quota","title":"Kubernetes Resources Quota","description":"Perform operations on Kubernetes Resources Quotas.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.resources_quota.KubernetesResourcesQuotaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-resources-quota","extendsScheme":"","syntax":"kubernetes-resources-quota:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesResourcesQuotaLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resource quota labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_RESOURCES_QUOTA_LABELS"},"CamelKubernetesResourcesQuotaName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resource quota name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_RESOURCES_QUOTA_NAME"},"CamelKubernetesResourceQuotaSpec":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.ResourceQuotaSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a resource quota","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_RESOURCE_QUOTA_SPEC"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-resources-quota","title":"Kubernetes Resources Quota","description":"Perform operations on Kubernetes Resources Quotas.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.resources_quota.KubernetesResourcesQuotaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-resources-quota","extendsScheme":"","syntax":"kubernetes-resources-quota:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesResourcesQuotaLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resource quota labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_RESOURCES_QUOTA_LABELS"},"CamelKubernetesResourcesQuotaName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resource quota name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_RESOURCES_QUOTA_NAME"},"CamelKubernetesResourceQuotaSpec":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.ResourceQuotaSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a resource quota","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_RESOURCE_QUOTA_SPEC"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-secrets","title":"Kubernetes Secrets","description":"Perform operations on Kubernetes Secrets.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.secrets.KubernetesSecretsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-secrets","extendsScheme":"","syntax":"kubernetes-secrets:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesSecretsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The secret labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SECRETS_LABELS"},"CamelKubernetesSecretName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The secret name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SECRET_NAME"},"CamelKubernetesSecret":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.Secret","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A secret object","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SECRET"},"CamelKubernetesSecretsAnnotations":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The secret annotations","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SECRETS_ANNOTATIONS"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-secrets","title":"Kubernetes Secrets","description":"Perform operations on Kubernetes Secrets.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.secrets.KubernetesSecretsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-secrets","extendsScheme":"","syntax":"kubernetes-secrets:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesSecretsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The secret labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SECRETS_LABELS"},"CamelKubernetesSecretName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The secret name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SECRET_NAME"},"CamelKubernetesSecret":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.Secret","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A secret object","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SECRET"},"CamelKubernetesSecretsAnnotations":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The secret annotations","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SECRETS_ANNOTATIONS"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-service-accounts","title":"Kubernetes Service Account","description":"Perform operations on Kubernetes Service Accounts.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.service_accounts.KubernetesServiceAccountsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-service-accounts","extendsScheme":"","syntax":"kubernetes-service-accounts:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesServiceAccountsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The service account labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SERVICE_ACCOUNTS_LABELS"},"CamelKubernetesServiceAccountName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The service account name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SERVICE_ACCOUNT_NAME"},"CamelKubernetesServiceAccount":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.ServiceAccount","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A service account object","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SERVICE_ACCOUNT"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-service-accounts","title":"Kubernetes Service Account","description":"Perform operations on Kubernetes Service Accounts.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.service_accounts.KubernetesServiceAccountsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-service-accounts","extendsScheme":"","syntax":"kubernetes-service-accounts:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesServiceAccountsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The service account labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SERVICE_ACCOUNTS_LABELS"},"CamelKubernetesServiceAccountName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The service account name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SERVICE_ACCOUNT_NAME"},"CamelKubernetesServiceAccount":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.ServiceAccount","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A service account object","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SERVICE_ACCOUNT"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kubernetes-services","title":"Kubernetes Services","description":"Perform operations on Kubernetes Services and get notified on Service changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.services.KubernetesServicesComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"kubernetes-services","extendsScheme":"","syntax":"kubernetes-services:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesServiceLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The service labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SERVICE_LABELS"},"CamelKubernetesServiceName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The service name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SERVICE_NAME"},"CamelKubernetesServiceSpec":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.ServiceSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec of a service","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SERVICE_SPEC"},"CamelKubernetesEventAction":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"kubernetes-services","title":"Kubernetes Services","description":"Perform operations on Kubernetes Services and get notified on Service changes.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.kubernetes.services.KubernetesServicesComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"kubernetes-services","extendsScheme":"","syntax":"kubernetes-services:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesServiceLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The service labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SERVICE_LABELS"},"CamelKubernetesServiceName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The service name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SERVICE_NAME"},"CamelKubernetesServiceSpec":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.kubernetes.api.model.ServiceSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec of a service","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_SERVICE_SPEC"},"CamelKubernetesEventAction":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"kudu","title":"Kudu","description":"Interact with Apache Kudu, a free and open source column-oriented data store of the Apache Hadoop ecosystem.","deprecated":false,"firstVersion":"3.0","label":"database,iot,cloud","javaType":"org.apache.camel.component.kudu.KuduComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kudu","version":"4.8.1","scheme":"kudu","extendsScheme":"","syntax":"kudu:host:port/tableName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKuduSchema":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.kudu.Schema","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The schema","constantName":"org.apache.camel.component.kudu.KuduConstants#CAMEL_KUDU_SCHEMA"},"CamelKuduTableOptions":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.kudu.client.CreateTableOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The create table options","constantName":"org.apache.camel.component.kudu.KuduConstants#CAMEL_KUDU_TABLE_OPTIONS"},"CamelKuduScanColumnNames":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.util.List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The projected column names for scan operation","constantName":"org.apache.camel.component.kudu.KuduConstants#CAMEL_KUDU_SCAN_COLUMN_NAMES"},"CamelKuduScanPredicate":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.kudu.client.KuduPredicate","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The predicate for scan operation","constantName":"org.apache.camel.component.kudu.KuduConstants#CAMEL_KUDU_SCAN_PREDICATE"},"CamelKuduScanLimit":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit on the number of rows for scan operation","constantName":"org.apache.camel.component.kudu.KuduConstants#CAMEL_KUDU_SCAN_LIMIT"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Host of the server to connect to"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Port of the server to connect to"},"tableName":{"index":2,"kind":"path","displayName":"Table Name","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Table to connect to"},"operation":{"index":3,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.kudu.KuduOperations","enum":["INSERT","DELETE","UPDATE","UPSERT","CREATE_TABLE","SCAN"],"deprecated":false,"autowired":false,"secret":false,"description":"Operation to perform"},"lazyStartProducer":{"index":4,"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."}}} +{"component":{"kind":"component","name":"kudu","title":"Kudu","description":"Interact with Apache Kudu, a free and open source column-oriented data store of the Apache Hadoop ecosystem.","deprecated":false,"firstVersion":"3.0","label":"database,iot,cloud","javaType":"org.apache.camel.component.kudu.KuduComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kudu","version":"4.8.2","scheme":"kudu","extendsScheme":"","syntax":"kudu:host:port/tableName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKuduSchema":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.kudu.Schema","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The schema","constantName":"org.apache.camel.component.kudu.KuduConstants#CAMEL_KUDU_SCHEMA"},"CamelKuduTableOptions":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.kudu.client.CreateTableOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The create table options","constantName":"org.apache.camel.component.kudu.KuduConstants#CAMEL_KUDU_TABLE_OPTIONS"},"CamelKuduScanColumnNames":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.util.List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The projected column names for scan operation","constantName":"org.apache.camel.component.kudu.KuduConstants#CAMEL_KUDU_SCAN_COLUMN_NAMES"},"CamelKuduScanPredicate":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.kudu.client.KuduPredicate","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The predicate for scan operation","constantName":"org.apache.camel.component.kudu.KuduConstants#CAMEL_KUDU_SCAN_PREDICATE"},"CamelKuduScanLimit":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The limit on the number of rows for scan operation","constantName":"org.apache.camel.component.kudu.KuduConstants#CAMEL_KUDU_SCAN_LIMIT"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Host of the server to connect to"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Port of the server to connect to"},"tableName":{"index":2,"kind":"path","displayName":"Table Name","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Table to connect to"},"operation":{"index":3,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.kudu.KuduOperations","enum":["INSERT","DELETE","UPDATE","UPSERT","CREATE_TABLE","SCAN"],"deprecated":false,"autowired":false,"secret":false,"description":"Operation to perform"},"lazyStartProducer":{"index":4,"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."}}} , -{"component":{"kind":"component","name":"langchain4j-chat","title":"LangChain4j Chat","description":"LangChain4j Chat component","deprecated":false,"firstVersion":"4.5.0","label":"ai","javaType":"org.apache.camel.component.langchain4j.chat.LangChain4jChatComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-langchain4j-chat","version":"4.8.1","scheme":"langchain4j-chat","extendsScheme":"","syntax":"langchain4j-chat:chatId","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelLangChain4jChatPromptTemplate":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The prompt Template.","constantName":"org.apache.camel.component.langchain4j.chat.LangChain4jChat$Headers#PROMPT_TEMPLATE"},"CamelLangChain4jChatAugmentedData":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Augmented Data for RAG","constantName":"org.apache.camel.component.langchain4j.chat.LangChain4jChat$Headers#AUGMENTED_DATA"}},"properties":{"chatId":{"index":0,"kind":"path","displayName":"Chat Id","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id"},"chatOperation":{"index":1,"kind":"parameter","displayName":"Chat Operation","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.langchain4j.chat.LangChain4jChatOperations","enum":["CHAT_SINGLE_MESSAGE","CHAT_SINGLE_MESSAGE_WITH_PROMPT","CHAT_MULTIPLE_MESSAGES"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"CHAT_SINGLE_MESSAGE","configurationClass":"org.apache.camel.component.langchain4j.chat.LangChain4jChatConfiguration","configurationField":"configuration","description":"Operation in case of Endpoint of type CHAT. The value is one of the values of org.apache.camel.component.langchain4j.chat.LangChain4jChatOperations"},"description":{"index":2,"kind":"parameter","displayName":"Description","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tool description"},"parameters":{"index":3,"kind":"parameter","displayName":"Parameters","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"java.util.Map","enum":["string","integer","number","object","array","boolean","null"],"prefix":"parameter.","multiValue":true,"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of Tool parameters in the form of parameter.="},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"camelToolParameter":{"index":5,"kind":"parameter","displayName":"Camel Tool Parameter","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.langchain4j.chat.tool.CamelSimpleToolParameter","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tool's Camel Parameters, programmatically define Tool description and parameters"},"exceptionHandler":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."},"chatModel":{"index":9,"kind":"parameter","displayName":"Chat Model","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"dev.langchain4j.model.chat.ChatLanguageModel","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.chat.LangChain4jChatConfiguration","configurationField":"configuration","description":"Chat Language Model of type dev.langchain4j.model.chat.ChatLanguageModel"}}} +{"component":{"kind":"component","name":"langchain4j-chat","title":"LangChain4j Chat","description":"LangChain4j Chat component","deprecated":false,"firstVersion":"4.5.0","label":"ai","javaType":"org.apache.camel.component.langchain4j.chat.LangChain4jChatComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-langchain4j-chat","version":"4.8.2","scheme":"langchain4j-chat","extendsScheme":"","syntax":"langchain4j-chat:chatId","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelLangChain4jChatPromptTemplate":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The prompt Template.","constantName":"org.apache.camel.component.langchain4j.chat.LangChain4jChat$Headers#PROMPT_TEMPLATE"},"CamelLangChain4jChatAugmentedData":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Augmented Data for RAG","constantName":"org.apache.camel.component.langchain4j.chat.LangChain4jChat$Headers#AUGMENTED_DATA"}},"properties":{"chatId":{"index":0,"kind":"path","displayName":"Chat Id","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id"},"chatOperation":{"index":1,"kind":"parameter","displayName":"Chat Operation","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.langchain4j.chat.LangChain4jChatOperations","enum":["CHAT_SINGLE_MESSAGE","CHAT_SINGLE_MESSAGE_WITH_PROMPT","CHAT_MULTIPLE_MESSAGES"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"CHAT_SINGLE_MESSAGE","configurationClass":"org.apache.camel.component.langchain4j.chat.LangChain4jChatConfiguration","configurationField":"configuration","description":"Operation in case of Endpoint of type CHAT. The value is one of the values of org.apache.camel.component.langchain4j.chat.LangChain4jChatOperations"},"description":{"index":2,"kind":"parameter","displayName":"Description","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tool description"},"parameters":{"index":3,"kind":"parameter","displayName":"Parameters","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"java.util.Map","enum":["string","integer","number","object","array","boolean","null"],"prefix":"parameter.","multiValue":true,"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of Tool parameters in the form of parameter.="},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"camelToolParameter":{"index":5,"kind":"parameter","displayName":"Camel Tool Parameter","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.langchain4j.chat.tool.CamelSimpleToolParameter","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tool's Camel Parameters, programmatically define Tool description and parameters"},"exceptionHandler":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."},"chatModel":{"index":9,"kind":"parameter","displayName":"Chat Model","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"dev.langchain4j.model.chat.ChatLanguageModel","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.chat.LangChain4jChatConfiguration","configurationField":"configuration","description":"Chat Language Model of type dev.langchain4j.model.chat.ChatLanguageModel"}}} , -{"component":{"kind":"component","name":"langchain4j-embeddings","title":"LangChain4j Embeddings","description":"LangChain4j Embeddings","deprecated":false,"firstVersion":"4.5.0","label":"ai","javaType":"org.apache.camel.component.langchain4j.embeddings.LangChain4jEmbeddingsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-langchain4j-embeddings","version":"4.8.1","scheme":"langchain4j-embeddings","extendsScheme":"","syntax":"langchain4j-embeddings:embeddingId","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelLangChain4jEmbeddingsFinishReason":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"dev.langchain4j.model.output.FinishReason","enum":["STOP","LENGTH","TOOL_EXECUTION","CONTENT_FILTER","OTHER"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Finish Reason.","constantName":"org.apache.camel.component.langchain4j.embeddings.LangChain4jEmbeddings$Headers#FINISH_REASON"},"CamelLangChain4jEmbeddingsInputTokenCount":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Input Token Count.","constantName":"org.apache.camel.component.langchain4j.embeddings.LangChain4jEmbeddings$Headers#INPUT_TOKEN_COUNT"},"CamelLangChain4jEmbeddingsOutputTokenCount":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Output Token Count.","constantName":"org.apache.camel.component.langchain4j.embeddings.LangChain4jEmbeddings$Headers#OUTPUT_TOKEN_COUNT"},"CamelLangChain4jEmbeddingsTotalTokenCount":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Total Token Count.","constantName":"org.apache.camel.component.langchain4j.embeddings.LangChain4jEmbeddings$Headers#TOTAL_TOKEN_COUNT"},"CamelLangChain4jEmbeddingsVector":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"float[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A dense vector embedding of a text","constantName":"org.apache.camel.component.langchain4j.embeddings.LangChain4jEmbeddings$Headers#VECTOR"}},"properties":{"embeddingId":{"index":0,"kind":"path","displayName":"Embedding Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id"},"embeddingModel":{"index":1,"kind":"parameter","displayName":"Embedding Model","group":"producer","label":"","required":true,"type":"object","javaType":"dev.langchain4j.model.embedding.EmbeddingModel","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.embeddings.LangChain4jEmbeddingsConfiguration","configurationField":"configuration","description":"The EmbeddingModel engine to use."},"lazyStartProducer":{"index":2,"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."}}} +{"component":{"kind":"component","name":"langchain4j-embeddings","title":"LangChain4j Embeddings","description":"LangChain4j Embeddings","deprecated":false,"firstVersion":"4.5.0","label":"ai","javaType":"org.apache.camel.component.langchain4j.embeddings.LangChain4jEmbeddingsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-langchain4j-embeddings","version":"4.8.2","scheme":"langchain4j-embeddings","extendsScheme":"","syntax":"langchain4j-embeddings:embeddingId","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelLangChain4jEmbeddingsFinishReason":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"dev.langchain4j.model.output.FinishReason","enum":["STOP","LENGTH","TOOL_EXECUTION","CONTENT_FILTER","OTHER"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Finish Reason.","constantName":"org.apache.camel.component.langchain4j.embeddings.LangChain4jEmbeddings$Headers#FINISH_REASON"},"CamelLangChain4jEmbeddingsInputTokenCount":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Input Token Count.","constantName":"org.apache.camel.component.langchain4j.embeddings.LangChain4jEmbeddings$Headers#INPUT_TOKEN_COUNT"},"CamelLangChain4jEmbeddingsOutputTokenCount":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Output Token Count.","constantName":"org.apache.camel.component.langchain4j.embeddings.LangChain4jEmbeddings$Headers#OUTPUT_TOKEN_COUNT"},"CamelLangChain4jEmbeddingsTotalTokenCount":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Total Token Count.","constantName":"org.apache.camel.component.langchain4j.embeddings.LangChain4jEmbeddings$Headers#TOTAL_TOKEN_COUNT"},"CamelLangChain4jEmbeddingsVector":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"float[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A dense vector embedding of a text","constantName":"org.apache.camel.component.langchain4j.embeddings.LangChain4jEmbeddings$Headers#VECTOR"}},"properties":{"embeddingId":{"index":0,"kind":"path","displayName":"Embedding Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id"},"embeddingModel":{"index":1,"kind":"parameter","displayName":"Embedding Model","group":"producer","label":"","required":true,"type":"object","javaType":"dev.langchain4j.model.embedding.EmbeddingModel","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.embeddings.LangChain4jEmbeddingsConfiguration","configurationField":"configuration","description":"The EmbeddingModel engine to use."},"lazyStartProducer":{"index":2,"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."}}} , -{"component":{"kind":"component","name":"langchain4j-tools","title":"LangChain4j Tools","description":"LangChain4j Tools and Function Calling Features","deprecated":false,"firstVersion":"4.8.0","label":"ai","javaType":"org.apache.camel.component.langchain4j.tools.LangChain4jToolsComponent","supportLevel":"Experimental","groupId":"org.apache.camel","artifactId":"camel-langchain4j-tools","version":"4.8.1","scheme":"langchain4j-tools","extendsScheme":"","syntax":"langchain4j-tools:toolId","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"toolId":{"index":0,"kind":"path","displayName":"Tool Id","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tool name"},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tags for the tools"},"description":{"index":2,"kind":"parameter","displayName":"Description","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tool description"},"parameters":{"index":3,"kind":"parameter","displayName":"Parameters","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"java.util.Map","prefix":"parameter.","multiValue":true,"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of Tool parameters in the form of parameter.="},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"camelToolParameter":{"index":5,"kind":"parameter","displayName":"Camel Tool Parameter","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.langchain4j.tools.spec.CamelSimpleToolParameter","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tool's Camel Parameters, programmatically define Tool description and parameters"},"exceptionHandler":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."},"chatModel":{"index":9,"kind":"parameter","displayName":"Chat Model","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"dev.langchain4j.model.chat.ChatLanguageModel","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.tools.LangChain4jToolsConfiguration","configurationField":"configuration","description":"Chat Language Model of type dev.langchain4j.model.chat.ChatLanguageModel"}}} +{"component":{"kind":"component","name":"langchain4j-tools","title":"LangChain4j Tools","description":"LangChain4j Tools and Function Calling Features","deprecated":false,"firstVersion":"4.8.0","label":"ai","javaType":"org.apache.camel.component.langchain4j.tools.LangChain4jToolsComponent","supportLevel":"Experimental","groupId":"org.apache.camel","artifactId":"camel-langchain4j-tools","version":"4.8.2","scheme":"langchain4j-tools","extendsScheme":"","syntax":"langchain4j-tools:toolId","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"toolId":{"index":0,"kind":"path","displayName":"Tool Id","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tool name"},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tags for the tools"},"description":{"index":2,"kind":"parameter","displayName":"Description","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tool description"},"parameters":{"index":3,"kind":"parameter","displayName":"Parameters","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"java.util.Map","prefix":"parameter.","multiValue":true,"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of Tool parameters in the form of parameter.="},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"camelToolParameter":{"index":5,"kind":"parameter","displayName":"Camel Tool Parameter","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.langchain4j.tools.spec.CamelSimpleToolParameter","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tool's Camel Parameters, programmatically define Tool description and parameters"},"exceptionHandler":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."},"chatModel":{"index":9,"kind":"parameter","displayName":"Chat Model","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"dev.langchain4j.model.chat.ChatLanguageModel","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.tools.LangChain4jToolsConfiguration","configurationField":"configuration","description":"Chat Language Model of type dev.langchain4j.model.chat.ChatLanguageModel"}}} , -{"component":{"kind":"component","name":"langchain4j-web-search","title":"LangChain4j Web Search","description":"LangChain4j Web Search Engine","deprecated":false,"firstVersion":"4.8.0","label":"ai","javaType":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-langchain4j-web-search","version":"4.8.1","scheme":"langchain4j-web-search","extendsScheme":"","syntax":"langchain4j-web-search:searchId","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"searchId":{"index":0,"kind":"path","displayName":"Search Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id"},"additionalParams":{"index":1,"kind":"parameter","displayName":"Additional Params","group":"producer","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The additionalParams is the additional parameters for the search request are a map of key-value pairs that represent additional parameters for the search request."},"geoLocation":{"index":2,"kind":"parameter","displayName":"Geo Location","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The geoLocation is the desired geolocation for search results. Each search engine may have a different set of supported geolocations."},"language":{"index":3,"kind":"parameter","displayName":"Language","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The language is the desired language for search results. The expected values may vary depending on the search engine."},"maxResults":{"index":4,"kind":"parameter","displayName":"Max Results","group":"producer","label":"","required":true,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The maxResults is the expected number of results to be found if the search request were made. Each search engine may have a different limit for the maximum number of results that can be returned."},"resultType":{"index":5,"kind":"parameter","displayName":"Result Type","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchResultType","enum":["LANGCHAIN4J_WEB_SEARCH_ORGANIC_RESULT","CONTENT","SNIPPET"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"CONTENT","configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The resultType is the result type of the request. Valid values are LANGCHAIN4J_WEB_SEARCH_ORGANIC_RESULT, CONTENT, or SNIPPET. CONTENT is the default value; it will return a list of String . You can also specify to return either the Langchain4j Web Search Organic Result object (using LANGCHAIN4J_WEB_SEARCH_ORGANIC_RESULT) or snippet (using SNIPPET) for each result. If maxResults is equal to 1, the response will be a single object instead of a list."},"safeSearch":{"index":6,"kind":"parameter","displayName":"Safe Search","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The safeSearch is the safe search flag, indicating whether to enable or disable safe search."},"startIndex":{"index":7,"kind":"parameter","displayName":"Start Index","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The startIndex is the start index for search results, which may vary depending on the search engine."},"startPage":{"index":8,"kind":"parameter","displayName":"Start Page","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The startPage is the start page number for search results"},"webSearchEngine":{"index":9,"kind":"parameter","displayName":"Web Search Engine","group":"producer","label":"","required":true,"type":"object","javaType":"dev.langchain4j.web.search.WebSearchEngine","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The WebSearchEngine engine to use. This is mandatory. Use one of the implementations from Langchain4j web search engines."},"lazyStartProducer":{"index":10,"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."},"webSearchRequest":{"index":11,"kind":"parameter","displayName":"Web Search Request","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"dev.langchain4j.web.search.WebSearchRequest","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The webSearchRequest is the custom WebSearchRequest - advanced"}}} +{"component":{"kind":"component","name":"langchain4j-web-search","title":"LangChain4j Web Search","description":"LangChain4j Web Search Engine","deprecated":false,"firstVersion":"4.8.0","label":"ai","javaType":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-langchain4j-web-search","version":"4.8.2","scheme":"langchain4j-web-search","extendsScheme":"","syntax":"langchain4j-web-search:searchId","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"searchId":{"index":0,"kind":"path","displayName":"Search Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id"},"additionalParams":{"index":1,"kind":"parameter","displayName":"Additional Params","group":"producer","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The additionalParams is the additional parameters for the search request are a map of key-value pairs that represent additional parameters for the search request."},"geoLocation":{"index":2,"kind":"parameter","displayName":"Geo Location","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The geoLocation is the desired geolocation for search results. Each search engine may have a different set of supported geolocations."},"language":{"index":3,"kind":"parameter","displayName":"Language","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The language is the desired language for search results. The expected values may vary depending on the search engine."},"maxResults":{"index":4,"kind":"parameter","displayName":"Max Results","group":"producer","label":"","required":true,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The maxResults is the expected number of results to be found if the search request were made. Each search engine may have a different limit for the maximum number of results that can be returned."},"resultType":{"index":5,"kind":"parameter","displayName":"Result Type","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchResultType","enum":["LANGCHAIN4J_WEB_SEARCH_ORGANIC_RESULT","CONTENT","SNIPPET"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"CONTENT","configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The resultType is the result type of the request. Valid values are LANGCHAIN4J_WEB_SEARCH_ORGANIC_RESULT, CONTENT, or SNIPPET. CONTENT is the default value; it will return a list of String . You can also specify to return either the Langchain4j Web Search Organic Result object (using LANGCHAIN4J_WEB_SEARCH_ORGANIC_RESULT) or snippet (using SNIPPET) for each result. If maxResults is equal to 1, the response will be a single object instead of a list."},"safeSearch":{"index":6,"kind":"parameter","displayName":"Safe Search","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The safeSearch is the safe search flag, indicating whether to enable or disable safe search."},"startIndex":{"index":7,"kind":"parameter","displayName":"Start Index","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The startIndex is the start index for search results, which may vary depending on the search engine."},"startPage":{"index":8,"kind":"parameter","displayName":"Start Page","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The startPage is the start page number for search results"},"webSearchEngine":{"index":9,"kind":"parameter","displayName":"Web Search Engine","group":"producer","label":"","required":true,"type":"object","javaType":"dev.langchain4j.web.search.WebSearchEngine","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The WebSearchEngine engine to use. This is mandatory. Use one of the implementations from Langchain4j web search engines."},"lazyStartProducer":{"index":10,"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."},"webSearchRequest":{"index":11,"kind":"parameter","displayName":"Web Search Request","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"dev.langchain4j.web.search.WebSearchRequest","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchConfiguration","configurationField":"configuration","description":"The webSearchRequest is the custom WebSearchRequest - advanced"}}} , -{"component":{"kind":"component","name":"language","title":"Language","description":"Execute scripts in any of the languages supported by Camel.","deprecated":false,"firstVersion":"2.5.0","label":"core,script","javaType":"org.apache.camel.component.language.LanguageComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-language","version":"4.8.1","scheme":"language","extendsScheme":"","syntax":"language:languageName:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelLanguageScript":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String or Expression","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The script to execute provided in the header. Takes precedence over script configured on the endpoint.","constantName":"org.apache.camel.component.language.LanguageConstants#LANGUAGE_SCRIPT"}},"properties":{"languageName":{"index":0,"kind":"path","displayName":"Language Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["bean","constant","csimple","datasonnet","exchangeProperty","file","groovy","header","hl7terser","java","joor","jq","jsonpath","mvel","ognl","ref","simple","spel","sql","tokenize","xpath","xquery","xtokenize"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the name of the language to use"},"resourceUri":{"index":1,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource, or a reference to lookup a bean in the Registry to use as the resource"},"allowContextMapAll":{"index":2,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"binary":{"index":3,"kind":"parameter","displayName":"Binary","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the script is binary content or text content. By default the script is read as text content (eg java.lang.String)"},"cacheScript":{"index":4,"kind":"parameter","displayName":"Cache Script","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to cache the compiled script and reuse Notice reusing the script can cause side effects from processing one Camel org.apache.camel.Exchange to the next org.apache.camel.Exchange."},"contentCache":{"index":5,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to use resource content cache or not"},"resultType":{"index":6,"kind":"parameter","displayName":"Result Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the class of the result type (type from output)"},"script":{"index":7,"kind":"parameter","displayName":"Script","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the script to execute"},"transform":{"index":8,"kind":"parameter","displayName":"Transform","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not the result of the script should be used as message body. This options is default true."},"lazyStartProducer":{"index":9,"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."}}} +{"component":{"kind":"component","name":"language","title":"Language","description":"Execute scripts in any of the languages supported by Camel.","deprecated":false,"firstVersion":"2.5.0","label":"core,script","javaType":"org.apache.camel.component.language.LanguageComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-language","version":"4.8.2","scheme":"language","extendsScheme":"","syntax":"language:languageName:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelLanguageScript":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String or Expression","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The script to execute provided in the header. Takes precedence over script configured on the endpoint.","constantName":"org.apache.camel.component.language.LanguageConstants#LANGUAGE_SCRIPT"}},"properties":{"languageName":{"index":0,"kind":"path","displayName":"Language Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["bean","constant","csimple","datasonnet","exchangeProperty","file","groovy","header","hl7terser","java","joor","jq","jsonpath","mvel","ognl","ref","simple","spel","sql","tokenize","xpath","xquery","xtokenize"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the name of the language to use"},"resourceUri":{"index":1,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource, or a reference to lookup a bean in the Registry to use as the resource"},"allowContextMapAll":{"index":2,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"binary":{"index":3,"kind":"parameter","displayName":"Binary","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the script is binary content or text content. By default the script is read as text content (eg java.lang.String)"},"cacheScript":{"index":4,"kind":"parameter","displayName":"Cache Script","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to cache the compiled script and reuse Notice reusing the script can cause side effects from processing one Camel org.apache.camel.Exchange to the next org.apache.camel.Exchange."},"contentCache":{"index":5,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to use resource content cache or not"},"resultType":{"index":6,"kind":"parameter","displayName":"Result Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the class of the result type (type from output)"},"script":{"index":7,"kind":"parameter","displayName":"Script","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the script to execute"},"transform":{"index":8,"kind":"parameter","displayName":"Transform","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not the result of the script should be used as message body. This options is default true."},"lazyStartProducer":{"index":9,"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."}}} , -{"component":{"kind":"component","name":"ldap","title":"LDAP","description":"Perform searches on LDAP servers.","deprecated":false,"firstVersion":"1.5.0","label":"database,security","javaType":"org.apache.camel.component.ldap.LdapComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ldap","version":"4.8.1","scheme":"ldap","extendsScheme":"","syntax":"ldap:dirContextName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"dirContextName":{"index":0,"kind":"path","displayName":"Dir Context Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of either a javax.naming.directory.DirContext, or java.util.Hashtable, or Map bean to lookup in the registry. If the bean is either a Hashtable or Map then a new javax.naming.directory.DirContext instance is created for each use. If the bean is a javax.naming.directory.DirContext then the bean is used as given. The latter may not be possible in all situations where the javax.naming.directory.DirContext must not be shared, and in those situations it can be better to use java.util.Hashtable or Map instead."},"base":{"index":1,"kind":"parameter","displayName":"Base","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ou=system","description":"The base DN for searches."},"pageSize":{"index":2,"kind":"parameter","displayName":"Page Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"When specified the ldap module uses paging to retrieve all results (most LDAP Servers throw an exception when trying to retrieve more than 1000 entries in one query). To be able to use this a LdapContext (subclass of DirContext) has to be passed in as ldapServerBean (otherwise an exception is thrown)"},"returnedAttributes":{"index":3,"kind":"parameter","displayName":"Returned Attributes","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Comma-separated list of attributes that should be set in each entry of the result"},"scope":{"index":4,"kind":"parameter","displayName":"Scope","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["object","onelevel","subtree"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"subtree","description":"Specifies how deeply to search the tree of entries, starting at the base DN."},"lazyStartProducer":{"index":5,"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."}}} +{"component":{"kind":"component","name":"ldap","title":"LDAP","description":"Perform searches on LDAP servers.","deprecated":false,"firstVersion":"1.5.0","label":"database,security","javaType":"org.apache.camel.component.ldap.LdapComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ldap","version":"4.8.2","scheme":"ldap","extendsScheme":"","syntax":"ldap:dirContextName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"dirContextName":{"index":0,"kind":"path","displayName":"Dir Context Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of either a javax.naming.directory.DirContext, or java.util.Hashtable, or Map bean to lookup in the registry. If the bean is either a Hashtable or Map then a new javax.naming.directory.DirContext instance is created for each use. If the bean is a javax.naming.directory.DirContext then the bean is used as given. The latter may not be possible in all situations where the javax.naming.directory.DirContext must not be shared, and in those situations it can be better to use java.util.Hashtable or Map instead."},"base":{"index":1,"kind":"parameter","displayName":"Base","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ou=system","description":"The base DN for searches."},"pageSize":{"index":2,"kind":"parameter","displayName":"Page Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"When specified the ldap module uses paging to retrieve all results (most LDAP Servers throw an exception when trying to retrieve more than 1000 entries in one query). To be able to use this a LdapContext (subclass of DirContext) has to be passed in as ldapServerBean (otherwise an exception is thrown)"},"returnedAttributes":{"index":3,"kind":"parameter","displayName":"Returned Attributes","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Comma-separated list of attributes that should be set in each entry of the result"},"scope":{"index":4,"kind":"parameter","displayName":"Scope","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["object","onelevel","subtree"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"subtree","description":"Specifies how deeply to search the tree of entries, starting at the base DN."},"lazyStartProducer":{"index":5,"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."}}} , -{"component":{"kind":"component","name":"ldif","title":"LDIF","description":"Perform updates on an LDAP server from an LDIF body content.","deprecated":false,"firstVersion":"2.20.0","label":"database,security","javaType":"org.apache.camel.component.ldif.LdifComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ldif","version":"4.8.1","scheme":"ldif","extendsScheme":"","syntax":"ldif:ldapConnectionName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"ldapConnectionName":{"index":0,"kind":"path","displayName":"Ldap Connection Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the LdapConnection bean to pull from the registry. Note that this must be of scope prototype to avoid it being shared among threads or using a connection that has timed out."},"lazyStartProducer":{"index":1,"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."}}} +{"component":{"kind":"component","name":"ldif","title":"LDIF","description":"Perform updates on an LDAP server from an LDIF body content.","deprecated":false,"firstVersion":"2.20.0","label":"database,security","javaType":"org.apache.camel.component.ldif.LdifComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ldif","version":"4.8.2","scheme":"ldif","extendsScheme":"","syntax":"ldif:ldapConnectionName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"ldapConnectionName":{"index":0,"kind":"path","displayName":"Ldap Connection Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the LdapConnection bean to pull from the registry. Note that this must be of scope prototype to avoid it being shared among threads or using a connection that has timed out."},"lazyStartProducer":{"index":1,"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."}}} , -{"component":{"kind":"component","name":"log","title":"Log Data","description":"Prints data form the routed message (such as body and headers) to the logger.","deprecated":false,"firstVersion":"1.1.0","label":"core,monitoring","javaType":"org.apache.camel.component.log.LogComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-log","version":"4.8.1","scheme":"log","extendsScheme":"","syntax":"log:loggerName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"loggerName":{"index":0,"kind":"path","displayName":"Logger Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the logging category to use"},"groupActiveOnly":{"index":1,"kind":"parameter","displayName":"Group Active Only","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","description":"If true, will hide stats when no new messages have been received for a time interval, if false, show stats regardless of message traffic."},"groupDelay":{"index":2,"kind":"parameter","displayName":"Group Delay","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Set the initial delay for stats (in millis)"},"groupInterval":{"index":3,"kind":"parameter","displayName":"Group Interval","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"If specified will group message stats by this time interval (in millis)"},"groupSize":{"index":4,"kind":"parameter","displayName":"Group Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"An integer that specifies a group size for throughput logging."},"level":{"index":5,"kind":"parameter","displayName":"Level","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"INFO","description":"Logging level to use. The default value is INFO."},"logMask":{"index":6,"kind":"parameter","displayName":"Log Mask","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"If true, mask sensitive information like password or passphrase in the log."},"marker":{"index":7,"kind":"parameter","displayName":"Marker","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An optional Marker name to use."},"plain":{"index":8,"kind":"parameter","displayName":"Plain","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled only the body will be printed out"},"sourceLocationLoggerName":{"index":9,"kind":"parameter","displayName":"Source Location Logger Name","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled then the source location of where the log endpoint is used in Camel routes, would be used as logger name, instead of the given name. However, if the source location is disabled or not possible to resolve then the existing logger name will be used."},"lazyStartProducer":{"index":10,"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."},"exchangeFormatter":{"index":11,"kind":"parameter","displayName":"Exchange Formatter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExchangeFormatter","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom exchange formatter"},"maxChars":{"index":12,"kind":"parameter","displayName":"Max Chars","group":"formatting","label":"formatting","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"description":"Limits the number of characters logged per line."},"multiline":{"index":13,"kind":"parameter","displayName":"Multiline","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled then each information is outputted on a newline."},"showAll":{"index":14,"kind":"parameter","displayName":"Show All","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Quick option for turning all options on. (multiline, maxChars has to be manually set if to be used)"},"showAllProperties":{"index":15,"kind":"parameter","displayName":"Show All Properties","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show all of the exchange properties (both internal and custom)."},"showBody":{"index":16,"kind":"parameter","displayName":"Show Body","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Show the message body."},"showBodyType":{"index":17,"kind":"parameter","displayName":"Show Body Type","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Show the body Java type."},"showCachedStreams":{"index":18,"kind":"parameter","displayName":"Show Cached Streams","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether Camel should show cached stream bodies or not (org.apache.camel.StreamCache)."},"showCaughtException":{"index":19,"kind":"parameter","displayName":"Show Caught Exception","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the exchange has a caught exception, show the exception message (no stack trace). A caught exception is stored as a property on the exchange (using the key org.apache.camel.Exchange#EXCEPTION_CAUGHT) and for instance a doCatch can catch exceptions."},"showException":{"index":20,"kind":"parameter","displayName":"Show Exception","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the exchange has an exception, show the exception message (no stacktrace)"},"showExchangeId":{"index":21,"kind":"parameter","displayName":"Show Exchange Id","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show the unique exchange ID."},"showExchangePattern":{"index":22,"kind":"parameter","displayName":"Show Exchange Pattern","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Shows the Message Exchange Pattern (or MEP for short)."},"showFiles":{"index":23,"kind":"parameter","displayName":"Show Files","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled Camel will output files"},"showFuture":{"index":24,"kind":"parameter","displayName":"Show Future","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled Camel will on Future objects wait for it to complete to obtain the payload to be logged."},"showHeaders":{"index":25,"kind":"parameter","displayName":"Show Headers","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show the message headers."},"showProperties":{"index":26,"kind":"parameter","displayName":"Show Properties","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show the exchange properties (only custom). Use showAllProperties to show both internal and custom properties."},"showRouteGroup":{"index":27,"kind":"parameter","displayName":"Show Route Group","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show route Group."},"showRouteId":{"index":28,"kind":"parameter","displayName":"Show Route Id","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show route ID."},"showStackTrace":{"index":29,"kind":"parameter","displayName":"Show Stack Trace","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show the stack trace, if an exchange has an exception. Only effective if one of showAll, showException or showCaughtException are enabled."},"showStreams":{"index":30,"kind":"parameter","displayName":"Show Streams","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether Camel should show stream bodies or not (eg such as java.io.InputStream). Beware if you enable this option then you may not be able later to access the message body as the stream have already been read by this logger. To remedy this you will have to use Stream Caching."},"showVariables":{"index":31,"kind":"parameter","displayName":"Show Variables","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show the variables."},"skipBodyLineSeparator":{"index":32,"kind":"parameter","displayName":"Skip Body Line Separator","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to skip line separators when logging the message body. This allows to log the message body in one line, setting this option to false will preserve any line separators from the body, which then will log the body as is."},"style":{"index":33,"kind":"parameter","displayName":"Style","group":"formatting","label":"formatting","required":false,"type":"object","javaType":"org.apache.camel.support.processor.DefaultExchangeFormatter.OutputStyle","enum":["Default","Tab","Fixed"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","description":"Sets the outputs style to use."}}} +{"component":{"kind":"component","name":"log","title":"Log Data","description":"Prints data form the routed message (such as body and headers) to the logger.","deprecated":false,"firstVersion":"1.1.0","label":"core,monitoring","javaType":"org.apache.camel.component.log.LogComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-log","version":"4.8.2","scheme":"log","extendsScheme":"","syntax":"log:loggerName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"loggerName":{"index":0,"kind":"path","displayName":"Logger Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the logging category to use"},"groupActiveOnly":{"index":1,"kind":"parameter","displayName":"Group Active Only","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","description":"If true, will hide stats when no new messages have been received for a time interval, if false, show stats regardless of message traffic."},"groupDelay":{"index":2,"kind":"parameter","displayName":"Group Delay","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Set the initial delay for stats (in millis)"},"groupInterval":{"index":3,"kind":"parameter","displayName":"Group Interval","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"If specified will group message stats by this time interval (in millis)"},"groupSize":{"index":4,"kind":"parameter","displayName":"Group Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"An integer that specifies a group size for throughput logging."},"level":{"index":5,"kind":"parameter","displayName":"Level","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"INFO","description":"Logging level to use. The default value is INFO."},"logMask":{"index":6,"kind":"parameter","displayName":"Log Mask","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"If true, mask sensitive information like password or passphrase in the log."},"marker":{"index":7,"kind":"parameter","displayName":"Marker","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An optional Marker name to use."},"plain":{"index":8,"kind":"parameter","displayName":"Plain","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled only the body will be printed out"},"sourceLocationLoggerName":{"index":9,"kind":"parameter","displayName":"Source Location Logger Name","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled then the source location of where the log endpoint is used in Camel routes, would be used as logger name, instead of the given name. However, if the source location is disabled or not possible to resolve then the existing logger name will be used."},"lazyStartProducer":{"index":10,"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."},"exchangeFormatter":{"index":11,"kind":"parameter","displayName":"Exchange Formatter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExchangeFormatter","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom exchange formatter"},"maxChars":{"index":12,"kind":"parameter","displayName":"Max Chars","group":"formatting","label":"formatting","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"description":"Limits the number of characters logged per line."},"multiline":{"index":13,"kind":"parameter","displayName":"Multiline","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled then each information is outputted on a newline."},"showAll":{"index":14,"kind":"parameter","displayName":"Show All","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Quick option for turning all options on. (multiline, maxChars has to be manually set if to be used)"},"showAllProperties":{"index":15,"kind":"parameter","displayName":"Show All Properties","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show all of the exchange properties (both internal and custom)."},"showBody":{"index":16,"kind":"parameter","displayName":"Show Body","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Show the message body."},"showBodyType":{"index":17,"kind":"parameter","displayName":"Show Body Type","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Show the body Java type."},"showCachedStreams":{"index":18,"kind":"parameter","displayName":"Show Cached Streams","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether Camel should show cached stream bodies or not (org.apache.camel.StreamCache)."},"showCaughtException":{"index":19,"kind":"parameter","displayName":"Show Caught Exception","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the exchange has a caught exception, show the exception message (no stack trace). A caught exception is stored as a property on the exchange (using the key org.apache.camel.Exchange#EXCEPTION_CAUGHT) and for instance a doCatch can catch exceptions."},"showException":{"index":20,"kind":"parameter","displayName":"Show Exception","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the exchange has an exception, show the exception message (no stacktrace)"},"showExchangeId":{"index":21,"kind":"parameter","displayName":"Show Exchange Id","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show the unique exchange ID."},"showExchangePattern":{"index":22,"kind":"parameter","displayName":"Show Exchange Pattern","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Shows the Message Exchange Pattern (or MEP for short)."},"showFiles":{"index":23,"kind":"parameter","displayName":"Show Files","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled Camel will output files"},"showFuture":{"index":24,"kind":"parameter","displayName":"Show Future","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled Camel will on Future objects wait for it to complete to obtain the payload to be logged."},"showHeaders":{"index":25,"kind":"parameter","displayName":"Show Headers","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show the message headers."},"showProperties":{"index":26,"kind":"parameter","displayName":"Show Properties","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show the exchange properties (only custom). Use showAllProperties to show both internal and custom properties."},"showRouteGroup":{"index":27,"kind":"parameter","displayName":"Show Route Group","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show route Group."},"showRouteId":{"index":28,"kind":"parameter","displayName":"Show Route Id","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show route ID."},"showStackTrace":{"index":29,"kind":"parameter","displayName":"Show Stack Trace","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show the stack trace, if an exchange has an exception. Only effective if one of showAll, showException or showCaughtException are enabled."},"showStreams":{"index":30,"kind":"parameter","displayName":"Show Streams","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether Camel should show stream bodies or not (eg such as java.io.InputStream). Beware if you enable this option then you may not be able later to access the message body as the stream have already been read by this logger. To remedy this you will have to use Stream Caching."},"showVariables":{"index":31,"kind":"parameter","displayName":"Show Variables","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Show the variables."},"skipBodyLineSeparator":{"index":32,"kind":"parameter","displayName":"Skip Body Line Separator","group":"formatting","label":"formatting","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to skip line separators when logging the message body. This allows to log the message body in one line, setting this option to false will preserve any line separators from the body, which then will log the body as is."},"style":{"index":33,"kind":"parameter","displayName":"Style","group":"formatting","label":"formatting","required":false,"type":"object","javaType":"org.apache.camel.support.processor.DefaultExchangeFormatter.OutputStyle","enum":["Default","Tab","Fixed"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","description":"Sets the outputs style to use."}}} , -{"component":{"kind":"component","name":"lpr","title":"Printer","description":"Send print jobs to printers.","deprecated":false,"firstVersion":"2.1.0","label":"document","javaType":"org.apache.camel.component.printer.PrinterComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-printer","version":"4.8.1","scheme":"lpr","extendsScheme":"","syntax":"lpr:hostname:port/printername","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"PrinterJobName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the job","constantName":"org.apache.camel.component.printer.PrinterEndpoint#JOB_NAME"}},"properties":{"hostname":{"index":0,"kind":"path","displayName":"Hostname","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Hostname of the printer"},"port":{"index":1,"kind":"path","displayName":"Port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Port number of the printer"},"printername":{"index":2,"kind":"path","displayName":"Printername","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Name of the printer"},"copies":{"index":3,"kind":"parameter","displayName":"Copies","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Number of copies to print"},"docFlavor":{"index":4,"kind":"parameter","displayName":"Doc Flavor","group":"producer","label":"","required":false,"type":"object","javaType":"javax.print.DocFlavor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets DocFlavor to use."},"flavor":{"index":5,"kind":"parameter","displayName":"Flavor","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets DocFlavor to use."},"mediaSize":{"index":6,"kind":"parameter","displayName":"Media Size","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"na-letter","configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets the stationary as defined by enumeration names in the javax.print.attribute.standard.MediaSizeName API. The default setting is to use North American Letter sized stationary. The value's case is ignored, e.g. values of iso_a4 and ISO_A4 may be used."},"mediaTray":{"index":7,"kind":"parameter","displayName":"Media Tray","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets MediaTray supported by the javax.print.DocFlavor API, for example upper,middle etc."},"mimeType":{"index":8,"kind":"parameter","displayName":"Mime Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets mimeTypes supported by the javax.print.DocFlavor API"},"orientation":{"index":9,"kind":"parameter","displayName":"Orientation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["portrait","landscape","reverse-portrait","reverse-landscape"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"portrait","configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets the page orientation."},"printerPrefix":{"index":10,"kind":"parameter","displayName":"Printer Prefix","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets the prefix name of the printer, it is useful when the printer name does not start with //hostname/printer"},"sendToPrinter":{"index":11,"kind":"parameter","displayName":"Send To Printer","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"etting this option to false prevents sending of the print data to the printer"},"sides":{"index":12,"kind":"parameter","displayName":"Sides","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["one-sided","duplex","tumble","two-sided-short-edge","two-sided-long-edge"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"one-sided","configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets one sided or two sided printing based on the javax.print.attribute.standard.Sides API"},"lazyStartProducer":{"index":13,"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."}}} +{"component":{"kind":"component","name":"lpr","title":"Printer","description":"Send print jobs to printers.","deprecated":false,"firstVersion":"2.1.0","label":"document","javaType":"org.apache.camel.component.printer.PrinterComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-printer","version":"4.8.2","scheme":"lpr","extendsScheme":"","syntax":"lpr:hostname:port/printername","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"PrinterJobName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the job","constantName":"org.apache.camel.component.printer.PrinterEndpoint#JOB_NAME"}},"properties":{"hostname":{"index":0,"kind":"path","displayName":"Hostname","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Hostname of the printer"},"port":{"index":1,"kind":"path","displayName":"Port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Port number of the printer"},"printername":{"index":2,"kind":"path","displayName":"Printername","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Name of the printer"},"copies":{"index":3,"kind":"parameter","displayName":"Copies","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Number of copies to print"},"docFlavor":{"index":4,"kind":"parameter","displayName":"Doc Flavor","group":"producer","label":"","required":false,"type":"object","javaType":"javax.print.DocFlavor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets DocFlavor to use."},"flavor":{"index":5,"kind":"parameter","displayName":"Flavor","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets DocFlavor to use."},"mediaSize":{"index":6,"kind":"parameter","displayName":"Media Size","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"na-letter","configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets the stationary as defined by enumeration names in the javax.print.attribute.standard.MediaSizeName API. The default setting is to use North American Letter sized stationary. The value's case is ignored, e.g. values of iso_a4 and ISO_A4 may be used."},"mediaTray":{"index":7,"kind":"parameter","displayName":"Media Tray","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets MediaTray supported by the javax.print.DocFlavor API, for example upper,middle etc."},"mimeType":{"index":8,"kind":"parameter","displayName":"Mime Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets mimeTypes supported by the javax.print.DocFlavor API"},"orientation":{"index":9,"kind":"parameter","displayName":"Orientation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["portrait","landscape","reverse-portrait","reverse-landscape"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"portrait","configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets the page orientation."},"printerPrefix":{"index":10,"kind":"parameter","displayName":"Printer Prefix","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets the prefix name of the printer, it is useful when the printer name does not start with //hostname/printer"},"sendToPrinter":{"index":11,"kind":"parameter","displayName":"Send To Printer","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"etting this option to false prevents sending of the print data to the printer"},"sides":{"index":12,"kind":"parameter","displayName":"Sides","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["one-sided","duplex","tumble","two-sided-short-edge","two-sided-long-edge"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"one-sided","configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets one sided or two sided printing based on the javax.print.attribute.standard.Sides API"},"lazyStartProducer":{"index":13,"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."}}} , -{"component":{"kind":"component","name":"lucene","title":"Lucene","description":"Perform inserts or queries against Apache Lucene databases.","deprecated":false,"firstVersion":"2.2.0","label":"database,search","javaType":"org.apache.camel.component.lucene.LuceneComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-lucene","version":"4.8.1","scheme":"lucene","extendsScheme":"","syntax":"lucene:host:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"QUERY":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Lucene Query to performed on the index. The query may include wildcards and phrases.","constantName":"org.apache.camel.component.lucene.LuceneConstants#HEADER_QUERY"},"RETURN_LUCENE_DOCS":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this header to true to include the actual Lucene documentation when returning hit information.","constantName":"org.apache.camel.component.lucene.LuceneConstants#HEADER_RETURN_LUCENE_DOCS"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.lucene.LuceneConfiguration","configurationField":"config","description":"The URL to the lucene server"},"operation":{"index":1,"kind":"path","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.lucene.LuceneOperation","enum":["insert","query"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.lucene.LuceneConfiguration","configurationField":"config","description":"Operation to do such as insert or query."},"analyzer":{"index":2,"kind":"parameter","displayName":"Analyzer","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.lucene.analysis.Analyzer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.lucene.LuceneConfiguration","configurationField":"config","description":"An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box"},"indexDir":{"index":3,"kind":"parameter","displayName":"Index Dir","group":"producer","label":"","required":false,"type":"string","javaType":"java.io.File","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.lucene.LuceneConfiguration","configurationField":"config","description":"A file system directory in which index files are created upon analysis of the document by the specified analyzer"},"maxHits":{"index":4,"kind":"parameter","displayName":"Max Hits","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.lucene.LuceneConfiguration","configurationField":"config","description":"An integer value that limits the result set of the search operation"},"srcDir":{"index":5,"kind":"parameter","displayName":"Src Dir","group":"producer","label":"","required":false,"type":"string","javaType":"java.io.File","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.lucene.LuceneConfiguration","configurationField":"config","description":"An optional directory containing files to be used to be analyzed and added to the index at producer startup."},"lazyStartProducer":{"index":6,"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."}}} +{"component":{"kind":"component","name":"lucene","title":"Lucene","description":"Perform inserts or queries against Apache Lucene databases.","deprecated":false,"firstVersion":"2.2.0","label":"database,search","javaType":"org.apache.camel.component.lucene.LuceneComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-lucene","version":"4.8.2","scheme":"lucene","extendsScheme":"","syntax":"lucene:host:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"QUERY":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Lucene Query to performed on the index. The query may include wildcards and phrases.","constantName":"org.apache.camel.component.lucene.LuceneConstants#HEADER_QUERY"},"RETURN_LUCENE_DOCS":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this header to true to include the actual Lucene documentation when returning hit information.","constantName":"org.apache.camel.component.lucene.LuceneConstants#HEADER_RETURN_LUCENE_DOCS"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.lucene.LuceneConfiguration","configurationField":"config","description":"The URL to the lucene server"},"operation":{"index":1,"kind":"path","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.lucene.LuceneOperation","enum":["insert","query"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.lucene.LuceneConfiguration","configurationField":"config","description":"Operation to do such as insert or query."},"analyzer":{"index":2,"kind":"parameter","displayName":"Analyzer","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.lucene.analysis.Analyzer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.lucene.LuceneConfiguration","configurationField":"config","description":"An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box"},"indexDir":{"index":3,"kind":"parameter","displayName":"Index Dir","group":"producer","label":"","required":false,"type":"string","javaType":"java.io.File","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.lucene.LuceneConfiguration","configurationField":"config","description":"A file system directory in which index files are created upon analysis of the document by the specified analyzer"},"maxHits":{"index":4,"kind":"parameter","displayName":"Max Hits","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.lucene.LuceneConfiguration","configurationField":"config","description":"An integer value that limits the result set of the search operation"},"srcDir":{"index":5,"kind":"parameter","displayName":"Src Dir","group":"producer","label":"","required":false,"type":"string","javaType":"java.io.File","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.lucene.LuceneConfiguration","configurationField":"config","description":"An optional directory containing files to be used to be analyzed and added to the index at producer startup."},"lazyStartProducer":{"index":6,"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."}}} , -{"component":{"kind":"component","name":"lumberjack","title":"Lumberjack","description":"Receive logs messages using the Lumberjack protocol.","deprecated":false,"firstVersion":"2.18.0","label":"monitoring","javaType":"org.apache.camel.component.lumberjack.LumberjackComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-lumberjack","version":"4.8.1","scheme":"lumberjack","extendsScheme":"","syntax":"lumberjack:host:port","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Network interface on which to listen for Lumberjack"},"port":{"index":1,"kind":"path","displayName":"Port","group":"consumer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5044,"description":"Network port on which to listen for Lumberjack"},"sslContextParameters":{"index":2,"kind":"parameter","displayName":"Ssl Context Parameters","group":"consumer","label":"","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"SSL configuration"},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} +{"component":{"kind":"component","name":"lumberjack","title":"Lumberjack","description":"Receive logs messages using the Lumberjack protocol.","deprecated":false,"firstVersion":"2.18.0","label":"monitoring","javaType":"org.apache.camel.component.lumberjack.LumberjackComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-lumberjack","version":"4.8.2","scheme":"lumberjack","extendsScheme":"","syntax":"lumberjack:host:port","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Network interface on which to listen for Lumberjack"},"port":{"index":1,"kind":"path","displayName":"Port","group":"consumer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5044,"description":"Network port on which to listen for Lumberjack"},"sslContextParameters":{"index":2,"kind":"parameter","displayName":"Ssl Context Parameters","group":"consumer","label":"","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"SSL configuration"},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} , -{"component":{"kind":"component","name":"mapstruct","title":"MapStruct","description":"Type Conversion using Mapstruct","deprecated":false,"firstVersion":"3.19.0","label":"transformation","javaType":"org.apache.camel.component.mapstruct.MapstructComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mapstruct","version":"4.8.1","scheme":"mapstruct","extendsScheme":"","syntax":"mapstruct:className","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"className":{"index":0,"kind":"path","displayName":"Class Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The fully qualified class name of the POJO that mapstruct should convert to (target)"},"mandatory":{"index":1,"kind":"parameter","displayName":"Mandatory","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether there must exist a mapstruct converter to convert to the POJO."},"lazyStartProducer":{"index":2,"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."}}} +{"component":{"kind":"component","name":"mapstruct","title":"MapStruct","description":"Type Conversion using Mapstruct","deprecated":false,"firstVersion":"3.19.0","label":"transformation","javaType":"org.apache.camel.component.mapstruct.MapstructComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mapstruct","version":"4.8.2","scheme":"mapstruct","extendsScheme":"","syntax":"mapstruct:className","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"className":{"index":0,"kind":"path","displayName":"Class Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The fully qualified class name of the POJO that mapstruct should convert to (target)"},"mandatory":{"index":1,"kind":"parameter","displayName":"Mandatory","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether there must exist a mapstruct converter to convert to the POJO."},"lazyStartProducer":{"index":2,"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."}}} , -{"component":{"kind":"component","name":"master","title":"Master","description":"Have only a single consumer in a cluster consuming from a given endpoint; with automatic failover if the JVM dies.","deprecated":false,"firstVersion":"2.20.0","label":"clustering","javaType":"org.apache.camel.component.master.MasterComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-master","version":"4.8.1","scheme":"master","extendsScheme":"","syntax":"master:namespace:delegateUri","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":true},"properties":{"namespace":{"index":0,"kind":"path","displayName":"Namespace","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cluster namespace to use"},"delegateUri":{"index":1,"kind":"path","displayName":"Delegate Uri","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The endpoint uri to use in master/slave mode"},"bridgeErrorHandler":{"index":2,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":3,"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":{"index":4,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} +{"component":{"kind":"component","name":"master","title":"Master","description":"Have only a single consumer in a cluster consuming from a given endpoint; with automatic failover if the JVM dies.","deprecated":false,"firstVersion":"2.20.0","label":"clustering","javaType":"org.apache.camel.component.master.MasterComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-master","version":"4.8.2","scheme":"master","extendsScheme":"","syntax":"master:namespace:delegateUri","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":true},"properties":{"namespace":{"index":0,"kind":"path","displayName":"Namespace","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cluster namespace to use"},"delegateUri":{"index":1,"kind":"path","displayName":"Delegate Uri","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The endpoint uri to use in master/slave mode"},"bridgeErrorHandler":{"index":2,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":3,"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":{"index":4,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} , -{"component":{"kind":"component","name":"metrics","title":"Metrics","description":"Collect various metrics directly from Camel routes using the DropWizard metrics library.","deprecated":false,"firstVersion":"2.14.0","label":"monitoring","javaType":"org.apache.camel.component.metrics.MetricsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-metrics","version":"4.8.1","scheme":"metrics","extendsScheme":"","syntax":"metrics:metricsType:metricsName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelMetricsTimerAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.metrics.MetricsTimerAction","enum":["start","stop"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override timer action in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_TIMER_ACTION"},"CamelMetricsMeterMark":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override mark value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_METER_MARK"},"CamelMetricsHistogramValue":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override histogram value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_HISTOGRAM_VALUE"},"CamelMetricsCounterDecrement":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override decrement value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_COUNTER_DECREMENT"},"CamelMetricsCounterIncrement":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override increment value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_COUNTER_INCREMENT"},"CamelMetricsGaugeSubject":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override subject value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_GAUGE_SUBJECT"},"CamelMetricsName":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override name value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_METRIC_NAME"}},"properties":{"metricsType":{"index":0,"kind":"path","displayName":"Metrics Type","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.metrics.MetricsType","enum":["gauge","counter","histogram","meter","timer"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Type of metrics"},"metricsName":{"index":1,"kind":"path","displayName":"Metrics Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of metrics"},"action":{"index":2,"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.metrics.MetricsTimerAction","enum":["start","stop"],"deprecated":false,"autowired":false,"secret":false,"description":"Action when using timer type"},"decrement":{"index":3,"kind":"parameter","displayName":"Decrement","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Decrement value when using counter type"},"increment":{"index":4,"kind":"parameter","displayName":"Increment","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Increment value when using counter type"},"mark":{"index":5,"kind":"parameter","displayName":"Mark","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Mark when using meter type"},"subject":{"index":6,"kind":"parameter","displayName":"Subject","group":"producer","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Subject value when using gauge type"},"value":{"index":7,"kind":"parameter","displayName":"Value","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Value value when using histogram type"},"lazyStartProducer":{"index":8,"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."}}} +{"component":{"kind":"component","name":"metrics","title":"Metrics","description":"Collect various metrics directly from Camel routes using the DropWizard metrics library.","deprecated":false,"firstVersion":"2.14.0","label":"monitoring","javaType":"org.apache.camel.component.metrics.MetricsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-metrics","version":"4.8.2","scheme":"metrics","extendsScheme":"","syntax":"metrics:metricsType:metricsName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelMetricsTimerAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.metrics.MetricsTimerAction","enum":["start","stop"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override timer action in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_TIMER_ACTION"},"CamelMetricsMeterMark":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override mark value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_METER_MARK"},"CamelMetricsHistogramValue":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override histogram value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_HISTOGRAM_VALUE"},"CamelMetricsCounterDecrement":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override decrement value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_COUNTER_DECREMENT"},"CamelMetricsCounterIncrement":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override increment value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_COUNTER_INCREMENT"},"CamelMetricsGaugeSubject":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override subject value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_GAUGE_SUBJECT"},"CamelMetricsName":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override name value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_METRIC_NAME"}},"properties":{"metricsType":{"index":0,"kind":"path","displayName":"Metrics Type","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.metrics.MetricsType","enum":["gauge","counter","histogram","meter","timer"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Type of metrics"},"metricsName":{"index":1,"kind":"path","displayName":"Metrics Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of metrics"},"action":{"index":2,"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.metrics.MetricsTimerAction","enum":["start","stop"],"deprecated":false,"autowired":false,"secret":false,"description":"Action when using timer type"},"decrement":{"index":3,"kind":"parameter","displayName":"Decrement","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Decrement value when using counter type"},"increment":{"index":4,"kind":"parameter","displayName":"Increment","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Increment value when using counter type"},"mark":{"index":5,"kind":"parameter","displayName":"Mark","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Mark when using meter type"},"subject":{"index":6,"kind":"parameter","displayName":"Subject","group":"producer","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Subject value when using gauge type"},"value":{"index":7,"kind":"parameter","displayName":"Value","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Value value when using histogram type"},"lazyStartProducer":{"index":8,"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."}}} , -{"component":{"kind":"component","name":"micrometer","title":"Micrometer","description":"Collect various metrics directly from Camel routes using the Micrometer library.","deprecated":false,"firstVersion":"2.22.0","label":"monitoring","javaType":"org.apache.camel.component.micrometer.MicrometerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-micrometer","version":"4.8.1","scheme":"micrometer","extendsScheme":"","syntax":"micrometer:metricsType:metricsName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelMetricsTimerAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.micrometer.MicrometerTimerAction","enum":["start","stop"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override timer action in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_TIMER_ACTION"},"CamelMetricsHistogramValue":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override histogram value in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_HISTOGRAM_VALUE"},"CamelMetricsCounterDecrement":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override decrement value in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_COUNTER_DECREMENT"},"CamelMetricsCounterIncrement":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override increment value in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_COUNTER_INCREMENT"},"CamelMetricsName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override name value in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_METRIC_NAME"},"CamelMetricsDescription":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override description value in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_METRIC_DESCRIPTION"},"CamelMetricsTags":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Iterable","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To augment meter tags defined as URI parameters","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_METRIC_TAGS"}},"properties":{"metricsType":{"index":0,"kind":"path","displayName":"Metrics Type","group":"producer","label":"","required":true,"type":"object","javaType":"io.micrometer.core.instrument.Meter.Type","enum":["counter","summary","timer"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Type of metrics"},"metricsName":{"index":1,"kind":"path","displayName":"Metrics Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of metrics"},"tags":{"index":2,"kind":"path","displayName":"Tags","group":"producer","label":"","required":false,"type":"object","javaType":"java.lang.Iterable","deprecated":false,"autowired":false,"secret":false,"description":"Tags of metrics"},"action":{"index":3,"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["start","stop"],"deprecated":false,"autowired":false,"secret":false,"description":"Action expression when using timer type"},"decrement":{"index":4,"kind":"parameter","displayName":"Decrement","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Decrement value expression when using counter type"},"increment":{"index":5,"kind":"parameter","displayName":"Increment","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Increment value expression when using counter type"},"metricsDescription":{"index":6,"kind":"parameter","displayName":"Metrics Description","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Description of metrics"},"value":{"index":7,"kind":"parameter","displayName":"Value","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Value expression when using histogram type"},"lazyStartProducer":{"index":8,"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."}}} +{"component":{"kind":"component","name":"micrometer","title":"Micrometer","description":"Collect various metrics directly from Camel routes using the Micrometer library.","deprecated":false,"firstVersion":"2.22.0","label":"monitoring","javaType":"org.apache.camel.component.micrometer.MicrometerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-micrometer","version":"4.8.2","scheme":"micrometer","extendsScheme":"","syntax":"micrometer:metricsType:metricsName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelMetricsTimerAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.micrometer.MicrometerTimerAction","enum":["start","stop"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override timer action in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_TIMER_ACTION"},"CamelMetricsHistogramValue":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override histogram value in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_HISTOGRAM_VALUE"},"CamelMetricsCounterDecrement":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override decrement value in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_COUNTER_DECREMENT"},"CamelMetricsCounterIncrement":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override increment value in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_COUNTER_INCREMENT"},"CamelMetricsName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override name value in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_METRIC_NAME"},"CamelMetricsDescription":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override description value in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_METRIC_DESCRIPTION"},"CamelMetricsTags":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Iterable","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To augment meter tags defined as URI parameters","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_METRIC_TAGS"}},"properties":{"metricsType":{"index":0,"kind":"path","displayName":"Metrics Type","group":"producer","label":"","required":true,"type":"object","javaType":"io.micrometer.core.instrument.Meter.Type","enum":["counter","summary","timer"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Type of metrics"},"metricsName":{"index":1,"kind":"path","displayName":"Metrics Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of metrics"},"tags":{"index":2,"kind":"path","displayName":"Tags","group":"producer","label":"","required":false,"type":"object","javaType":"java.lang.Iterable","deprecated":false,"autowired":false,"secret":false,"description":"Tags of metrics"},"action":{"index":3,"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["start","stop"],"deprecated":false,"autowired":false,"secret":false,"description":"Action expression when using timer type"},"decrement":{"index":4,"kind":"parameter","displayName":"Decrement","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Decrement value expression when using counter type"},"increment":{"index":5,"kind":"parameter","displayName":"Increment","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Increment value expression when using counter type"},"metricsDescription":{"index":6,"kind":"parameter","displayName":"Metrics Description","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Description of metrics"},"value":{"index":7,"kind":"parameter","displayName":"Value","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Value expression when using histogram type"},"lazyStartProducer":{"index":8,"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."}}} , -{"component":{"kind":"component","name":"milvus","title":"Milvus","description":"Perform operations on the Milvus Vector Database.","deprecated":false,"firstVersion":"4.5.0","label":"database,ai","javaType":"org.apache.camel.component.milvus.MilvusComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-milvus","version":"4.8.1","scheme":"milvus","extendsScheme":"","syntax":"milvus:collection","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelMilvusAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","enum":["CREATE_COLLECTION","CREATE_INDEX","UPSERT","INSERT","SEARCH","QUERY","DELETE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to be performed.","constantName":"org.apache.camel.component.milvus.Milvus$Headers#ACTION"},"CamelMilvusOperationStatus":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation Status.","constantName":"org.apache.camel.component.milvus.Milvus$Headers#OPERATION_STATUS"},"CamelMilvusOperationStatusValue":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation Status Value.","constantName":"org.apache.camel.component.milvus.Milvus$Headers#OPERATION_STATUS_VALUE"},"CamelMilvusTextFieldName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Text Field Name for Insert/Upsert operation","constantName":"org.apache.camel.component.milvus.Milvus$Headers#TEXT_FIELD_NAME"},"CamelMilvusVectorFieldName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Vector Field Name for Insert/Upsert operation","constantName":"org.apache.camel.component.milvus.Milvus$Headers#VECTOR_FIELD_NAME"},"CamelMilvusCollectionName":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Collection Name for Insert/Upsert operation","constantName":"org.apache.camel.component.milvus.Milvus$Headers#COLLECTION_NAME"},"CamelMilvusKeyName":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Key Name for Insert/Upsert operation","constantName":"org.apache.camel.component.milvus.Milvus$Headers#KEY_NAME"},"CamelMilvusKeyValue":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Key Value for Insert/Upsert operation","constantName":"org.apache.camel.component.milvus.Milvus$Headers#KEY_VALUE"}},"properties":{"collection":{"index":0,"kind":"path","displayName":"Collection","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection Name"},"host":{"index":1,"kind":"parameter","displayName":"Host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.milvus.MilvusConfiguration","configurationField":"configuration","description":"The host to connect to."},"port":{"index":2,"kind":"parameter","displayName":"Port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":19530,"configurationClass":"org.apache.camel.component.milvus.MilvusConfiguration","configurationField":"configuration","description":"The port to connect to."},"timeout":{"index":3,"kind":"parameter","displayName":"Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milvus.MilvusConfiguration","configurationField":"configuration","description":"Sets a default timeout for all requests"},"token":{"index":4,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.milvus.MilvusConfiguration","configurationField":"configuration","description":"Sets the API key to use for authentication"},"lazyStartProducer":{"index":5,"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."}}} +{"component":{"kind":"component","name":"milvus","title":"Milvus","description":"Perform operations on the Milvus Vector Database.","deprecated":false,"firstVersion":"4.5.0","label":"database,ai","javaType":"org.apache.camel.component.milvus.MilvusComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-milvus","version":"4.8.2","scheme":"milvus","extendsScheme":"","syntax":"milvus:collection","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelMilvusAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","enum":["CREATE_COLLECTION","CREATE_INDEX","UPSERT","INSERT","SEARCH","QUERY","DELETE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to be performed.","constantName":"org.apache.camel.component.milvus.Milvus$Headers#ACTION"},"CamelMilvusOperationStatus":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation Status.","constantName":"org.apache.camel.component.milvus.Milvus$Headers#OPERATION_STATUS"},"CamelMilvusOperationStatusValue":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation Status Value.","constantName":"org.apache.camel.component.milvus.Milvus$Headers#OPERATION_STATUS_VALUE"},"CamelMilvusTextFieldName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Text Field Name for Insert/Upsert operation","constantName":"org.apache.camel.component.milvus.Milvus$Headers#TEXT_FIELD_NAME"},"CamelMilvusVectorFieldName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Vector Field Name for Insert/Upsert operation","constantName":"org.apache.camel.component.milvus.Milvus$Headers#VECTOR_FIELD_NAME"},"CamelMilvusCollectionName":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Collection Name for Insert/Upsert operation","constantName":"org.apache.camel.component.milvus.Milvus$Headers#COLLECTION_NAME"},"CamelMilvusKeyName":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Key Name for Insert/Upsert operation","constantName":"org.apache.camel.component.milvus.Milvus$Headers#KEY_NAME"},"CamelMilvusKeyValue":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Key Value for Insert/Upsert operation","constantName":"org.apache.camel.component.milvus.Milvus$Headers#KEY_VALUE"}},"properties":{"collection":{"index":0,"kind":"path","displayName":"Collection","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection Name"},"host":{"index":1,"kind":"parameter","displayName":"Host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.milvus.MilvusConfiguration","configurationField":"configuration","description":"The host to connect to."},"port":{"index":2,"kind":"parameter","displayName":"Port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":19530,"configurationClass":"org.apache.camel.component.milvus.MilvusConfiguration","configurationField":"configuration","description":"The port to connect to."},"timeout":{"index":3,"kind":"parameter","displayName":"Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milvus.MilvusConfiguration","configurationField":"configuration","description":"Sets a default timeout for all requests"},"token":{"index":4,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.milvus.MilvusConfiguration","configurationField":"configuration","description":"Sets the API key to use for authentication"},"lazyStartProducer":{"index":5,"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."}}} , -{"component":{"kind":"component","name":"mina","title":"Mina","description":"Socket level networking using TCP or UDP with Apache Mina 2.x.","deprecated":false,"firstVersion":"2.10.0","label":"networking","javaType":"org.apache.camel.component.mina.MinaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mina","version":"4.8.1","scheme":"mina","extendsScheme":"","syntax":"mina:protocol:host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelMinaCloseSessionWhenComplete":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates whether the session should be closed after complete","constantName":"org.apache.camel.component.mina.MinaConstants#MINA_CLOSE_SESSION_WHEN_COMPLETE"},"CamelMinaIoSession":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.mina.core.session.IoSession","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the IoSession which is stored in the message header","constantName":"org.apache.camel.component.mina.MinaConstants#MINA_IOSESSION"},"CamelMinaLocalAddress":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The socket address of local machine that received the message.","constantName":"org.apache.camel.component.mina.MinaConstants#MINA_LOCAL_ADDRESS"},"CamelMinaRemoteAddress":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The socket address of the remote machine that send the message.","constantName":"org.apache.camel.component.mina.MinaConstants#MINA_REMOTE_ADDRESS"}},"properties":{"protocol":{"index":0,"kind":"path","displayName":"Protocol","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Protocol to use"},"host":{"index":1,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server."},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Port number"},"disconnect":{"index":3,"kind":"parameter","displayName":"Disconnect","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Whether to disconnect(close) from Mina session right after use. Can be used for both consumer and producer."},"minaLogger":{"index":4,"kind":"parameter","displayName":"Mina Logger","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output."},"sync":{"index":5,"kind":"parameter","displayName":"Sync","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Setting to set endpoint as one-way or request-response."},"timeout":{"index":6,"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"You can configure the timeout that specifies how long to wait for a response from a remote server. The timeout unit is in milliseconds, so 60000 is 60 seconds."},"writeTimeout":{"index":7,"kind":"parameter","displayName":"Write Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Maximum amount of time it should take to send data to the MINA session. Default is 10000 milliseconds."},"clientMode":{"index":8,"kind":"parameter","displayName":"Client Mode","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"If the clientMode is true, mina consumer will connect the address as a TCP client."},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"noReplyLogLevel":{"index":12,"kind":"parameter","displayName":"No Reply Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back."},"cachedAddress":{"index":13,"kind":"parameter","displayName":"Cached Address","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Whether to create the InetAddress once and reuse. Setting this to false allows to pickup DNS changes in the network."},"lazySessionCreation":{"index":14,"kind":"parameter","displayName":"Lazy Session Creation","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Sessions can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started."},"lazyStartProducer":{"index":15,"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."},"disconnectOnNoReply":{"index":16,"kind":"parameter","displayName":"Disconnect On No Reply","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back."},"maximumPoolSize":{"index":17,"kind":"parameter","displayName":"Maximum Pool Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":16,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Number of worker threads in the worker pool for TCP and UDP"},"orderedThreadPoolExecutor":{"index":18,"kind":"parameter","displayName":"Ordered Thread Pool Executor","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Whether to use ordered thread pool, to ensure events are processed orderly on the same channel."},"transferExchange":{"index":19,"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."},"allowDefaultCodec":{"index":20,"kind":"parameter","displayName":"Allow Default Codec","group":"codec","label":"codec","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"The mina component installs a default codec if both, codec is null and textline is false. Setting allowDefaultCodec to false prevents the mina component from installing a default codec as the first element in the filter chain. This is useful in scenarios where another filter must be the first in the filter chain, like the SSL filter."},"codec":{"index":21,"kind":"parameter","displayName":"Codec","group":"codec","label":"codec","required":false,"type":"object","javaType":"org.apache.mina.filter.codec.ProtocolCodecFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"To use a custom minda codec implementation."},"decoderMaxLineLength":{"index":22,"kind":"parameter","displayName":"Decoder Max Line Length","group":"codec","label":"codec","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024."},"encoderMaxLineLength":{"index":23,"kind":"parameter","displayName":"Encoder Max Line Length","group":"codec","label":"codec","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"To set the textline protocol encoder max line length. By default the default value of Mina itself is used which are Integer.MAX_VALUE."},"encoding":{"index":24,"kind":"parameter","displayName":"Encoding","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"You can configure the encoding (a charset name) to use for the TCP textline codec and the UDP protocol. If not provided, Camel will use the JVM default Charset"},"filters":{"index":25,"kind":"parameter","displayName":"Filters","group":"codec","label":"codec","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"You can set a list of Mina IoFilters to use."},"textline":{"index":26,"kind":"parameter","displayName":"Textline","group":"codec","label":"codec","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP."},"textlineDelimiter":{"index":27,"kind":"parameter","displayName":"Textline Delimiter","group":"codec","label":"codec","required":false,"type":"object","javaType":"org.apache.camel.component.mina.MinaTextLineDelimiter","enum":["DEFAULT","AUTO","UNIX","WINDOWS","MAC"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Only used for TCP and if textline=true. Sets the text line delimiter to use. If none provided, Camel will use DEFAULT. This delimiter is used to mark the end of text."},"sslContextParameters":{"index":28,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"To configure SSL security."}}} +{"component":{"kind":"component","name":"mina","title":"Mina","description":"Socket level networking using TCP or UDP with Apache Mina 2.x.","deprecated":false,"firstVersion":"2.10.0","label":"networking","javaType":"org.apache.camel.component.mina.MinaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mina","version":"4.8.2","scheme":"mina","extendsScheme":"","syntax":"mina:protocol:host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelMinaCloseSessionWhenComplete":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates whether the session should be closed after complete","constantName":"org.apache.camel.component.mina.MinaConstants#MINA_CLOSE_SESSION_WHEN_COMPLETE"},"CamelMinaIoSession":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.mina.core.session.IoSession","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the IoSession which is stored in the message header","constantName":"org.apache.camel.component.mina.MinaConstants#MINA_IOSESSION"},"CamelMinaLocalAddress":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The socket address of local machine that received the message.","constantName":"org.apache.camel.component.mina.MinaConstants#MINA_LOCAL_ADDRESS"},"CamelMinaRemoteAddress":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The socket address of the remote machine that send the message.","constantName":"org.apache.camel.component.mina.MinaConstants#MINA_REMOTE_ADDRESS"}},"properties":{"protocol":{"index":0,"kind":"path","displayName":"Protocol","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Protocol to use"},"host":{"index":1,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server."},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Port number"},"disconnect":{"index":3,"kind":"parameter","displayName":"Disconnect","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Whether to disconnect(close) from Mina session right after use. Can be used for both consumer and producer."},"minaLogger":{"index":4,"kind":"parameter","displayName":"Mina Logger","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output."},"sync":{"index":5,"kind":"parameter","displayName":"Sync","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Setting to set endpoint as one-way or request-response."},"timeout":{"index":6,"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"You can configure the timeout that specifies how long to wait for a response from a remote server. The timeout unit is in milliseconds, so 60000 is 60 seconds."},"writeTimeout":{"index":7,"kind":"parameter","displayName":"Write Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Maximum amount of time it should take to send data to the MINA session. Default is 10000 milliseconds."},"clientMode":{"index":8,"kind":"parameter","displayName":"Client Mode","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"If the clientMode is true, mina consumer will connect the address as a TCP client."},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"noReplyLogLevel":{"index":12,"kind":"parameter","displayName":"No Reply Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back."},"cachedAddress":{"index":13,"kind":"parameter","displayName":"Cached Address","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Whether to create the InetAddress once and reuse. Setting this to false allows to pickup DNS changes in the network."},"lazySessionCreation":{"index":14,"kind":"parameter","displayName":"Lazy Session Creation","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Sessions can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started."},"lazyStartProducer":{"index":15,"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."},"disconnectOnNoReply":{"index":16,"kind":"parameter","displayName":"Disconnect On No Reply","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back."},"maximumPoolSize":{"index":17,"kind":"parameter","displayName":"Maximum Pool Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":16,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Number of worker threads in the worker pool for TCP and UDP"},"orderedThreadPoolExecutor":{"index":18,"kind":"parameter","displayName":"Ordered Thread Pool Executor","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Whether to use ordered thread pool, to ensure events are processed orderly on the same channel."},"transferExchange":{"index":19,"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."},"allowDefaultCodec":{"index":20,"kind":"parameter","displayName":"Allow Default Codec","group":"codec","label":"codec","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"The mina component installs a default codec if both, codec is null and textline is false. Setting allowDefaultCodec to false prevents the mina component from installing a default codec as the first element in the filter chain. This is useful in scenarios where another filter must be the first in the filter chain, like the SSL filter."},"codec":{"index":21,"kind":"parameter","displayName":"Codec","group":"codec","label":"codec","required":false,"type":"object","javaType":"org.apache.mina.filter.codec.ProtocolCodecFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"To use a custom minda codec implementation."},"decoderMaxLineLength":{"index":22,"kind":"parameter","displayName":"Decoder Max Line Length","group":"codec","label":"codec","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024."},"encoderMaxLineLength":{"index":23,"kind":"parameter","displayName":"Encoder Max Line Length","group":"codec","label":"codec","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"To set the textline protocol encoder max line length. By default the default value of Mina itself is used which are Integer.MAX_VALUE."},"encoding":{"index":24,"kind":"parameter","displayName":"Encoding","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"You can configure the encoding (a charset name) to use for the TCP textline codec and the UDP protocol. If not provided, Camel will use the JVM default Charset"},"filters":{"index":25,"kind":"parameter","displayName":"Filters","group":"codec","label":"codec","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"You can set a list of Mina IoFilters to use."},"textline":{"index":26,"kind":"parameter","displayName":"Textline","group":"codec","label":"codec","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP."},"textlineDelimiter":{"index":27,"kind":"parameter","displayName":"Textline Delimiter","group":"codec","label":"codec","required":false,"type":"object","javaType":"org.apache.camel.component.mina.MinaTextLineDelimiter","enum":["DEFAULT","AUTO","UNIX","WINDOWS","MAC"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Only used for TCP and if textline=true. Sets the text line delimiter to use. If none provided, Camel will use DEFAULT. This delimiter is used to mark the end of text."},"sslContextParameters":{"index":28,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"To configure SSL security."}}} , -{"component":{"kind":"component","name":"minio","title":"Minio","description":"Store and retrieve objects from Minio Storage Service using Minio SDK.","deprecated":false,"firstVersion":"3.5.0","label":"cloud,file","javaType":"org.apache.camel.component.minio.MinioComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-minio","version":"4.8.1","scheme":"minio","extendsScheme":"","syntax":"minio:bucketName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelMinioBucketName":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The bucket Name which this object will be stored or which will be used for the current operation. Consumer: The name of the bucket in which this object is contained.","constantName":"org.apache.camel.component.minio.MinioConstants#BUCKET_NAME"},"CamelMinioDestinationBucketName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bucket Destination Name which will be used for the current operation.","constantName":"org.apache.camel.component.minio.MinioConstants#DESTINATION_BUCKET_NAME"},"CamelMinioContentControl":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The content control of this object. Consumer: The optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain.","constantName":"org.apache.camel.component.minio.MinioConstants#CACHE_CONTROL"},"CamelMinioContentDisposition":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The content disposition of this object. Consumer: The optional Content-Disposition HTTP header, which specifies presentational information such as the recommended filename for the object to be saved as.","constantName":"org.apache.camel.component.minio.MinioConstants#CONTENT_DISPOSITION"},"CamelMinioContentEncoding":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The content encoding of this object. Consumer: The optional Content-Encoding HTTP header specifying what content encodings have been applied to the object and what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type field.","constantName":"org.apache.camel.component.minio.MinioConstants#CONTENT_ENCODING"},"CamelMinioContentLength":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The content length of this object. Consumer: The Content-Length HTTP header indicating the size of the associated object in bytes.","constantName":"org.apache.camel.component.minio.MinioConstants#CONTENT_LENGTH"},"CamelMinioContentMD5":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The md5 checksum of this object. Consumer: The base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864. This data is used as a message integrity check to verify that the data received by Minio is the same data that the caller sent.","constantName":"org.apache.camel.component.minio.MinioConstants#CONTENT_MD5"},"CamelMinioContentType":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The content type of this object. Consumer: The Content-Type HTTP header, which indicates the type of content stored in the associated object. The value of this header is a standard MIME type.","constantName":"org.apache.camel.component.minio.MinioConstants#CONTENT_TYPE"},"CamelMinioETag":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The ETag value for the newly uploaded object. Consumer: The hex encoded 128-bit MD5 digest of the associated object according to RFC 1864. This data is used as an integrity check to verify that the data received by the caller is the same data that was sent by Minio","constantName":"org.apache.camel.component.minio.MinioConstants#E_TAG"},"CamelMinioObjectName":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The key under which this object will be stored or which will be used for the current operation. Consumer: The key under which this object is stored.","constantName":"org.apache.camel.component.minio.MinioConstants#OBJECT_NAME"},"CamelMinioDestinationObjectName":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Destination key which will be used for the current operation.","constantName":"org.apache.camel.component.minio.MinioConstants#DESTINATION_OBJECT_NAME"},"CamelMinioLastModified":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The last modified timestamp of this object. Consumer: The value of the Last-Modified header, indicating the date and time at which Minio last recorded a modification to the associated object.","constantName":"org.apache.camel.component.minio.MinioConstants#LAST_MODIFIED"},"CamelMinioStorageClass":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The storage class of this object.","constantName":"org.apache.camel.component.minio.MinioConstants#STORAGE_CLASS"},"CamelMinioVersionId":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The version Id of the object to be stored or returned from the current operation. Consumer: The version ID of the associated Minio object if available. Version IDs are only assigned to objects when an object is uploaded to an Minio bucket that has object versioning enabled.","constantName":"org.apache.camel.component.minio.MinioConstants#VERSION_ID"},"CamelMinioCannedAcl":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The canned acl that will be applied to the object. see com.amazonaws.services.s3.model.CannedAccessControlList for allowed values.","constantName":"org.apache.camel.component.minio.MinioConstants#CANNED_ACL"},"CamelMinioOperation":{"index":15,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.minio.MinioOperations","enum":["copyObject","listObjects","deleteObject","deleteObjects","deleteBucket","listBuckets","getObject","getPartialObject","createDownloadLink","createUploadLink"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.minio.MinioConstants#MINIO_OPERATION"},"CamelMinioServerSideEncryption":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Sets the server-side encryption algorithm when encrypting the object using Minio-managed keys. For example use AES256. Consumer: The server-side encryption algorithm when encrypting the object using Minio-managed keys.","constantName":"org.apache.camel.component.minio.MinioConstants#SERVER_SIDE_ENCRYPTION"},"CamelMinioExpirationTime":{"index":17,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The expiration time","constantName":"org.apache.camel.component.minio.MinioConstants#EXPIRATION_TIME"},"CamelMinioReplicationStatus":{"index":18,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The replication status","constantName":"org.apache.camel.component.minio.MinioConstants#REPLICATION_STATUS"},"CamelMinioOffset":{"index":19,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The offset","constantName":"org.apache.camel.component.minio.MinioConstants#OFFSET"},"CamelMinioLength":{"index":20,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The length","constantName":"org.apache.camel.component.minio.MinioConstants#LENGTH"},"CamelMinioPresignedURLExpirationTime":{"index":21,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Expiration of minio presigned url in Seconds","constantName":"org.apache.camel.component.minio.MinioConstants#PRESIGNED_URL_EXPIRATION_TIME"}},"properties":{"bucketName":{"index":0,"kind":"path","displayName":"Bucket Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Bucket name"},"autoCreateBucket":{"index":1,"kind":"parameter","displayName":"Auto Create Bucket","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Setting the autocreation of the bucket if bucket name not exist."},"endpoint":{"index":2,"kind":"parameter","displayName":"Endpoint","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Endpoint can be an URL, domain name, IPv4 address or IPv6 address."},"minioClient":{"index":3,"kind":"parameter","displayName":"Minio Client","group":"common","label":"common","required":false,"type":"object","javaType":"io.minio.MinioClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Reference to a Minio Client object in the registry."},"objectLock":{"index":4,"kind":"parameter","displayName":"Object Lock","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set when creating new bucket."},"policy":{"index":5,"kind":"parameter","displayName":"Policy","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The policy for this queue to set in the method."},"proxyPort":{"index":6,"kind":"parameter","displayName":"Proxy Port","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"TCP/IP port number. 80 and 443 are used as defaults for HTTP and HTTPS."},"region":{"index":7,"kind":"parameter","displayName":"Region","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The region in which Minio client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1). You'll need to use the name Region.EU_WEST_1.id()"},"secure":{"index":8,"kind":"parameter","displayName":"Secure","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Flag to indicate to use secure connection to minio service or not."},"autoCloseBody":{"index":9,"kind":"parameter","displayName":"Auto Close Body","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"If this option is true and includeBody is true, then the MinioObject.close() method will be called on exchange completion. This option is strongly related to includeBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the MinioObject stream. Setting autocloseBody to true, will close the MinioObject stream automatically."},"bypassGovernanceMode":{"index":10,"kind":"parameter","displayName":"Bypass Governance Mode","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set this flag if you want to bypassGovernanceMode when deleting a particular object."},"deleteAfterRead":{"index":11,"kind":"parameter","displayName":"Delete After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Delete objects from Minio after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the MinioConstants#BUCKET_NAME and MinioConstants#OBJECT_NAME headers, or only the MinioConstants#OBJECT_NAME header."},"delimiter":{"index":12,"kind":"parameter","displayName":"Delimiter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The delimiter which is used in the ListObjectsRequest to only consume objects we are interested in."},"destinationBucketName":{"index":13,"kind":"parameter","displayName":"Destination Bucket Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Destination bucket name."},"destinationObjectName":{"index":14,"kind":"parameter","displayName":"Destination Object Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Destination object name."},"includeBody":{"index":15,"kind":"parameter","displayName":"Include Body","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"If it is true, the exchange body will be set to a stream to the contents of the file. If false, the headers will be set with the Minio object metadata, but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the MinioObject stream. Setting autocloseBody to true, will close the MinioObject stream automatically."},"includeFolders":{"index":16,"kind":"parameter","displayName":"Include Folders","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The flag which is used in the ListObjectsRequest to set include folders."},"includeUserMetadata":{"index":17,"kind":"parameter","displayName":"Include User Metadata","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The flag which is used in the ListObjectsRequest to get objects with user meta data."},"includeVersions":{"index":18,"kind":"parameter","displayName":"Include Versions","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The flag which is used in the ListObjectsRequest to get objects with versioning."},"length":{"index":19,"kind":"parameter","displayName":"Length","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Number of bytes of object data from offset."},"matchETag":{"index":20,"kind":"parameter","displayName":"Match ETag","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set match ETag parameter for get object(s)."},"maxConnections":{"index":21,"kind":"parameter","displayName":"Max Connections","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set the maxConnections parameter in the minio client configuration"},"maxMessagesPerPoll":{"index":22,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited."},"modifiedSince":{"index":23,"kind":"parameter","displayName":"Modified Since","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"java.time.ZonedDateTime","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set modified since parameter for get object(s)."},"moveAfterRead":{"index":24,"kind":"parameter","displayName":"Move After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Move objects from bucket to a different bucket after they have been retrieved. To accomplish the operation the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved."},"notMatchETag":{"index":25,"kind":"parameter","displayName":"Not Match ETag","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set not match ETag parameter for get object(s)."},"objectName":{"index":26,"kind":"parameter","displayName":"Object Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"To get the object from the bucket with the given object name."},"offset":{"index":27,"kind":"parameter","displayName":"Offset","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Start byte position of object data."},"prefix":{"index":28,"kind":"parameter","displayName":"Prefix","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Object name starts with prefix."},"recursive":{"index":29,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"List recursively than directory structure emulation."},"sendEmptyMessageWhenIdle":{"index":30,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"startAfter":{"index":31,"kind":"parameter","displayName":"Start After","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"list objects in bucket after this object name."},"unModifiedSince":{"index":32,"kind":"parameter","displayName":"Un Modified Since","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"java.time.ZonedDateTime","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set un modified since parameter for get object(s)."},"useVersion1":{"index":33,"kind":"parameter","displayName":"Use Version1","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"when true, version 1 of REST API is used."},"versionId":{"index":34,"kind":"parameter","displayName":"Version Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set specific version_ID of a object when deleting the object."},"bridgeErrorHandler":{"index":35,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":36,"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":{"index":37,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":38,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"deleteAfterWrite":{"index":39,"kind":"parameter","displayName":"Delete After Write","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Delete file object after the Minio file has been uploaded."},"keyName":{"index":40,"kind":"parameter","displayName":"Key Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Setting the key name for an element in the bucket through endpoint parameter."},"operation":{"index":41,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.minio.MinioOperations","enum":["copyObject","listObjects","deleteObject","deleteObjects","deleteBucket","listBuckets","getObject","getObjectRange","createDownloadLink","createUploadLink"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The operation to do in case the user don't want to do only an upload."},"pojoRequest":{"index":42,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"If we want to use a POJO request as body or not."},"storageClass":{"index":43,"kind":"parameter","displayName":"Storage Class","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The storage class to set in the request."},"lazyStartProducer":{"index":44,"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."},"customHttpClient":{"index":45,"kind":"parameter","displayName":"Custom Http Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"okhttp3.OkHttpClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set custom HTTP client for authenticated access."},"backoffErrorThreshold":{"index":46,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":47,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":48,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":49,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":50,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":51,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":52,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":53,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":54,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":55,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":56,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":57,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":58,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":59,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":60,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Access Key or Minio Access Key. If not set camel will connect to service for anonymous access."},"secretKey":{"index":61,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key Id or Minio Secret Key. If not set camel will connect to service for anonymous access."},"serverSideEncryption":{"index":62,"kind":"parameter","displayName":"Server Side Encryption","group":"security","label":"security","required":false,"type":"object","javaType":"io.minio.ServerSideEncryption","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Server-side encryption."},"serverSideEncryptionCustomerKey":{"index":63,"kind":"parameter","displayName":"Server Side Encryption Customer Key","group":"security","label":"security","required":false,"type":"object","javaType":"io.minio.ServerSideEncryptionCustomerKey","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Server-side encryption for source object while copy/move objects."}}} +{"component":{"kind":"component","name":"minio","title":"Minio","description":"Store and retrieve objects from Minio Storage Service using Minio SDK.","deprecated":false,"firstVersion":"3.5.0","label":"cloud,file","javaType":"org.apache.camel.component.minio.MinioComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-minio","version":"4.8.2","scheme":"minio","extendsScheme":"","syntax":"minio:bucketName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelMinioBucketName":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The bucket Name which this object will be stored or which will be used for the current operation. Consumer: The name of the bucket in which this object is contained.","constantName":"org.apache.camel.component.minio.MinioConstants#BUCKET_NAME"},"CamelMinioDestinationBucketName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bucket Destination Name which will be used for the current operation.","constantName":"org.apache.camel.component.minio.MinioConstants#DESTINATION_BUCKET_NAME"},"CamelMinioContentControl":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The content control of this object. Consumer: The optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain.","constantName":"org.apache.camel.component.minio.MinioConstants#CACHE_CONTROL"},"CamelMinioContentDisposition":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The content disposition of this object. Consumer: The optional Content-Disposition HTTP header, which specifies presentational information such as the recommended filename for the object to be saved as.","constantName":"org.apache.camel.component.minio.MinioConstants#CONTENT_DISPOSITION"},"CamelMinioContentEncoding":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The content encoding of this object. Consumer: The optional Content-Encoding HTTP header specifying what content encodings have been applied to the object and what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type field.","constantName":"org.apache.camel.component.minio.MinioConstants#CONTENT_ENCODING"},"CamelMinioContentLength":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The content length of this object. Consumer: The Content-Length HTTP header indicating the size of the associated object in bytes.","constantName":"org.apache.camel.component.minio.MinioConstants#CONTENT_LENGTH"},"CamelMinioContentMD5":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The md5 checksum of this object. Consumer: The base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864. This data is used as a message integrity check to verify that the data received by Minio is the same data that the caller sent.","constantName":"org.apache.camel.component.minio.MinioConstants#CONTENT_MD5"},"CamelMinioContentType":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The content type of this object. Consumer: The Content-Type HTTP header, which indicates the type of content stored in the associated object. The value of this header is a standard MIME type.","constantName":"org.apache.camel.component.minio.MinioConstants#CONTENT_TYPE"},"CamelMinioETag":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The ETag value for the newly uploaded object. Consumer: The hex encoded 128-bit MD5 digest of the associated object according to RFC 1864. This data is used as an integrity check to verify that the data received by the caller is the same data that was sent by Minio","constantName":"org.apache.camel.component.minio.MinioConstants#E_TAG"},"CamelMinioObjectName":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The key under which this object will be stored or which will be used for the current operation. Consumer: The key under which this object is stored.","constantName":"org.apache.camel.component.minio.MinioConstants#OBJECT_NAME"},"CamelMinioDestinationObjectName":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Destination key which will be used for the current operation.","constantName":"org.apache.camel.component.minio.MinioConstants#DESTINATION_OBJECT_NAME"},"CamelMinioLastModified":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The last modified timestamp of this object. Consumer: The value of the Last-Modified header, indicating the date and time at which Minio last recorded a modification to the associated object.","constantName":"org.apache.camel.component.minio.MinioConstants#LAST_MODIFIED"},"CamelMinioStorageClass":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The storage class of this object.","constantName":"org.apache.camel.component.minio.MinioConstants#STORAGE_CLASS"},"CamelMinioVersionId":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The version Id of the object to be stored or returned from the current operation. Consumer: The version ID of the associated Minio object if available. Version IDs are only assigned to objects when an object is uploaded to an Minio bucket that has object versioning enabled.","constantName":"org.apache.camel.component.minio.MinioConstants#VERSION_ID"},"CamelMinioCannedAcl":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The canned acl that will be applied to the object. see com.amazonaws.services.s3.model.CannedAccessControlList for allowed values.","constantName":"org.apache.camel.component.minio.MinioConstants#CANNED_ACL"},"CamelMinioOperation":{"index":15,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.minio.MinioOperations","enum":["copyObject","listObjects","deleteObject","deleteObjects","deleteBucket","listBuckets","getObject","getPartialObject","createDownloadLink","createUploadLink"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.minio.MinioConstants#MINIO_OPERATION"},"CamelMinioServerSideEncryption":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Sets the server-side encryption algorithm when encrypting the object using Minio-managed keys. For example use AES256. Consumer: The server-side encryption algorithm when encrypting the object using Minio-managed keys.","constantName":"org.apache.camel.component.minio.MinioConstants#SERVER_SIDE_ENCRYPTION"},"CamelMinioExpirationTime":{"index":17,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The expiration time","constantName":"org.apache.camel.component.minio.MinioConstants#EXPIRATION_TIME"},"CamelMinioReplicationStatus":{"index":18,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The replication status","constantName":"org.apache.camel.component.minio.MinioConstants#REPLICATION_STATUS"},"CamelMinioOffset":{"index":19,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The offset","constantName":"org.apache.camel.component.minio.MinioConstants#OFFSET"},"CamelMinioLength":{"index":20,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The length","constantName":"org.apache.camel.component.minio.MinioConstants#LENGTH"},"CamelMinioPresignedURLExpirationTime":{"index":21,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Expiration of minio presigned url in Seconds","constantName":"org.apache.camel.component.minio.MinioConstants#PRESIGNED_URL_EXPIRATION_TIME"}},"properties":{"bucketName":{"index":0,"kind":"path","displayName":"Bucket Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Bucket name"},"autoCreateBucket":{"index":1,"kind":"parameter","displayName":"Auto Create Bucket","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Setting the autocreation of the bucket if bucket name not exist."},"endpoint":{"index":2,"kind":"parameter","displayName":"Endpoint","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Endpoint can be an URL, domain name, IPv4 address or IPv6 address."},"minioClient":{"index":3,"kind":"parameter","displayName":"Minio Client","group":"common","label":"common","required":false,"type":"object","javaType":"io.minio.MinioClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Reference to a Minio Client object in the registry."},"objectLock":{"index":4,"kind":"parameter","displayName":"Object Lock","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set when creating new bucket."},"policy":{"index":5,"kind":"parameter","displayName":"Policy","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The policy for this queue to set in the method."},"proxyPort":{"index":6,"kind":"parameter","displayName":"Proxy Port","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"TCP/IP port number. 80 and 443 are used as defaults for HTTP and HTTPS."},"region":{"index":7,"kind":"parameter","displayName":"Region","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The region in which Minio client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1). You'll need to use the name Region.EU_WEST_1.id()"},"secure":{"index":8,"kind":"parameter","displayName":"Secure","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Flag to indicate to use secure connection to minio service or not."},"autoCloseBody":{"index":9,"kind":"parameter","displayName":"Auto Close Body","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"If this option is true and includeBody is true, then the MinioObject.close() method will be called on exchange completion. This option is strongly related to includeBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the MinioObject stream. Setting autocloseBody to true, will close the MinioObject stream automatically."},"bypassGovernanceMode":{"index":10,"kind":"parameter","displayName":"Bypass Governance Mode","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set this flag if you want to bypassGovernanceMode when deleting a particular object."},"deleteAfterRead":{"index":11,"kind":"parameter","displayName":"Delete After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Delete objects from Minio after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the MinioConstants#BUCKET_NAME and MinioConstants#OBJECT_NAME headers, or only the MinioConstants#OBJECT_NAME header."},"delimiter":{"index":12,"kind":"parameter","displayName":"Delimiter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The delimiter which is used in the ListObjectsRequest to only consume objects we are interested in."},"destinationBucketName":{"index":13,"kind":"parameter","displayName":"Destination Bucket Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Destination bucket name."},"destinationObjectName":{"index":14,"kind":"parameter","displayName":"Destination Object Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Destination object name."},"includeBody":{"index":15,"kind":"parameter","displayName":"Include Body","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"If it is true, the exchange body will be set to a stream to the contents of the file. If false, the headers will be set with the Minio object metadata, but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the MinioObject stream. Setting autocloseBody to true, will close the MinioObject stream automatically."},"includeFolders":{"index":16,"kind":"parameter","displayName":"Include Folders","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The flag which is used in the ListObjectsRequest to set include folders."},"includeUserMetadata":{"index":17,"kind":"parameter","displayName":"Include User Metadata","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The flag which is used in the ListObjectsRequest to get objects with user meta data."},"includeVersions":{"index":18,"kind":"parameter","displayName":"Include Versions","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The flag which is used in the ListObjectsRequest to get objects with versioning."},"length":{"index":19,"kind":"parameter","displayName":"Length","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Number of bytes of object data from offset."},"matchETag":{"index":20,"kind":"parameter","displayName":"Match ETag","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set match ETag parameter for get object(s)."},"maxConnections":{"index":21,"kind":"parameter","displayName":"Max Connections","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set the maxConnections parameter in the minio client configuration"},"maxMessagesPerPoll":{"index":22,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited."},"modifiedSince":{"index":23,"kind":"parameter","displayName":"Modified Since","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"java.time.ZonedDateTime","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set modified since parameter for get object(s)."},"moveAfterRead":{"index":24,"kind":"parameter","displayName":"Move After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Move objects from bucket to a different bucket after they have been retrieved. To accomplish the operation the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved."},"notMatchETag":{"index":25,"kind":"parameter","displayName":"Not Match ETag","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set not match ETag parameter for get object(s)."},"objectName":{"index":26,"kind":"parameter","displayName":"Object Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"To get the object from the bucket with the given object name."},"offset":{"index":27,"kind":"parameter","displayName":"Offset","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Start byte position of object data."},"prefix":{"index":28,"kind":"parameter","displayName":"Prefix","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Object name starts with prefix."},"recursive":{"index":29,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"List recursively than directory structure emulation."},"sendEmptyMessageWhenIdle":{"index":30,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"startAfter":{"index":31,"kind":"parameter","displayName":"Start After","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"list objects in bucket after this object name."},"unModifiedSince":{"index":32,"kind":"parameter","displayName":"Un Modified Since","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"java.time.ZonedDateTime","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set un modified since parameter for get object(s)."},"useVersion1":{"index":33,"kind":"parameter","displayName":"Use Version1","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"when true, version 1 of REST API is used."},"versionId":{"index":34,"kind":"parameter","displayName":"Version Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set specific version_ID of a object when deleting the object."},"bridgeErrorHandler":{"index":35,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":36,"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":{"index":37,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":38,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"deleteAfterWrite":{"index":39,"kind":"parameter","displayName":"Delete After Write","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Delete file object after the Minio file has been uploaded."},"keyName":{"index":40,"kind":"parameter","displayName":"Key Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Setting the key name for an element in the bucket through endpoint parameter."},"operation":{"index":41,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.minio.MinioOperations","enum":["copyObject","listObjects","deleteObject","deleteObjects","deleteBucket","listBuckets","getObject","getObjectRange","createDownloadLink","createUploadLink"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The operation to do in case the user don't want to do only an upload."},"pojoRequest":{"index":42,"kind":"parameter","displayName":"Pojo Request","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"If we want to use a POJO request as body or not."},"storageClass":{"index":43,"kind":"parameter","displayName":"Storage Class","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"The storage class to set in the request."},"lazyStartProducer":{"index":44,"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."},"customHttpClient":{"index":45,"kind":"parameter","displayName":"Custom Http Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"okhttp3.OkHttpClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Set custom HTTP client for authenticated access."},"backoffErrorThreshold":{"index":46,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":47,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":48,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":49,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":50,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":51,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":52,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":53,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":54,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":55,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":56,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":57,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":58,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":59,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"index":60,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Amazon AWS Secret Access Key or Minio Access Key. If not set camel will connect to service for anonymous access."},"secretKey":{"index":61,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Amazon AWS Access Key Id or Minio Secret Key. If not set camel will connect to service for anonymous access."},"serverSideEncryption":{"index":62,"kind":"parameter","displayName":"Server Side Encryption","group":"security","label":"security","required":false,"type":"object","javaType":"io.minio.ServerSideEncryption","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Server-side encryption."},"serverSideEncryptionCustomerKey":{"index":63,"kind":"parameter","displayName":"Server Side Encryption Customer Key","group":"security","label":"security","required":false,"type":"object","javaType":"io.minio.ServerSideEncryptionCustomerKey","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.minio.MinioConfiguration","configurationField":"configuration","description":"Server-side encryption for source object while copy/move objects."}}} , -{"component":{"kind":"component","name":"mllp","title":"MLLP","description":"Communicate with external systems using the MLLP protocol.","deprecated":false,"firstVersion":"2.17.0","label":"HEALTH","javaType":"org.apache.camel.component.mllp.MllpComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mllp","version":"4.8.1","scheme":"mllp","extendsScheme":"","syntax":"mllp:hostname:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelMllpLocalAddress":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local TCP Address of the Socket","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_LOCAL_ADDRESS"},"CamelMllpRemoteAddress":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote TCP Address of the Socket","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_REMOTE_ADDRESS"},"CamelMllpAcknowledgement":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HL7 Acknowledgment received in bytes","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_ACKNOWLEDGEMENT"},"CamelMllpAcknowledgementString":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HL7 Acknowledgment received, converted to a String","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_ACKNOWLEDGEMENT_STRING"},"CamelMllpAcknowledgementType":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HL7 acknowledgement type (AA, AE, AR, etc)","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_ACKNOWLEDGEMENT_TYPE"},"CamelMllpSendingApplication":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-3 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_SENDING_APPLICATION"},"CamelMllpSendingFacility":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-4 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_SENDING_FACILITY"},"CamelMllpReceivingApplication":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-5 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_RECEIVING_APPLICATION"},"CamelMllpReceivingFacility":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-6 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_RECEIVING_FACILITY"},"CamelMllpTimestamp":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-7 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_TIMESTAMP"},"CamelMllpSecurity":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-8 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_SECURITY"},"CamelMllpMessageType":{"index":11,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-9 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_MESSAGE_TYPE"},"CamelMllpEventType":{"index":12,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-9.1 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_EVENT_TYPE"},"CamelMllpTriggerEvent":{"index":13,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-9.2 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_TRIGGER_EVENT"},"CamelMllpMessageControlId":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-10 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_MESSAGE_CONTROL"},"CamelMllpProcessingId":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-11 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_PROCESSING_ID"},"CamelMllpVersionId":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-12 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_VERSION_ID"},"CamelMllpCharset":{"index":17,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-18 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_CHARSET"}},"properties":{"hostname":{"index":0,"kind":"path","displayName":"Hostname","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname or IP for connection for the TCP connection. The default value is null, which means any local IP address"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Port number for the TCP connection"},"autoAck":{"index":2,"kind":"parameter","displayName":"Auto Ack","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only"},"charsetName":{"index":3,"kind":"parameter","displayName":"Charset Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Sets the default charset to use"},"hl7Headers":{"index":4,"kind":"parameter","displayName":"Hl7 Headers","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only"},"requireEndOfData":{"index":5,"kind":"parameter","displayName":"Require End Of Data","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/Disable strict compliance to the MLLP standard. The MLLP standard specifies START_OF_BLOCKhl7 payloadEND_OF_BLOCKEND_OF_DATA, however, some systems do not send the final END_OF_DATA byte. This setting controls whether or not the final END_OF_DATA byte is required or optional."},"stringPayload":{"index":6,"kind":"parameter","displayName":"String Payload","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/Disable converting the payload to a String. If enabled, HL7 Payloads received from external systems will be validated converted to a String. If the charsetName property is set, that character set will be used for the conversion. If the charsetName property is not set, the value of MSH-18 will be used to determine th appropriate character set. If MSH-18 is not set, then the default ISO-8859-1 character set will be use."},"validatePayload":{"index":7,"kind":"parameter","displayName":"Validate Payload","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/Disable the validation of HL7 Payloads If enabled, HL7 Payloads received from external systems will be validated (see Hl7Util.generateInvalidPayloadExceptionMessage for details on the validation). If and invalid payload is detected, a MllpInvalidMessageException (for consumers) or a MllpInvalidAcknowledgementException will be thrown."},"acceptTimeout":{"index":8,"kind":"parameter","displayName":"Accept Timeout","group":"consumer","label":"advanced,consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Timeout (in milliseconds) while waiting for a TCP connection TCP Server Only"},"backlog":{"index":9,"kind":"parameter","displayName":"Backlog","group":"consumer","label":"advanced,consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full, the connection is refused."},"bindRetryInterval":{"index":10,"kind":"parameter","displayName":"Bind Retry Interval","group":"consumer","label":"advanced,consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"TCP Server Only - The number of milliseconds to wait between bind attempts"},"bindTimeout":{"index":11,"kind":"parameter","displayName":"Bind Timeout","group":"consumer","label":"advanced,consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"TCP Server Only - The number of milliseconds to retry binding to a server port"},"bridgeErrorHandler":{"index":12,"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to receive incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. If disabled, the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions by logging them at WARN or ERROR level and ignored."},"lenientBind":{"index":13,"kind":"parameter","displayName":"Lenient Bind","group":"consumer","label":"advanced,consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"TCP Server Only - Allow the endpoint to start before the TCP ServerSocket is bound. In some environments, it may be desirable to allow the endpoint to start before the TCP ServerSocket is bound."},"maxConcurrentConsumers":{"index":14,"kind":"parameter","displayName":"Max Concurrent Consumers","group":"consumer","label":"advanced,consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"The maximum number of concurrent MLLP Consumer connections that will be allowed. If a new connection is received and the maximum is number are already established, the new connection will be reset immediately."},"reuseAddress":{"index":15,"kind":"parameter","displayName":"Reuse Address","group":"consumer","label":"advanced,consumer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/disable the SO_REUSEADDR socket option."},"exceptionHandler":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"InOut","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Sets the exchange pattern when the consumer creates an exchange."},"connectTimeout":{"index":18,"kind":"parameter","displayName":"Connect Timeout","group":"producer","label":"advanced,producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Timeout (in milliseconds) for establishing for a TCP connection TCP Client only"},"idleTimeoutStrategy":{"index":19,"kind":"parameter","displayName":"Idle Timeout Strategy","group":"producer","label":"advanced,producer","required":false,"type":"object","javaType":"org.apache.camel.component.mllp.MllpIdleTimeoutStrategy","enum":["RESET","CLOSE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"RESET","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"decide what action to take when idle timeout occurs. Possible values are : RESET: set SO_LINGER to 0 and reset the socket CLOSE: close the socket gracefully default is RESET."},"keepAlive":{"index":20,"kind":"parameter","displayName":"Keep Alive","group":"producer","label":"advanced,producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/disable the SO_KEEPALIVE socket option."},"tcpNoDelay":{"index":21,"kind":"parameter","displayName":"Tcp No Delay","group":"producer","label":"advanced,producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/disable the TCP_NODELAY socket option."},"lazyStartProducer":{"index":22,"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."},"maxBufferSize":{"index":23,"kind":"parameter","displayName":"Max Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1073741824,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Maximum buffer size used when receiving or sending data over the wire."},"minBufferSize":{"index":24,"kind":"parameter","displayName":"Min Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Minimum buffer size used when receiving or sending data over the wire."},"readTimeout":{"index":25,"kind":"parameter","displayName":"Read Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"The SO_TIMEOUT value (in milliseconds) used after the start of an MLLP frame has been received"},"receiveBufferSize":{"index":26,"kind":"parameter","displayName":"Receive Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"8192","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Sets the SO_RCVBUF option to the specified value (in bytes)"},"receiveTimeout":{"index":27,"kind":"parameter","displayName":"Receive Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":15000,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"The SO_TIMEOUT value (in milliseconds) used when waiting for the start of an MLLP frame"},"sendBufferSize":{"index":28,"kind":"parameter","displayName":"Send Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"8192","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Sets the SO_SNDBUF option to the specified value (in bytes)"},"idleTimeout":{"index":29,"kind":"parameter","displayName":"Idle Timeout","group":"tcp","label":"advanced,tcp","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"The approximate idle time allowed before the Client TCP Connection will be reset. A null value or a value less than or equal to zero will disable the idle timeout."}}} +{"component":{"kind":"component","name":"mllp","title":"MLLP","description":"Communicate with external systems using the MLLP protocol.","deprecated":false,"firstVersion":"2.17.0","label":"HEALTH","javaType":"org.apache.camel.component.mllp.MllpComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mllp","version":"4.8.2","scheme":"mllp","extendsScheme":"","syntax":"mllp:hostname:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelMllpLocalAddress":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local TCP Address of the Socket","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_LOCAL_ADDRESS"},"CamelMllpRemoteAddress":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote TCP Address of the Socket","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_REMOTE_ADDRESS"},"CamelMllpAcknowledgement":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HL7 Acknowledgment received in bytes","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_ACKNOWLEDGEMENT"},"CamelMllpAcknowledgementString":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HL7 Acknowledgment received, converted to a String","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_ACKNOWLEDGEMENT_STRING"},"CamelMllpAcknowledgementType":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HL7 acknowledgement type (AA, AE, AR, etc)","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_ACKNOWLEDGEMENT_TYPE"},"CamelMllpSendingApplication":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-3 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_SENDING_APPLICATION"},"CamelMllpSendingFacility":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-4 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_SENDING_FACILITY"},"CamelMllpReceivingApplication":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-5 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_RECEIVING_APPLICATION"},"CamelMllpReceivingFacility":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-6 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_RECEIVING_FACILITY"},"CamelMllpTimestamp":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-7 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_TIMESTAMP"},"CamelMllpSecurity":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-8 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_SECURITY"},"CamelMllpMessageType":{"index":11,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-9 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_MESSAGE_TYPE"},"CamelMllpEventType":{"index":12,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-9.1 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_EVENT_TYPE"},"CamelMllpTriggerEvent":{"index":13,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-9.2 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_TRIGGER_EVENT"},"CamelMllpMessageControlId":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-10 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_MESSAGE_CONTROL"},"CamelMllpProcessingId":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-11 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_PROCESSING_ID"},"CamelMllpVersionId":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-12 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_VERSION_ID"},"CamelMllpCharset":{"index":17,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MSH-18 value","constantName":"org.apache.camel.component.mllp.MllpConstants#MLLP_CHARSET"}},"properties":{"hostname":{"index":0,"kind":"path","displayName":"Hostname","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname or IP for connection for the TCP connection. The default value is null, which means any local IP address"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Port number for the TCP connection"},"autoAck":{"index":2,"kind":"parameter","displayName":"Auto Ack","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only"},"charsetName":{"index":3,"kind":"parameter","displayName":"Charset Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Sets the default charset to use"},"hl7Headers":{"index":4,"kind":"parameter","displayName":"Hl7 Headers","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only"},"requireEndOfData":{"index":5,"kind":"parameter","displayName":"Require End Of Data","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/Disable strict compliance to the MLLP standard. The MLLP standard specifies START_OF_BLOCKhl7 payloadEND_OF_BLOCKEND_OF_DATA, however, some systems do not send the final END_OF_DATA byte. This setting controls whether or not the final END_OF_DATA byte is required or optional."},"stringPayload":{"index":6,"kind":"parameter","displayName":"String Payload","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/Disable converting the payload to a String. If enabled, HL7 Payloads received from external systems will be validated converted to a String. If the charsetName property is set, that character set will be used for the conversion. If the charsetName property is not set, the value of MSH-18 will be used to determine th appropriate character set. If MSH-18 is not set, then the default ISO-8859-1 character set will be use."},"validatePayload":{"index":7,"kind":"parameter","displayName":"Validate Payload","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/Disable the validation of HL7 Payloads If enabled, HL7 Payloads received from external systems will be validated (see Hl7Util.generateInvalidPayloadExceptionMessage for details on the validation). If and invalid payload is detected, a MllpInvalidMessageException (for consumers) or a MllpInvalidAcknowledgementException will be thrown."},"acceptTimeout":{"index":8,"kind":"parameter","displayName":"Accept Timeout","group":"consumer","label":"advanced,consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Timeout (in milliseconds) while waiting for a TCP connection TCP Server Only"},"backlog":{"index":9,"kind":"parameter","displayName":"Backlog","group":"consumer","label":"advanced,consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full, the connection is refused."},"bindRetryInterval":{"index":10,"kind":"parameter","displayName":"Bind Retry Interval","group":"consumer","label":"advanced,consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"TCP Server Only - The number of milliseconds to wait between bind attempts"},"bindTimeout":{"index":11,"kind":"parameter","displayName":"Bind Timeout","group":"consumer","label":"advanced,consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"TCP Server Only - The number of milliseconds to retry binding to a server port"},"bridgeErrorHandler":{"index":12,"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to receive incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. If disabled, the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions by logging them at WARN or ERROR level and ignored."},"lenientBind":{"index":13,"kind":"parameter","displayName":"Lenient Bind","group":"consumer","label":"advanced,consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"TCP Server Only - Allow the endpoint to start before the TCP ServerSocket is bound. In some environments, it may be desirable to allow the endpoint to start before the TCP ServerSocket is bound."},"maxConcurrentConsumers":{"index":14,"kind":"parameter","displayName":"Max Concurrent Consumers","group":"consumer","label":"advanced,consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"The maximum number of concurrent MLLP Consumer connections that will be allowed. If a new connection is received and the maximum is number are already established, the new connection will be reset immediately."},"reuseAddress":{"index":15,"kind":"parameter","displayName":"Reuse Address","group":"consumer","label":"advanced,consumer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/disable the SO_REUSEADDR socket option."},"exceptionHandler":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"InOut","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Sets the exchange pattern when the consumer creates an exchange."},"connectTimeout":{"index":18,"kind":"parameter","displayName":"Connect Timeout","group":"producer","label":"advanced,producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Timeout (in milliseconds) for establishing for a TCP connection TCP Client only"},"idleTimeoutStrategy":{"index":19,"kind":"parameter","displayName":"Idle Timeout Strategy","group":"producer","label":"advanced,producer","required":false,"type":"object","javaType":"org.apache.camel.component.mllp.MllpIdleTimeoutStrategy","enum":["RESET","CLOSE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"RESET","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"decide what action to take when idle timeout occurs. Possible values are : RESET: set SO_LINGER to 0 and reset the socket CLOSE: close the socket gracefully default is RESET."},"keepAlive":{"index":20,"kind":"parameter","displayName":"Keep Alive","group":"producer","label":"advanced,producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/disable the SO_KEEPALIVE socket option."},"tcpNoDelay":{"index":21,"kind":"parameter","displayName":"Tcp No Delay","group":"producer","label":"advanced,producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Enable/disable the TCP_NODELAY socket option."},"lazyStartProducer":{"index":22,"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."},"maxBufferSize":{"index":23,"kind":"parameter","displayName":"Max Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1073741824,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Maximum buffer size used when receiving or sending data over the wire."},"minBufferSize":{"index":24,"kind":"parameter","displayName":"Min Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Minimum buffer size used when receiving or sending data over the wire."},"readTimeout":{"index":25,"kind":"parameter","displayName":"Read Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"The SO_TIMEOUT value (in milliseconds) used after the start of an MLLP frame has been received"},"receiveBufferSize":{"index":26,"kind":"parameter","displayName":"Receive Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"8192","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Sets the SO_RCVBUF option to the specified value (in bytes)"},"receiveTimeout":{"index":27,"kind":"parameter","displayName":"Receive Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":15000,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"The SO_TIMEOUT value (in milliseconds) used when waiting for the start of an MLLP frame"},"sendBufferSize":{"index":28,"kind":"parameter","displayName":"Send Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"8192","configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"Sets the SO_SNDBUF option to the specified value (in bytes)"},"idleTimeout":{"index":29,"kind":"parameter","displayName":"Idle Timeout","group":"tcp","label":"advanced,tcp","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mllp.MllpConfiguration","configurationField":"configuration","description":"The approximate idle time allowed before the Client TCP Connection will be reset. A null value or a value less than or equal to zero will disable the idle timeout."}}} , -{"component":{"kind":"component","name":"mock","title":"Mock","description":"Test routes and mediation rules using mocks.","deprecated":false,"firstVersion":"1.0.0","label":"core,testing","javaType":"org.apache.camel.component.mock.MockComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mock","version":"4.8.1","scheme":"mock","extendsScheme":"","syntax":"mock:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of mock endpoint"},"assertPeriod":{"index":1,"kind":"parameter","displayName":"Assert Period","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets a grace period after which the mock endpoint will re-assert to ensure the preliminary assertion is still valid. This is used, for example, to assert that exactly a number of messages arrive. For example, if the expected count was set to 5, then the assertion is satisfied when five or more messages arrive. To ensure that exactly 5 messages arrive, then you would need to wait a little period to ensure no further message arrives. This is what you can use this method for. By default, this period is disabled."},"expectedCount":{"index":2,"kind":"parameter","displayName":"Expected Count","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies the expected number of message exchanges that should be received by this endpoint. Beware: If you want to expect that 0 messages, then take extra care, as 0 matches when the tests starts, so you need to set a assert period time to let the test run for a while to make sure there are still no messages arrived; for that use setAssertPeriod(long). An alternative is to use NotifyBuilder, and use the notifier to know when Camel is done routing some messages, before you call the assertIsSatisfied() method on the mocks. This allows you to not use a fixed assert period, to speedup testing times. If you want to assert that exactly nth message arrives to this mock endpoint, then see also the setAssertPeriod(long) method for further details."},"failFast":{"index":3,"kind":"parameter","displayName":"Fail Fast","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether assertIsSatisfied() should fail fast at the first detected failed expectation while it may otherwise wait for all expected messages to arrive before performing expectations verifications. Is by default true. Set to false to use behavior as in Camel 2.x."},"log":{"index":4,"kind":"parameter","displayName":"Log","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To turn on logging when the mock receives an incoming message. This will log only one time at INFO level for the incoming message. For more detailed logging then set the logger to DEBUG level for the org.apache.camel.component.mock.MockEndpoint class."},"reportGroup":{"index":5,"kind":"parameter","displayName":"Report Group","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"A number that is used to turn on throughput logging based on groups of the size."},"resultMinimumWaitTime":{"index":6,"kind":"parameter","displayName":"Result Minimum Wait Time","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets the minimum expected amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"},"resultWaitTime":{"index":7,"kind":"parameter","displayName":"Result Wait Time","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets the maximum amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"},"retainFirst":{"index":8,"kind":"parameter","displayName":"Retain First","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies to only retain the first nth number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the first 10 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."},"retainLast":{"index":9,"kind":"parameter","displayName":"Retain Last","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies to only retain the last nth number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the last 20 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."},"sleepForEmptyTest":{"index":10,"kind":"parameter","displayName":"Sleep For Empty Test","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Allows a sleep to be specified to wait to check that this endpoint really is empty when expectedMessageCount(int) is called with zero"},"copyOnExchange":{"index":11,"kind":"parameter","displayName":"Copy On Exchange","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true."},"lazyStartProducer":{"index":12,"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."}}} +{"component":{"kind":"component","name":"mock","title":"Mock","description":"Test routes and mediation rules using mocks.","deprecated":false,"firstVersion":"1.0.0","label":"core,testing","javaType":"org.apache.camel.component.mock.MockComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mock","version":"4.8.2","scheme":"mock","extendsScheme":"","syntax":"mock:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of mock endpoint"},"assertPeriod":{"index":1,"kind":"parameter","displayName":"Assert Period","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets a grace period after which the mock endpoint will re-assert to ensure the preliminary assertion is still valid. This is used, for example, to assert that exactly a number of messages arrive. For example, if the expected count was set to 5, then the assertion is satisfied when five or more messages arrive. To ensure that exactly 5 messages arrive, then you would need to wait a little period to ensure no further message arrives. This is what you can use this method for. By default, this period is disabled."},"expectedCount":{"index":2,"kind":"parameter","displayName":"Expected Count","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies the expected number of message exchanges that should be received by this endpoint. Beware: If you want to expect that 0 messages, then take extra care, as 0 matches when the tests starts, so you need to set a assert period time to let the test run for a while to make sure there are still no messages arrived; for that use setAssertPeriod(long). An alternative is to use NotifyBuilder, and use the notifier to know when Camel is done routing some messages, before you call the assertIsSatisfied() method on the mocks. This allows you to not use a fixed assert period, to speedup testing times. If you want to assert that exactly nth message arrives to this mock endpoint, then see also the setAssertPeriod(long) method for further details."},"failFast":{"index":3,"kind":"parameter","displayName":"Fail Fast","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether assertIsSatisfied() should fail fast at the first detected failed expectation while it may otherwise wait for all expected messages to arrive before performing expectations verifications. Is by default true. Set to false to use behavior as in Camel 2.x."},"log":{"index":4,"kind":"parameter","displayName":"Log","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To turn on logging when the mock receives an incoming message. This will log only one time at INFO level for the incoming message. For more detailed logging then set the logger to DEBUG level for the org.apache.camel.component.mock.MockEndpoint class."},"reportGroup":{"index":5,"kind":"parameter","displayName":"Report Group","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"A number that is used to turn on throughput logging based on groups of the size."},"resultMinimumWaitTime":{"index":6,"kind":"parameter","displayName":"Result Minimum Wait Time","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets the minimum expected amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"},"resultWaitTime":{"index":7,"kind":"parameter","displayName":"Result Wait Time","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Sets the maximum amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"},"retainFirst":{"index":8,"kind":"parameter","displayName":"Retain First","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies to only retain the first nth number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the first 10 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."},"retainLast":{"index":9,"kind":"parameter","displayName":"Retain Last","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Specifies to only retain the last nth number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the last 20 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."},"sleepForEmptyTest":{"index":10,"kind":"parameter","displayName":"Sleep For Empty Test","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Allows a sleep to be specified to wait to check that this endpoint really is empty when expectedMessageCount(int) is called with zero"},"copyOnExchange":{"index":11,"kind":"parameter","displayName":"Copy On Exchange","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true."},"lazyStartProducer":{"index":12,"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."}}} , -{"component":{"kind":"component","name":"mongodb","title":"MongoDB","description":"Perform operations on MongoDB documents and collections.","deprecated":false,"firstVersion":"2.19.0","label":"database","javaType":"org.apache.camel.component.mongodb.MongoDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mongodb","version":"4.8.1","scheme":"mongodb","extendsScheme":"","syntax":"mongodb:connectionBean","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelMongoDbOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.mongodb.MongoDbOperation or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation this endpoint will execute against MongoDB.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#OPERATION_HEADER"},"CamelMongoDbResultTotalSize":{"index":1,"kind":"header","displayName":"","group":"producer findAll","label":"producer findAll","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Number of objects matching the query. This does not take limit/skip into consideration.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#RESULT_TOTAL_SIZE"},"CamelMongoDbResultPageSize":{"index":2,"kind":"header","displayName":"","group":"producer findAll","label":"producer findAll","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Number of objects matching the query. This does not take limit/skip into consideration.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#RESULT_PAGE_SIZE"},"CamelMongoDbCriteria":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.bson.conversions.Bson","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query to execute against MongoDB.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#CRITERIA"},"CamelMongoDbFieldsProjection":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.bson.conversions.Bson","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project document.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#FIELDS_PROJECTION"},"CamelMongoDbBatchSize":{"index":5,"kind":"header","displayName":"","group":"producer findAll aggregate","label":"producer findAll aggregate","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of documents per batch.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#BATCH_SIZE"},"CamelMongoDbNumToSkip":{"index":6,"kind":"header","displayName":"","group":"producer findAll","label":"producer findAll","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Discards a given number of elements at the beginning of the cursor.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#NUM_TO_SKIP"},"CamelMongoDbMultiUpdate":{"index":7,"kind":"header","displayName":"","group":"producer update","label":"producer update","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the update should be applied to all objects matching. See http://www.mongodb.org/display/DOCS/AtomicOperationsAtomic Operations","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#MULTIUPDATE"},"CamelMongoDbUpsert":{"index":8,"kind":"header","displayName":"","group":"producer update","label":"producer update","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the database should create the element if it does not exist","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#UPSERT"},"CamelMongoDbRecordsAffected":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of modified or deleted records","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#RECORDS_AFFECTED"},"CamelMongoDbRecordsMatched":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of documents matched by the query.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#RECORDS_MATCHED"},"CamelMongoDbSortBy":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Bson or Document","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sort criteria.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#SORT_BY"},"CamelMongoDbDatabase":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the MongoDB database to target","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#DATABASE"},"CamelMongoDbCollection":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the MongoDB collection to bind to this endpoint","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#COLLECTION"},"CamelMongoDbCollectionIndex":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of dynamic indexes to create on the fly","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#COLLECTION_INDEX"},"CamelMongoDbLimit":{"index":15,"kind":"header","displayName":"","group":"producer findAll","label":"producer findAll","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Limits the number of elements returned.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#LIMIT"},"CamelMongoDbTailable":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is from tailable","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#FROM_TAILABLE"},"CamelMongoWriteResult":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The result of the write operation","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#WRITERESULT"},"CamelMongoOid":{"index":18,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object or List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The OID(s) of the inserted record(s)","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#OID"},"CamelMongoDbDistinctQueryField":{"index":19,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The specified field name fow which we want to get the distinct values.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#DISTINCT_QUERY_FIELD"},"CamelMongoDbAllowDiskUse":{"index":20,"kind":"header","displayName":"","group":"producer findAll aggregate","label":"producer findAll aggregate","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets allowDiskUse MongoDB flag. This is supported since MongoDB Server 4.3.1. Using this header with older MongoDB Server version can cause query to fail.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#ALLOW_DISK_USE"},"CamelMongoDbBulkOrdered":{"index":21,"kind":"header","displayName":"","group":"producer bulkWrite","label":"producer bulkWrite","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"TRUE","description":"Perform an ordered or unordered operation execution.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#BULK_ORDERED"},"_id":{"index":22,"kind":"header","displayName":"","group":"consumer changeStreams","label":"consumer changeStreams","required":false,"javaType":"org.bson.types.ObjectId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A document that contains the _id of the document created or modified by the insert, replace, delete, update operations (i.e. CRUD operations). For sharded collections, also displays the full shard key for the document. The _id field is not repeated if it is already a part of the shard key.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#MONGO_ID"},"CamelMongoDbStreamOperationType":{"index":23,"kind":"header","displayName":"","group":"consumer changeStreams","label":"consumer changeStreams","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of operation that occurred. Can be any of the following values: insert, delete, replace, update, drop, rename, dropDatabase, invalidate.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#STREAM_OPERATION_TYPE"},"CamelMongoDbReturnDocumentType":{"index":24,"kind":"header","displayName":"","group":"producer update one and return","label":"producer update one and return","required":false,"javaType":"com.mongodb.client.model.ReturnDocument","enum":["BEFORE","AFTER"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates which document to return, the document before or after an update and return atomic operation.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#RETURN_DOCUMENT"},"CamelMongoDbOperationOption":{"index":25,"kind":"header","displayName":"","group":"producer update one and options","label":"producer update one and options","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Options to use. When set, options set in the headers will be ignored.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#OPTIONS"}},"properties":{"connectionBean":{"index":0,"kind":"path","displayName":"Connection Bean","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the connection bean reference used to lookup a client for connecting to a database if no hosts parameter is present."},"collection":{"index":1,"kind":"parameter","displayName":"Collection","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of the MongoDB collection to bind to this endpoint"},"collectionIndex":{"index":2,"kind":"parameter","displayName":"Collection Index","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the collection index (JSON FORMAT : { field1 : order1, field2 : order2})"},"connectionUriString":{"index":3,"kind":"parameter","displayName":"Connection Uri String","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Set the whole Connection String/Uri for mongodb endpoint."},"createCollection":{"index":4,"kind":"parameter","displayName":"Create Collection","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Create the collection during initialisation if it doesn't exist. Default is true."},"database":{"index":5,"kind":"parameter","displayName":"Database","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of the MongoDB database to target"},"hosts":{"index":6,"kind":"parameter","displayName":"Hosts","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Host address of mongodb server in host:port format. It's possible to also use more than one address, as a comma separated list of hosts: host1:port1,host2:port2. If this parameter is specified, the provided connectionBean is ignored."},"mongoConnection":{"index":7,"kind":"parameter","displayName":"Mongo Connection","group":"common","label":"","required":false,"type":"object","javaType":"com.mongodb.client.MongoClient","deprecated":false,"autowired":false,"secret":false,"description":"Sets the connection bean used as a client for connecting to a database."},"operation":{"index":8,"kind":"parameter","displayName":"Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.mongodb.MongoDbOperation","enum":["findById","findOneAndDelete","findOneAndReplace","findOneAndUpdate","findOneByQuery","findAll","findDistinct","insert","save","update","remove","bulkWrite","aggregate","getDbStats","getColStats","count","command"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the operation this endpoint will execute against MongoDB."},"outputType":{"index":9,"kind":"parameter","displayName":"Output Type","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.component.mongodb.MongoDbOutputType","enum":["DocumentList","Document","MongoIterable"],"deprecated":false,"autowired":false,"secret":false,"description":"Convert the output of the producer to the selected type: DocumentList Document or MongoIterable. DocumentList or MongoIterable applies to findAll and aggregate. Document applies to all other operations."},"consumerType":{"index":10,"kind":"parameter","displayName":"Consumer Type","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Consumer type."},"bridgeErrorHandler":{"index":11,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":12,"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":{"index":13,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":14,"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."},"appName":{"index":15,"kind":"parameter","displayName":"App Name","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the logical name of the application. The application name may be used by the client to identify the application to the server, for use in server logs, slow query logs, and profile collection. Default: null"},"compressors":{"index":16,"kind":"parameter","displayName":"Compressors","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies one or more compression algorithms that the driver will attempt to use to compress requests sent to the connected MongoDB instance. Possible values include: zlib, snappy, and zstd. Default: null"},"connectTimeoutMS":{"index":17,"kind":"parameter","displayName":"Connect Timeout MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","description":"Specifies the maximum amount of time, in milliseconds, the Java driver waits for a connection to open before timing out. A value of 0 instructs the driver to never time out while waiting for a connection to open. Default: 10000 (10 seconds)"},"cursorRegenerationDelay":{"index":18,"kind":"parameter","displayName":"Cursor Regeneration Delay","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"MongoDB tailable cursors will block until new data arrives. If no new data is inserted, after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor, and if the attempt fails, how long before the next attempt is made. Default value is 1000ms."},"directConnection":{"index":19,"kind":"parameter","displayName":"Direct Connection","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies that the driver must connect to the host directly. Default: false"},"dynamicity":{"index":20,"kind":"parameter","displayName":"Dynamicity","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit."},"heartbeatFrequencyMS":{"index":21,"kind":"parameter","displayName":"Heartbeat Frequency MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"heartbeatFrequencyMS controls when the driver checks the state of the MongoDB deployment. Specify the interval (in milliseconds) between checks, counted from the end of the previous check until the beginning of the next one. Default: Single-threaded drivers: 60 seconds. Multithreaded drivers: 10 seconds."},"loadBalanced":{"index":22,"kind":"parameter","displayName":"Load Balanced","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true the driver will assume that it's connecting to MongoDB through a load balancer."},"localThresholdMS":{"index":23,"kind":"parameter","displayName":"Local Threshold MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"15","description":"The size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances. Default: 15 milliseconds."},"maxConnecting":{"index":24,"kind":"parameter","displayName":"Max Connecting","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2","description":"Specifies the maximum number of connections a pool may be establishing concurrently. Default: 2"},"maxIdleTimeMS":{"index":25,"kind":"parameter","displayName":"Max Idle Time MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","description":"Specifies the maximum amount of time, in milliseconds, the Java driver will allow a pooled connection to idle before closing the connection. A value of 0 indicates that there is no upper bound on how long the driver can allow a pooled collection to be idle. Default: 0"},"maxLifeTimeMS":{"index":26,"kind":"parameter","displayName":"Max Life Time MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","description":"Specifies the maximum amount of time, in milliseconds, the Java driver will continue to use a pooled connection before closing the connection. A value of 0 indicates that there is no upper bound on how long the driver can keep a pooled connection open. Default: 0"},"maxPoolSize":{"index":27,"kind":"parameter","displayName":"Max Pool Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","description":"The maximum number of connections in the connection pool. The default value is 100."},"maxStalenessSeconds":{"index":28,"kind":"parameter","displayName":"Max Staleness Seconds","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"-1","description":"Specifies, in seconds, how stale a secondary can be before the driver stops communicating with that secondary. The minimum value is either 90 seconds or the heartbeat frequency plus 10 seconds, whichever is greater. For more information, see the server documentation for the maxStalenessSeconds option. Not providing a parameter or explicitly specifying -1 indicates that there should be no staleness check for secondaries. Default: -1"},"minPoolSize":{"index":29,"kind":"parameter","displayName":"Min Pool Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","description":"Specifies the minimum number of connections that must exist at any moment in a single connection pool. Default: 0"},"readPreference":{"index":30,"kind":"parameter","displayName":"Read Preference","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["PRIMARY","PRIMARY_PREFERRED","SECONDARY","SECONDARY_PREFERRED","NEAREST"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PRIMARY","description":"Configure how MongoDB clients route read operations to the members of a replica set. Possible values are PRIMARY, PRIMARY_PREFERRED, SECONDARY, SECONDARY_PREFERRED or NEAREST"},"readPreferenceTags":{"index":31,"kind":"parameter","displayName":"Read Preference Tags","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"A representation of a tag set as a comma-separated list of colon-separated key-value pairs, e.g. dc:ny,rack:1. Spaces are stripped from the beginning and end of all keys and values. To specify a list of tag sets, using multiple readPreferenceTags, e.g., readPreferenceTags=dc:ny,rack:1;readPreferenceTags=dc:ny;readPreferenceTags= Note the empty value for the last one, which means match any secondary as a last resort. Order matters when using multiple readPreferenceTags."},"replicaSet":{"index":32,"kind":"parameter","displayName":"Replica Set","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies that the connection string provided includes multiple hosts. When specified, the driver attempts to find all members of that set."},"retryReads":{"index":33,"kind":"parameter","displayName":"Retry Reads","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies that the driver must retry supported read operations if they fail due to a network error. Default: true"},"retryWrites":{"index":34,"kind":"parameter","displayName":"Retry Writes","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies that the driver must retry supported write operations if they fail due to a network error. Default: true"},"serverSelectionTimeoutMS":{"index":35,"kind":"parameter","displayName":"Server Selection Timeout MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Specifies how long (in milliseconds) to block for server selection before throwing an exception. Default: 30,000 milliseconds."},"socketTimeoutMS":{"index":36,"kind":"parameter","displayName":"Socket Timeout MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","description":"Specifies the maximum amount of time, in milliseconds, the Java driver will wait to send or receive a request before timing out. A value of 0 instructs the driver to never time out while waiting to send or receive a request. Default: 0"},"srvMaxHosts":{"index":37,"kind":"parameter","displayName":"Srv Max Hosts","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The maximum number of hosts from the SRV record to connect to."},"srvServiceName":{"index":38,"kind":"parameter","displayName":"Srv Service Name","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"mongodb","description":"Specifies the service name of the SRV resource recordsthe driver retrieves to construct your seed list. You must use the DNS Seed List Connection Format in your connection URI to use this option. Default: mongodb"},"tls":{"index":39,"kind":"parameter","displayName":"Tls","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies that all communication with MongoDB instances should use TLS. Supersedes the ssl option. Default: false"},"tlsAllowInvalidHostnames":{"index":40,"kind":"parameter","displayName":"Tls Allow Invalid Hostnames","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies that the driver should allow invalid hostnames in the certificate for TLS connections. Supersedes sslInvalidHostNameAllowed. Has the same effect as tlsInsecure by setting tlsAllowInvalidHostnames to true. Default: false"},"waitQueueTimeoutMS":{"index":41,"kind":"parameter","displayName":"Wait Queue Timeout MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"120000","description":"Specifies the maximum amount of time, in milliseconds that a thread may wait for a connection to become available. Default: 120000 (120 seconds)"},"writeConcern":{"index":42,"kind":"parameter","displayName":"Write Concern","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["ACKNOWLEDGED","W1","W2","W3","UNACKNOWLEDGED","JOURNALED","MAJORITY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ACKNOWLEDGED","description":"Configure the connection bean with the level of acknowledgment requested from MongoDB for write operations to a standalone mongod, replicaset or cluster. Possible values are ACKNOWLEDGED, W1, W2, W3, UNACKNOWLEDGED, JOURNALED or MAJORITY."},"writeResultAsHeader":{"index":43,"kind":"parameter","displayName":"Write Result As Header","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"In write operations, it determines whether instead of returning WriteResult as the body of the OUT message, we transfer the IN message to the OUT and attach the WriteResult as a header."},"zlibCompressionLevel":{"index":44,"kind":"parameter","displayName":"Zlib Compression Level","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the degree of compression that Zlib should use to decrease the size of requests to the connected MongoDB instance. The level can range from -1 to 9, with lower values compressing faster (but resulting in larger requests) and larger values compressing slower (but resulting in smaller requests). Default: null"},"fullDocument":{"index":45,"kind":"parameter","displayName":"Full Document","group":"changeStream","label":"consumer,changeStream","required":false,"type":"object","javaType":"com.mongodb.client.model.changestream.FullDocument","enum":["default","updateLookup","required","whenAvailable"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Specifies whether changeStream consumer include a copy of the full document when modified by update operations. Possible values are default, updateLookup, required and whenAvailable."},"streamFilter":{"index":46,"kind":"parameter","displayName":"Stream Filter","group":"changeStream","label":"consumer,changeStream","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filter condition for change streams consumer."},"authSource":{"index":47,"kind":"parameter","displayName":"Auth Source","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The database name associated with the user's credentials."},"password":{"index":48,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"User password for mongodb connection"},"username":{"index":49,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Username for mongodb connection"},"persistentId":{"index":50,"kind":"parameter","displayName":"Persistent Id","group":"tail","label":"consumer,tail","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"One tail tracking collection can host many trackers for several tailable consumers. To keep them separate, each tracker should have its own unique persistentId."},"persistentTailTracking":{"index":51,"kind":"parameter","displayName":"Persistent Tail Tracking","group":"tail","label":"consumer,tail","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up, the endpoint will recover the cursor from the point where it last stopped slurping records."},"tailTrackCollection":{"index":52,"kind":"parameter","displayName":"Tail Track Collection","group":"tail","label":"consumer,tail","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Collection where tail tracking information will be persisted. If not specified, MongoDbTailTrackingConfig#DEFAULT_COLLECTION will be used by default."},"tailTrackDb":{"index":53,"kind":"parameter","displayName":"Tail Track Db","group":"tail","label":"consumer,tail","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Indicates what database the tail tracking mechanism will persist to. If not specified, the current database will be picked by default. Dynamicity will not be taken into account even if enabled, i.e., the tail tracking database will not vary past endpoint initialization."},"tailTrackField":{"index":54,"kind":"parameter","displayName":"Tail Track Field","group":"tail","label":"consumer,tail","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Field where the last tracked value will be placed. If not specified, MongoDbTailTrackingConfig#DEFAULT_FIELD will be used by default."},"tailTrackIncreasingField":{"index":55,"kind":"parameter","displayName":"Tail Track Increasing Field","group":"tail","label":"consumer,tail","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField greater than lastValue (possibly recovered from persistent tail tracking). Can be of type Integer, Date, String, etc. NOTE: No support for dot notation at the current time, so the field should be at the top level of the document."}}} +{"component":{"kind":"component","name":"mongodb","title":"MongoDB","description":"Perform operations on MongoDB documents and collections.","deprecated":false,"firstVersion":"2.19.0","label":"database","javaType":"org.apache.camel.component.mongodb.MongoDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mongodb","version":"4.8.2","scheme":"mongodb","extendsScheme":"","syntax":"mongodb:connectionBean","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelMongoDbOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.mongodb.MongoDbOperation or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation this endpoint will execute against MongoDB.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#OPERATION_HEADER"},"CamelMongoDbResultTotalSize":{"index":1,"kind":"header","displayName":"","group":"producer findAll","label":"producer findAll","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Number of objects matching the query. This does not take limit/skip into consideration.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#RESULT_TOTAL_SIZE"},"CamelMongoDbResultPageSize":{"index":2,"kind":"header","displayName":"","group":"producer findAll","label":"producer findAll","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Number of objects matching the query. This does not take limit/skip into consideration.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#RESULT_PAGE_SIZE"},"CamelMongoDbCriteria":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.bson.conversions.Bson","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query to execute against MongoDB.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#CRITERIA"},"CamelMongoDbFieldsProjection":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.bson.conversions.Bson","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project document.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#FIELDS_PROJECTION"},"CamelMongoDbBatchSize":{"index":5,"kind":"header","displayName":"","group":"producer findAll aggregate","label":"producer findAll aggregate","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of documents per batch.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#BATCH_SIZE"},"CamelMongoDbNumToSkip":{"index":6,"kind":"header","displayName":"","group":"producer findAll","label":"producer findAll","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Discards a given number of elements at the beginning of the cursor.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#NUM_TO_SKIP"},"CamelMongoDbMultiUpdate":{"index":7,"kind":"header","displayName":"","group":"producer update","label":"producer update","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the update should be applied to all objects matching. See http://www.mongodb.org/display/DOCS/AtomicOperationsAtomic Operations","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#MULTIUPDATE"},"CamelMongoDbUpsert":{"index":8,"kind":"header","displayName":"","group":"producer update","label":"producer update","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the database should create the element if it does not exist","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#UPSERT"},"CamelMongoDbRecordsAffected":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of modified or deleted records","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#RECORDS_AFFECTED"},"CamelMongoDbRecordsMatched":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of documents matched by the query.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#RECORDS_MATCHED"},"CamelMongoDbSortBy":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Bson or Document","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sort criteria.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#SORT_BY"},"CamelMongoDbDatabase":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the MongoDB database to target","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#DATABASE"},"CamelMongoDbCollection":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the MongoDB collection to bind to this endpoint","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#COLLECTION"},"CamelMongoDbCollectionIndex":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of dynamic indexes to create on the fly","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#COLLECTION_INDEX"},"CamelMongoDbLimit":{"index":15,"kind":"header","displayName":"","group":"producer findAll","label":"producer findAll","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Limits the number of elements returned.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#LIMIT"},"CamelMongoDbTailable":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is from tailable","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#FROM_TAILABLE"},"CamelMongoWriteResult":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The result of the write operation","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#WRITERESULT"},"CamelMongoOid":{"index":18,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object or List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The OID(s) of the inserted record(s)","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#OID"},"CamelMongoDbDistinctQueryField":{"index":19,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The specified field name fow which we want to get the distinct values.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#DISTINCT_QUERY_FIELD"},"CamelMongoDbAllowDiskUse":{"index":20,"kind":"header","displayName":"","group":"producer findAll aggregate","label":"producer findAll aggregate","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets allowDiskUse MongoDB flag. This is supported since MongoDB Server 4.3.1. Using this header with older MongoDB Server version can cause query to fail.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#ALLOW_DISK_USE"},"CamelMongoDbBulkOrdered":{"index":21,"kind":"header","displayName":"","group":"producer bulkWrite","label":"producer bulkWrite","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"TRUE","description":"Perform an ordered or unordered operation execution.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#BULK_ORDERED"},"_id":{"index":22,"kind":"header","displayName":"","group":"consumer changeStreams","label":"consumer changeStreams","required":false,"javaType":"org.bson.types.ObjectId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A document that contains the _id of the document created or modified by the insert, replace, delete, update operations (i.e. CRUD operations). For sharded collections, also displays the full shard key for the document. The _id field is not repeated if it is already a part of the shard key.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#MONGO_ID"},"CamelMongoDbStreamOperationType":{"index":23,"kind":"header","displayName":"","group":"consumer changeStreams","label":"consumer changeStreams","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of operation that occurred. Can be any of the following values: insert, delete, replace, update, drop, rename, dropDatabase, invalidate.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#STREAM_OPERATION_TYPE"},"CamelMongoDbReturnDocumentType":{"index":24,"kind":"header","displayName":"","group":"producer update one and return","label":"producer update one and return","required":false,"javaType":"com.mongodb.client.model.ReturnDocument","enum":["BEFORE","AFTER"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates which document to return, the document before or after an update and return atomic operation.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#RETURN_DOCUMENT"},"CamelMongoDbOperationOption":{"index":25,"kind":"header","displayName":"","group":"producer update one and options","label":"producer update one and options","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Options to use. When set, options set in the headers will be ignored.","constantName":"org.apache.camel.component.mongodb.MongoDbConstants#OPTIONS"}},"properties":{"connectionBean":{"index":0,"kind":"path","displayName":"Connection Bean","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the connection bean reference used to lookup a client for connecting to a database if no hosts parameter is present."},"collection":{"index":1,"kind":"parameter","displayName":"Collection","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of the MongoDB collection to bind to this endpoint"},"collectionIndex":{"index":2,"kind":"parameter","displayName":"Collection Index","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the collection index (JSON FORMAT : { field1 : order1, field2 : order2})"},"connectionUriString":{"index":3,"kind":"parameter","displayName":"Connection Uri String","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Set the whole Connection String/Uri for mongodb endpoint."},"createCollection":{"index":4,"kind":"parameter","displayName":"Create Collection","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Create the collection during initialisation if it doesn't exist. Default is true."},"database":{"index":5,"kind":"parameter","displayName":"Database","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of the MongoDB database to target"},"hosts":{"index":6,"kind":"parameter","displayName":"Hosts","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Host address of mongodb server in host:port format. It's possible to also use more than one address, as a comma separated list of hosts: host1:port1,host2:port2. If this parameter is specified, the provided connectionBean is ignored."},"mongoConnection":{"index":7,"kind":"parameter","displayName":"Mongo Connection","group":"common","label":"","required":false,"type":"object","javaType":"com.mongodb.client.MongoClient","deprecated":false,"autowired":false,"secret":false,"description":"Sets the connection bean used as a client for connecting to a database."},"operation":{"index":8,"kind":"parameter","displayName":"Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.mongodb.MongoDbOperation","enum":["findById","findOneAndDelete","findOneAndReplace","findOneAndUpdate","findOneByQuery","findAll","findDistinct","insert","save","update","remove","bulkWrite","aggregate","getDbStats","getColStats","count","command"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the operation this endpoint will execute against MongoDB."},"outputType":{"index":9,"kind":"parameter","displayName":"Output Type","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.component.mongodb.MongoDbOutputType","enum":["DocumentList","Document","MongoIterable"],"deprecated":false,"autowired":false,"secret":false,"description":"Convert the output of the producer to the selected type: DocumentList Document or MongoIterable. DocumentList or MongoIterable applies to findAll and aggregate. Document applies to all other operations."},"consumerType":{"index":10,"kind":"parameter","displayName":"Consumer Type","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Consumer type."},"bridgeErrorHandler":{"index":11,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":12,"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":{"index":13,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":14,"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."},"appName":{"index":15,"kind":"parameter","displayName":"App Name","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the logical name of the application. The application name may be used by the client to identify the application to the server, for use in server logs, slow query logs, and profile collection. Default: null"},"compressors":{"index":16,"kind":"parameter","displayName":"Compressors","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies one or more compression algorithms that the driver will attempt to use to compress requests sent to the connected MongoDB instance. Possible values include: zlib, snappy, and zstd. Default: null"},"connectTimeoutMS":{"index":17,"kind":"parameter","displayName":"Connect Timeout MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","description":"Specifies the maximum amount of time, in milliseconds, the Java driver waits for a connection to open before timing out. A value of 0 instructs the driver to never time out while waiting for a connection to open. Default: 10000 (10 seconds)"},"cursorRegenerationDelay":{"index":18,"kind":"parameter","displayName":"Cursor Regeneration Delay","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"MongoDB tailable cursors will block until new data arrives. If no new data is inserted, after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor, and if the attempt fails, how long before the next attempt is made. Default value is 1000ms."},"directConnection":{"index":19,"kind":"parameter","displayName":"Direct Connection","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies that the driver must connect to the host directly. Default: false"},"dynamicity":{"index":20,"kind":"parameter","displayName":"Dynamicity","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit."},"heartbeatFrequencyMS":{"index":21,"kind":"parameter","displayName":"Heartbeat Frequency MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"heartbeatFrequencyMS controls when the driver checks the state of the MongoDB deployment. Specify the interval (in milliseconds) between checks, counted from the end of the previous check until the beginning of the next one. Default: Single-threaded drivers: 60 seconds. Multithreaded drivers: 10 seconds."},"loadBalanced":{"index":22,"kind":"parameter","displayName":"Load Balanced","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true the driver will assume that it's connecting to MongoDB through a load balancer."},"localThresholdMS":{"index":23,"kind":"parameter","displayName":"Local Threshold MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"15","description":"The size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances. Default: 15 milliseconds."},"maxConnecting":{"index":24,"kind":"parameter","displayName":"Max Connecting","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2","description":"Specifies the maximum number of connections a pool may be establishing concurrently. Default: 2"},"maxIdleTimeMS":{"index":25,"kind":"parameter","displayName":"Max Idle Time MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","description":"Specifies the maximum amount of time, in milliseconds, the Java driver will allow a pooled connection to idle before closing the connection. A value of 0 indicates that there is no upper bound on how long the driver can allow a pooled collection to be idle. Default: 0"},"maxLifeTimeMS":{"index":26,"kind":"parameter","displayName":"Max Life Time MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","description":"Specifies the maximum amount of time, in milliseconds, the Java driver will continue to use a pooled connection before closing the connection. A value of 0 indicates that there is no upper bound on how long the driver can keep a pooled connection open. Default: 0"},"maxPoolSize":{"index":27,"kind":"parameter","displayName":"Max Pool Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","description":"The maximum number of connections in the connection pool. The default value is 100."},"maxStalenessSeconds":{"index":28,"kind":"parameter","displayName":"Max Staleness Seconds","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"-1","description":"Specifies, in seconds, how stale a secondary can be before the driver stops communicating with that secondary. The minimum value is either 90 seconds or the heartbeat frequency plus 10 seconds, whichever is greater. For more information, see the server documentation for the maxStalenessSeconds option. Not providing a parameter or explicitly specifying -1 indicates that there should be no staleness check for secondaries. Default: -1"},"minPoolSize":{"index":29,"kind":"parameter","displayName":"Min Pool Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","description":"Specifies the minimum number of connections that must exist at any moment in a single connection pool. Default: 0"},"readPreference":{"index":30,"kind":"parameter","displayName":"Read Preference","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["PRIMARY","PRIMARY_PREFERRED","SECONDARY","SECONDARY_PREFERRED","NEAREST"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PRIMARY","description":"Configure how MongoDB clients route read operations to the members of a replica set. Possible values are PRIMARY, PRIMARY_PREFERRED, SECONDARY, SECONDARY_PREFERRED or NEAREST"},"readPreferenceTags":{"index":31,"kind":"parameter","displayName":"Read Preference Tags","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"A representation of a tag set as a comma-separated list of colon-separated key-value pairs, e.g. dc:ny,rack:1. Spaces are stripped from the beginning and end of all keys and values. To specify a list of tag sets, using multiple readPreferenceTags, e.g., readPreferenceTags=dc:ny,rack:1;readPreferenceTags=dc:ny;readPreferenceTags= Note the empty value for the last one, which means match any secondary as a last resort. Order matters when using multiple readPreferenceTags."},"replicaSet":{"index":32,"kind":"parameter","displayName":"Replica Set","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies that the connection string provided includes multiple hosts. When specified, the driver attempts to find all members of that set."},"retryReads":{"index":33,"kind":"parameter","displayName":"Retry Reads","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies that the driver must retry supported read operations if they fail due to a network error. Default: true"},"retryWrites":{"index":34,"kind":"parameter","displayName":"Retry Writes","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies that the driver must retry supported write operations if they fail due to a network error. Default: true"},"serverSelectionTimeoutMS":{"index":35,"kind":"parameter","displayName":"Server Selection Timeout MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Specifies how long (in milliseconds) to block for server selection before throwing an exception. Default: 30,000 milliseconds."},"socketTimeoutMS":{"index":36,"kind":"parameter","displayName":"Socket Timeout MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0","description":"Specifies the maximum amount of time, in milliseconds, the Java driver will wait to send or receive a request before timing out. A value of 0 instructs the driver to never time out while waiting to send or receive a request. Default: 0"},"srvMaxHosts":{"index":37,"kind":"parameter","displayName":"Srv Max Hosts","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The maximum number of hosts from the SRV record to connect to."},"srvServiceName":{"index":38,"kind":"parameter","displayName":"Srv Service Name","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"mongodb","description":"Specifies the service name of the SRV resource recordsthe driver retrieves to construct your seed list. You must use the DNS Seed List Connection Format in your connection URI to use this option. Default: mongodb"},"tls":{"index":39,"kind":"parameter","displayName":"Tls","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies that all communication with MongoDB instances should use TLS. Supersedes the ssl option. Default: false"},"tlsAllowInvalidHostnames":{"index":40,"kind":"parameter","displayName":"Tls Allow Invalid Hostnames","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies that the driver should allow invalid hostnames in the certificate for TLS connections. Supersedes sslInvalidHostNameAllowed. Has the same effect as tlsInsecure by setting tlsAllowInvalidHostnames to true. Default: false"},"waitQueueTimeoutMS":{"index":41,"kind":"parameter","displayName":"Wait Queue Timeout MS","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"120000","description":"Specifies the maximum amount of time, in milliseconds that a thread may wait for a connection to become available. Default: 120000 (120 seconds)"},"writeConcern":{"index":42,"kind":"parameter","displayName":"Write Concern","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["ACKNOWLEDGED","W1","W2","W3","UNACKNOWLEDGED","JOURNALED","MAJORITY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ACKNOWLEDGED","description":"Configure the connection bean with the level of acknowledgment requested from MongoDB for write operations to a standalone mongod, replicaset or cluster. Possible values are ACKNOWLEDGED, W1, W2, W3, UNACKNOWLEDGED, JOURNALED or MAJORITY."},"writeResultAsHeader":{"index":43,"kind":"parameter","displayName":"Write Result As Header","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"In write operations, it determines whether instead of returning WriteResult as the body of the OUT message, we transfer the IN message to the OUT and attach the WriteResult as a header."},"zlibCompressionLevel":{"index":44,"kind":"parameter","displayName":"Zlib Compression Level","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the degree of compression that Zlib should use to decrease the size of requests to the connected MongoDB instance. The level can range from -1 to 9, with lower values compressing faster (but resulting in larger requests) and larger values compressing slower (but resulting in smaller requests). Default: null"},"fullDocument":{"index":45,"kind":"parameter","displayName":"Full Document","group":"changeStream","label":"consumer,changeStream","required":false,"type":"object","javaType":"com.mongodb.client.model.changestream.FullDocument","enum":["default","updateLookup","required","whenAvailable"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Specifies whether changeStream consumer include a copy of the full document when modified by update operations. Possible values are default, updateLookup, required and whenAvailable."},"streamFilter":{"index":46,"kind":"parameter","displayName":"Stream Filter","group":"changeStream","label":"consumer,changeStream","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filter condition for change streams consumer."},"authSource":{"index":47,"kind":"parameter","displayName":"Auth Source","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The database name associated with the user's credentials."},"password":{"index":48,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"User password for mongodb connection"},"username":{"index":49,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Username for mongodb connection"},"persistentId":{"index":50,"kind":"parameter","displayName":"Persistent Id","group":"tail","label":"consumer,tail","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"One tail tracking collection can host many trackers for several tailable consumers. To keep them separate, each tracker should have its own unique persistentId."},"persistentTailTracking":{"index":51,"kind":"parameter","displayName":"Persistent Tail Tracking","group":"tail","label":"consumer,tail","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up, the endpoint will recover the cursor from the point where it last stopped slurping records."},"tailTrackCollection":{"index":52,"kind":"parameter","displayName":"Tail Track Collection","group":"tail","label":"consumer,tail","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Collection where tail tracking information will be persisted. If not specified, MongoDbTailTrackingConfig#DEFAULT_COLLECTION will be used by default."},"tailTrackDb":{"index":53,"kind":"parameter","displayName":"Tail Track Db","group":"tail","label":"consumer,tail","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Indicates what database the tail tracking mechanism will persist to. If not specified, the current database will be picked by default. Dynamicity will not be taken into account even if enabled, i.e., the tail tracking database will not vary past endpoint initialization."},"tailTrackField":{"index":54,"kind":"parameter","displayName":"Tail Track Field","group":"tail","label":"consumer,tail","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Field where the last tracked value will be placed. If not specified, MongoDbTailTrackingConfig#DEFAULT_FIELD will be used by default."},"tailTrackIncreasingField":{"index":55,"kind":"parameter","displayName":"Tail Track Increasing Field","group":"tail","label":"consumer,tail","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField greater than lastValue (possibly recovered from persistent tail tracking). Can be of type Integer, Date, String, etc. NOTE: No support for dot notation at the current time, so the field should be at the top level of the document."}}} , -{"component":{"kind":"component","name":"mongodb-gridfs","title":"MongoDB GridFS","description":"Interact with MongoDB GridFS.","deprecated":false,"firstVersion":"2.18.0","label":"database,file","javaType":"org.apache.camel.component.mongodb.gridfs.GridFsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mongodb-gridfs","version":"4.8.1","scheme":"mongodb-gridfs","extendsScheme":"","syntax":"mongodb-gridfs:connectionBean","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelFileContentType":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type of the file.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#FILE_CONTENT_TYPE"},"CamelFileLength":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the file.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#FILE_LENGTH"},"CamelFileLastModified":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the file.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#FILE_LAST_MODIFIED"},"CamelFileName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the file.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#FILE_NAME"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type of the file.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#CONTENT_TYPE"},"CamelFileNameProduced":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The file name produced.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#FILE_NAME_PRODUCED"},"gridfs.metadata":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Any additional metadata stored along with the file in JSON format.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#GRIDFS_METADATA"},"gridfs.operation":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#GRIDFS_OPERATION"},"gridfs.chunksize":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of bytes per chunk for the uploaded file.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#GRIDFS_CHUNKSIZE"},"gridfs.fileid":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.bson.types.ObjectId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ObjectId of the file produced","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#GRIDFS_FILE_ID_PRODUCED"},"gridfs.objectid":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.bson.types.ObjectId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ObjectId of the file.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#GRIDFS_OBJECT_ID"}},"properties":{"connectionBean":{"index":0,"kind":"path","displayName":"Connection Bean","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of com.mongodb.client.MongoClient to use."},"bucket":{"index":1,"kind":"parameter","displayName":"Bucket","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fs","description":"Sets the name of the GridFS bucket within the database. Default is fs."},"database":{"index":2,"kind":"parameter","displayName":"Database","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the name of the MongoDB database to target"},"readPreference":{"index":3,"kind":"parameter","displayName":"Read Preference","group":"common","label":"","required":false,"type":"object","javaType":"com.mongodb.ReadPreference","deprecated":false,"autowired":false,"secret":false,"description":"Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The com.mongodb.ReadPreference#valueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest, primary or secondary etc."},"writeConcern":{"index":4,"kind":"parameter","displayName":"Write Concern","group":"common","label":"","required":false,"type":"object","javaType":"com.mongodb.WriteConcern","enum":["ACKNOWLEDGED","W1","W2","W3","UNACKNOWLEDGED","JOURNALED","MAJORITY"],"deprecated":false,"autowired":false,"secret":false,"description":"Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the WriteConcern#valueOf(String) method."},"delay":{"index":5,"kind":"parameter","displayName":"Delay","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500","description":"Sets the delay between polls within the Consumer. Default is 500ms"},"fileAttributeName":{"index":6,"kind":"parameter","displayName":"File Attribute Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel-processed","description":"If the QueryType uses a FileAttribute, this sets the name of the attribute that is used. Default is camel-processed."},"initialDelay":{"index":7,"kind":"parameter","displayName":"Initial Delay","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Sets the initialDelay before the consumer will start polling. Default is 1000ms"},"persistentTSCollection":{"index":8,"kind":"parameter","displayName":"Persistent TSCollection","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel-timestamps","description":"If the QueryType uses a persistent timestamp, this sets the name of the collection within the DB to store the timestamp."},"persistentTSObject":{"index":9,"kind":"parameter","displayName":"Persistent TSObject","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel-timestamp","description":"If the QueryType uses a persistent timestamp, this is the ID of the object in the collection to store the timestamp."},"query":{"index":10,"kind":"parameter","displayName":"Query","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Additional query parameters (in JSON) that are used to configure the query used for finding files in the GridFsConsumer"},"queryStrategy":{"index":11,"kind":"parameter","displayName":"Query Strategy","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.mongodb.gridfs.QueryStrategy","enum":["TimeStamp","PersistentTimestamp","FileAttribute","TimeStampAndFileAttribute","PersistentTimestampAndFileAttribute"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TimeStamp","description":"Sets the QueryStrategy that is used for polling for new files. Default is Timestamp"},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":15,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the operation this endpoint will execute against GridFs."},"lazyStartProducer":{"index":16,"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."}}} +{"component":{"kind":"component","name":"mongodb-gridfs","title":"MongoDB GridFS","description":"Interact with MongoDB GridFS.","deprecated":false,"firstVersion":"2.18.0","label":"database,file","javaType":"org.apache.camel.component.mongodb.gridfs.GridFsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mongodb-gridfs","version":"4.8.2","scheme":"mongodb-gridfs","extendsScheme":"","syntax":"mongodb-gridfs:connectionBean","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelFileContentType":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type of the file.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#FILE_CONTENT_TYPE"},"CamelFileLength":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the file.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#FILE_LENGTH"},"CamelFileLastModified":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the file.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#FILE_LAST_MODIFIED"},"CamelFileName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the file.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#FILE_NAME"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type of the file.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#CONTENT_TYPE"},"CamelFileNameProduced":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The file name produced.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#FILE_NAME_PRODUCED"},"gridfs.metadata":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Any additional metadata stored along with the file in JSON format.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#GRIDFS_METADATA"},"gridfs.operation":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#GRIDFS_OPERATION"},"gridfs.chunksize":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of bytes per chunk for the uploaded file.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#GRIDFS_CHUNKSIZE"},"gridfs.fileid":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.bson.types.ObjectId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ObjectId of the file produced","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#GRIDFS_FILE_ID_PRODUCED"},"gridfs.objectid":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.bson.types.ObjectId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ObjectId of the file.","constantName":"org.apache.camel.component.mongodb.gridfs.GridFsConstants#GRIDFS_OBJECT_ID"}},"properties":{"connectionBean":{"index":0,"kind":"path","displayName":"Connection Bean","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of com.mongodb.client.MongoClient to use."},"bucket":{"index":1,"kind":"parameter","displayName":"Bucket","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"fs","description":"Sets the name of the GridFS bucket within the database. Default is fs."},"database":{"index":2,"kind":"parameter","displayName":"Database","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the name of the MongoDB database to target"},"readPreference":{"index":3,"kind":"parameter","displayName":"Read Preference","group":"common","label":"","required":false,"type":"object","javaType":"com.mongodb.ReadPreference","deprecated":false,"autowired":false,"secret":false,"description":"Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The com.mongodb.ReadPreference#valueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest, primary or secondary etc."},"writeConcern":{"index":4,"kind":"parameter","displayName":"Write Concern","group":"common","label":"","required":false,"type":"object","javaType":"com.mongodb.WriteConcern","enum":["ACKNOWLEDGED","W1","W2","W3","UNACKNOWLEDGED","JOURNALED","MAJORITY"],"deprecated":false,"autowired":false,"secret":false,"description":"Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the WriteConcern#valueOf(String) method."},"delay":{"index":5,"kind":"parameter","displayName":"Delay","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500","description":"Sets the delay between polls within the Consumer. Default is 500ms"},"fileAttributeName":{"index":6,"kind":"parameter","displayName":"File Attribute Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel-processed","description":"If the QueryType uses a FileAttribute, this sets the name of the attribute that is used. Default is camel-processed."},"initialDelay":{"index":7,"kind":"parameter","displayName":"Initial Delay","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Sets the initialDelay before the consumer will start polling. Default is 1000ms"},"persistentTSCollection":{"index":8,"kind":"parameter","displayName":"Persistent TSCollection","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel-timestamps","description":"If the QueryType uses a persistent timestamp, this sets the name of the collection within the DB to store the timestamp."},"persistentTSObject":{"index":9,"kind":"parameter","displayName":"Persistent TSObject","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel-timestamp","description":"If the QueryType uses a persistent timestamp, this is the ID of the object in the collection to store the timestamp."},"query":{"index":10,"kind":"parameter","displayName":"Query","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Additional query parameters (in JSON) that are used to configure the query used for finding files in the GridFsConsumer"},"queryStrategy":{"index":11,"kind":"parameter","displayName":"Query Strategy","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.mongodb.gridfs.QueryStrategy","enum":["TimeStamp","PersistentTimestamp","FileAttribute","TimeStampAndFileAttribute","PersistentTimestampAndFileAttribute"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TimeStamp","description":"Sets the QueryStrategy that is used for polling for new files. Default is Timestamp"},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":15,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the operation this endpoint will execute against GridFs."},"lazyStartProducer":{"index":16,"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."}}} , -{"component":{"kind":"component","name":"mustache","title":"Mustache","description":"Transform messages using a Mustache template.","deprecated":false,"firstVersion":"2.12.0","label":"transformation","javaType":"org.apache.camel.component.mustache.MustacheComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mustache","version":"4.8.1","scheme":"mustache","extendsScheme":"","syntax":"mustache:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"MustacheResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to use instead of the endpoint.","constantName":"org.apache.camel.component.mustache.MustacheConstants#MUSTACHE_RESOURCE_URI"},"MustacheTemplate":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.mustache.MustacheConstants#MUSTACHE_TEMPLATE"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"encoding":{"index":4,"kind":"parameter","displayName":"Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Character encoding of the resource content."},"endDelimiter":{"index":5,"kind":"parameter","displayName":"End Delimiter","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"}}","description":"Characters used to mark template code end."},"startDelimiter":{"index":6,"kind":"parameter","displayName":"Start Delimiter","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"{{","description":"Characters used to mark template code beginning."},"lazyStartProducer":{"index":7,"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."}}} +{"component":{"kind":"component","name":"mustache","title":"Mustache","description":"Transform messages using a Mustache template.","deprecated":false,"firstVersion":"2.12.0","label":"transformation","javaType":"org.apache.camel.component.mustache.MustacheComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mustache","version":"4.8.2","scheme":"mustache","extendsScheme":"","syntax":"mustache:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"MustacheResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to use instead of the endpoint.","constantName":"org.apache.camel.component.mustache.MustacheConstants#MUSTACHE_RESOURCE_URI"},"MustacheTemplate":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.mustache.MustacheConstants#MUSTACHE_TEMPLATE"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"encoding":{"index":4,"kind":"parameter","displayName":"Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Character encoding of the resource content."},"endDelimiter":{"index":5,"kind":"parameter","displayName":"End Delimiter","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"}}","description":"Characters used to mark template code end."},"startDelimiter":{"index":6,"kind":"parameter","displayName":"Start Delimiter","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"{{","description":"Characters used to mark template code beginning."},"lazyStartProducer":{"index":7,"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."}}} , -{"component":{"kind":"component","name":"mvel","title":"MVEL","description":"Transform messages using an MVEL template.","deprecated":false,"firstVersion":"2.12.0","label":"transformation,script","javaType":"org.apache.camel.component.mvel.MvelComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mvel","version":"4.8.1","scheme":"mvel","extendsScheme":"","syntax":"mvel:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelMvelResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to use instead of the endpoint configured.","constantName":"org.apache.camel.component.mvel.MvelConstants#MVEL_RESOURCE_URI"},"CamelMvelTemplate":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.mvel.MvelConstants#MVEL_TEMPLATE"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"encoding":{"index":4,"kind":"parameter","displayName":"Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Character encoding of the resource content."},"lazyStartProducer":{"index":5,"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."}}} +{"component":{"kind":"component","name":"mvel","title":"MVEL","description":"Transform messages using an MVEL template.","deprecated":false,"firstVersion":"2.12.0","label":"transformation,script","javaType":"org.apache.camel.component.mvel.MvelComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mvel","version":"4.8.2","scheme":"mvel","extendsScheme":"","syntax":"mvel:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelMvelResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to use instead of the endpoint configured.","constantName":"org.apache.camel.component.mvel.MvelConstants#MVEL_RESOURCE_URI"},"CamelMvelTemplate":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.mvel.MvelConstants#MVEL_TEMPLATE"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"encoding":{"index":4,"kind":"parameter","displayName":"Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Character encoding of the resource content."},"lazyStartProducer":{"index":5,"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."}}} , -{"component":{"kind":"component","name":"mybatis","title":"MyBatis","description":"Performs a query, poll, insert, update or delete in a relational database using MyBatis.","deprecated":false,"firstVersion":"2.7.0","label":"database","javaType":"org.apache.camel.component.mybatis.MyBatisComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mybatis","version":"4.8.1","scheme":"mybatis","extendsScheme":"","syntax":"mybatis:statement","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelMyBatisResult":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response returned from MtBatis in any of the operations. For instance an INSERT could return the auto-generated key, or number of rows etc.","constantName":"org.apache.camel.component.mybatis.MyBatisConstants#MYBATIS_RESULT"},"CamelMyBatisStatementName":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The statementName used (for example: insertAccount).","constantName":"org.apache.camel.component.mybatis.MyBatisConstants#MYBATIS_STATEMENT_NAME"}},"properties":{"statement":{"index":0,"kind":"path","displayName":"Statement","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The statement name in the MyBatis XML mapping file which maps to the query, insert, update or delete operation you wish to evaluate."},"maxMessagesPerPoll":{"index":1,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges. This integer defines the maximum messages to deliver in single exchange. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disable it."},"onConsume":{"index":2,"kind":"parameter","displayName":"On Consume","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Statement to run after data has been processed in the route"},"routeEmptyResultSet":{"index":3,"kind":"parameter","displayName":"Route Empty Result Set","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether allow empty resultset to be routed to the next hop"},"sendEmptyMessageWhenIdle":{"index":4,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"transacted":{"index":5,"kind":"parameter","displayName":"Transacted","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enables or disables transaction. If enabled then if processing an exchange failed then the consumer breaks out processing any further exchanges to cause a rollback eager."},"useIterator":{"index":6,"kind":"parameter","displayName":"Use Iterator","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Process resultset individually or as a list"},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":10,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"processingStrategy":{"index":11,"kind":"parameter","displayName":"Processing Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mybatis.MyBatisProcessingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom MyBatisProcessingStrategy"},"executorType":{"index":12,"kind":"parameter","displayName":"Executor Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.ibatis.session.ExecutorType","enum":["SIMPLE","REUSE","BATCH"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SIMPLE","description":"The executor type to be used while executing statements. simple - executor does nothing special. reuse - executor reuses prepared statements. batch - executor reuses statements and batches updates."},"inputHeader":{"index":13,"kind":"parameter","displayName":"Input Header","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"User the header value for input parameters instead of the message body. By default, inputHeader == null and the input parameters are taken from the message body. If outputHeader is set, the value is used and query parameters will be taken from the header instead of the body."},"outputHeader":{"index":14,"kind":"parameter","displayName":"Output Header","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Store the query result in a header instead of the message body. By default, outputHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If outputHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. Setting outputHeader will also omit populating the default CamelMyBatisResult header since it would be the same as outputHeader all the time."},"statementType":{"index":15,"kind":"parameter","displayName":"Statement Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.mybatis.StatementType","enum":["SelectOne","SelectList","Insert","InsertList","Update","UpdateList","Delete","DeleteList"],"deprecated":false,"autowired":false,"secret":false,"description":"Mandatory to specify for the producer to control which kind of operation to invoke."},"lazyStartProducer":{"index":16,"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."},"backoffErrorThreshold":{"index":17,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":18,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":19,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":20,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":21,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":22,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":23,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":24,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":25,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":26,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":27,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":28,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":29,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":30,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} +{"component":{"kind":"component","name":"mybatis","title":"MyBatis","description":"Performs a query, poll, insert, update or delete in a relational database using MyBatis.","deprecated":false,"firstVersion":"2.7.0","label":"database","javaType":"org.apache.camel.component.mybatis.MyBatisComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mybatis","version":"4.8.2","scheme":"mybatis","extendsScheme":"","syntax":"mybatis:statement","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelMyBatisResult":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response returned from MtBatis in any of the operations. For instance an INSERT could return the auto-generated key, or number of rows etc.","constantName":"org.apache.camel.component.mybatis.MyBatisConstants#MYBATIS_RESULT"},"CamelMyBatisStatementName":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The statementName used (for example: insertAccount).","constantName":"org.apache.camel.component.mybatis.MyBatisConstants#MYBATIS_STATEMENT_NAME"}},"properties":{"statement":{"index":0,"kind":"path","displayName":"Statement","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The statement name in the MyBatis XML mapping file which maps to the query, insert, update or delete operation you wish to evaluate."},"maxMessagesPerPoll":{"index":1,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges. This integer defines the maximum messages to deliver in single exchange. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disable it."},"onConsume":{"index":2,"kind":"parameter","displayName":"On Consume","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Statement to run after data has been processed in the route"},"routeEmptyResultSet":{"index":3,"kind":"parameter","displayName":"Route Empty Result Set","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether allow empty resultset to be routed to the next hop"},"sendEmptyMessageWhenIdle":{"index":4,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"transacted":{"index":5,"kind":"parameter","displayName":"Transacted","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enables or disables transaction. If enabled then if processing an exchange failed then the consumer breaks out processing any further exchanges to cause a rollback eager."},"useIterator":{"index":6,"kind":"parameter","displayName":"Use Iterator","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Process resultset individually or as a list"},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":10,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"processingStrategy":{"index":11,"kind":"parameter","displayName":"Processing Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mybatis.MyBatisProcessingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom MyBatisProcessingStrategy"},"executorType":{"index":12,"kind":"parameter","displayName":"Executor Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.ibatis.session.ExecutorType","enum":["SIMPLE","REUSE","BATCH"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SIMPLE","description":"The executor type to be used while executing statements. simple - executor does nothing special. reuse - executor reuses prepared statements. batch - executor reuses statements and batches updates."},"inputHeader":{"index":13,"kind":"parameter","displayName":"Input Header","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"User the header value for input parameters instead of the message body. By default, inputHeader == null and the input parameters are taken from the message body. If outputHeader is set, the value is used and query parameters will be taken from the header instead of the body."},"outputHeader":{"index":14,"kind":"parameter","displayName":"Output Header","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Store the query result in a header instead of the message body. By default, outputHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If outputHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. Setting outputHeader will also omit populating the default CamelMyBatisResult header since it would be the same as outputHeader all the time."},"statementType":{"index":15,"kind":"parameter","displayName":"Statement Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.mybatis.StatementType","enum":["SelectOne","SelectList","Insert","InsertList","Update","UpdateList","Delete","DeleteList"],"deprecated":false,"autowired":false,"secret":false,"description":"Mandatory to specify for the producer to control which kind of operation to invoke."},"lazyStartProducer":{"index":16,"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."},"backoffErrorThreshold":{"index":17,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":18,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":19,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":20,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":21,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":22,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":23,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":24,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":25,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":26,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":27,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":28,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":29,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":30,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} , -{"component":{"kind":"component","name":"mybatis-bean","title":"MyBatis Bean","description":"Perform queries, inserts, updates or deletes in a relational database using MyBatis.","deprecated":false,"firstVersion":"2.22.0","label":"database","javaType":"org.apache.camel.component.mybatis.MyBatisBeanComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mybatis","version":"4.8.1","scheme":"mybatis-bean","extendsScheme":"","syntax":"mybatis-bean:beanName:methodName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelMyBatisResult":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response returned from MtBatis in any of the operations. For instance an INSERT could return the auto-generated key, or number of rows etc.","constantName":"org.apache.camel.component.mybatis.MyBatisConstants#MYBATIS_RESULT"}},"properties":{"beanName":{"index":0,"kind":"path","displayName":"Bean Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the bean with the MyBatis annotations. This can either by a type alias or a FQN class name."},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the method on the bean that has the SQL query to be executed."},"executorType":{"index":2,"kind":"parameter","displayName":"Executor Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.ibatis.session.ExecutorType","enum":["SIMPLE","REUSE","BATCH"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SIMPLE","description":"The executor type to be used while executing statements. simple - executor does nothing special. reuse - executor reuses prepared statements. batch - executor reuses statements and batches updates."},"inputHeader":{"index":3,"kind":"parameter","displayName":"Input Header","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"User the header value for input parameters instead of the message body. By default, inputHeader == null and the input parameters are taken from the message body. If outputHeader is set, the value is used and query parameters will be taken from the header instead of the body."},"outputHeader":{"index":4,"kind":"parameter","displayName":"Output Header","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Store the query result in a header instead of the message body. By default, outputHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If outputHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. Setting outputHeader will also omit populating the default CamelMyBatisResult header since it would be the same as outputHeader all the time."},"lazyStartProducer":{"index":5,"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."}}} +{"component":{"kind":"component","name":"mybatis-bean","title":"MyBatis Bean","description":"Perform queries, inserts, updates or deletes in a relational database using MyBatis.","deprecated":false,"firstVersion":"2.22.0","label":"database","javaType":"org.apache.camel.component.mybatis.MyBatisBeanComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mybatis","version":"4.8.2","scheme":"mybatis-bean","extendsScheme":"","syntax":"mybatis-bean:beanName:methodName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelMyBatisResult":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response returned from MtBatis in any of the operations. For instance an INSERT could return the auto-generated key, or number of rows etc.","constantName":"org.apache.camel.component.mybatis.MyBatisConstants#MYBATIS_RESULT"}},"properties":{"beanName":{"index":0,"kind":"path","displayName":"Bean Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the bean with the MyBatis annotations. This can either by a type alias or a FQN class name."},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the method on the bean that has the SQL query to be executed."},"executorType":{"index":2,"kind":"parameter","displayName":"Executor Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.ibatis.session.ExecutorType","enum":["SIMPLE","REUSE","BATCH"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SIMPLE","description":"The executor type to be used while executing statements. simple - executor does nothing special. reuse - executor reuses prepared statements. batch - executor reuses statements and batches updates."},"inputHeader":{"index":3,"kind":"parameter","displayName":"Input Header","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"User the header value for input parameters instead of the message body. By default, inputHeader == null and the input parameters are taken from the message body. If outputHeader is set, the value is used and query parameters will be taken from the header instead of the body."},"outputHeader":{"index":4,"kind":"parameter","displayName":"Output Header","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Store the query result in a header instead of the message body. By default, outputHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If outputHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. Setting outputHeader will also omit populating the default CamelMyBatisResult header since it would be the same as outputHeader all the time."},"lazyStartProducer":{"index":5,"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."}}} , -{"component":{"kind":"component","name":"nats","title":"Nats","description":"Send and receive messages from NATS messaging system.","deprecated":false,"firstVersion":"2.17.0","label":"messaging","javaType":"org.apache.camel.component.nats.NatsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-nats","version":"4.8.1","scheme":"nats","extendsScheme":"","syntax":"nats:topic","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelNatsMessageTimestamp":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of a consumed message.","constantName":"org.apache.camel.component.nats.NatsConstants#NATS_MESSAGE_TIMESTAMP"},"CamelNatsSID":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SID of a consumed message.","constantName":"org.apache.camel.component.nats.NatsConstants#NATS_SID"},"CamelNatsReplyTo":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ReplyTo of a consumed message (may be null).","constantName":"org.apache.camel.component.nats.NatsConstants#NATS_REPLY_TO"},"CamelNatsSubject":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Subject of a consumed message.","constantName":"org.apache.camel.component.nats.NatsConstants#NATS_SUBJECT"},"CamelNatsQueueName":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Queue name of a consumed message (may be null).","constantName":"org.apache.camel.component.nats.NatsConstants#NATS_QUEUE_NAME"}},"properties":{"topic":{"index":0,"kind":"path","displayName":"Topic","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"The name of topic we want to use"},"connectionTimeout":{"index":1,"kind":"parameter","displayName":"Connection Timeout","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2000,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Timeout for connection attempts. (in milliseconds)"},"flushConnection":{"index":2,"kind":"parameter","displayName":"Flush Connection","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Define if we want to flush connection when stopping or not"},"flushTimeout":{"index":3,"kind":"parameter","displayName":"Flush Timeout","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Set the flush timeout (in milliseconds)"},"maxPingsOut":{"index":4,"kind":"parameter","displayName":"Max Pings Out","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"maximum number of pings have not received a response allowed by the client"},"maxReconnectAttempts":{"index":5,"kind":"parameter","displayName":"Max Reconnect Attempts","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Max reconnection attempts"},"noEcho":{"index":6,"kind":"parameter","displayName":"No Echo","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Turn off echo. If supported by the gnatsd version you are connecting to this flag will prevent the server from echoing messages back to the connection if it has subscriptions on the subject being published to."},"noRandomizeServers":{"index":7,"kind":"parameter","displayName":"No Randomize Servers","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Whether or not randomizing the order of servers for the connection attempts"},"pedantic":{"index":8,"kind":"parameter","displayName":"Pedantic","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Whether or not running in pedantic mode (this affects performance)"},"pingInterval":{"index":9,"kind":"parameter","displayName":"Ping Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":120000,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Ping interval to be aware if connection is still alive (in milliseconds)"},"reconnect":{"index":10,"kind":"parameter","displayName":"Reconnect","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Whether or not using reconnection feature"},"reconnectTimeWait":{"index":11,"kind":"parameter","displayName":"Reconnect Time Wait","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2000,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Waiting time before attempts reconnection (in milliseconds)"},"requestCleanupInterval":{"index":12,"kind":"parameter","displayName":"Request Cleanup Interval","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Interval to clean up cancelled/timed out requests."},"servers":{"index":13,"kind":"parameter","displayName":"Servers","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"URLs to one or more NAT servers. Use comma to separate URLs when specifying multiple servers."},"verbose":{"index":14,"kind":"parameter","displayName":"Verbose","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Whether or not running in verbose mode"},"maxMessages":{"index":15,"kind":"parameter","displayName":"Max Messages","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Stop receiving messages from a topic we are subscribing to after maxMessages"},"poolSize":{"index":16,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Consumer thread pool size (default is 10)"},"queueName":{"index":17,"kind":"parameter","displayName":"Queue Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"The Queue name if we are using nats for a queue configuration"},"replyToDisabled":{"index":18,"kind":"parameter","displayName":"Reply To Disabled","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Can be used to turn off sending back reply message in the consumer."},"bridgeErrorHandler":{"index":19,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":20,"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":{"index":21,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"replySubject":{"index":22,"kind":"parameter","displayName":"Reply Subject","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"the subject to which subscribers should send response"},"requestTimeout":{"index":23,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":20000,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Request timeout in milliseconds"},"lazyStartProducer":{"index":24,"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."},"connection":{"index":25,"kind":"parameter","displayName":"Connection","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.nats.client.Connection","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Reference an already instantiated connection to Nats server"},"headerFilterStrategy":{"index":26,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Define the header filtering strategy"},"traceConnection":{"index":27,"kind":"parameter","displayName":"Trace Connection","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Whether or not connection trace messages should be printed to standard out for fine grained debugging of connection issues."},"credentialsFilePath":{"index":28,"kind":"parameter","displayName":"Credentials File Path","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"If we use useCredentialsFile to true we'll need to set the credentialsFilePath option. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"secure":{"index":29,"kind":"parameter","displayName":"Secure","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Set secure option indicating TLS is required"},"sslContextParameters":{"index":30,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}}} +{"component":{"kind":"component","name":"nats","title":"Nats","description":"Send and receive messages from NATS messaging system.","deprecated":false,"firstVersion":"2.17.0","label":"messaging","javaType":"org.apache.camel.component.nats.NatsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-nats","version":"4.8.2","scheme":"nats","extendsScheme":"","syntax":"nats:topic","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelNatsMessageTimestamp":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of a consumed message.","constantName":"org.apache.camel.component.nats.NatsConstants#NATS_MESSAGE_TIMESTAMP"},"CamelNatsSID":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SID of a consumed message.","constantName":"org.apache.camel.component.nats.NatsConstants#NATS_SID"},"CamelNatsReplyTo":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ReplyTo of a consumed message (may be null).","constantName":"org.apache.camel.component.nats.NatsConstants#NATS_REPLY_TO"},"CamelNatsSubject":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Subject of a consumed message.","constantName":"org.apache.camel.component.nats.NatsConstants#NATS_SUBJECT"},"CamelNatsQueueName":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Queue name of a consumed message (may be null).","constantName":"org.apache.camel.component.nats.NatsConstants#NATS_QUEUE_NAME"}},"properties":{"topic":{"index":0,"kind":"path","displayName":"Topic","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"The name of topic we want to use"},"connectionTimeout":{"index":1,"kind":"parameter","displayName":"Connection Timeout","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2000,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Timeout for connection attempts. (in milliseconds)"},"flushConnection":{"index":2,"kind":"parameter","displayName":"Flush Connection","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Define if we want to flush connection when stopping or not"},"flushTimeout":{"index":3,"kind":"parameter","displayName":"Flush Timeout","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Set the flush timeout (in milliseconds)"},"maxPingsOut":{"index":4,"kind":"parameter","displayName":"Max Pings Out","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"maximum number of pings have not received a response allowed by the client"},"maxReconnectAttempts":{"index":5,"kind":"parameter","displayName":"Max Reconnect Attempts","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Max reconnection attempts"},"noEcho":{"index":6,"kind":"parameter","displayName":"No Echo","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Turn off echo. If supported by the gnatsd version you are connecting to this flag will prevent the server from echoing messages back to the connection if it has subscriptions on the subject being published to."},"noRandomizeServers":{"index":7,"kind":"parameter","displayName":"No Randomize Servers","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Whether or not randomizing the order of servers for the connection attempts"},"pedantic":{"index":8,"kind":"parameter","displayName":"Pedantic","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Whether or not running in pedantic mode (this affects performance)"},"pingInterval":{"index":9,"kind":"parameter","displayName":"Ping Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":120000,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Ping interval to be aware if connection is still alive (in milliseconds)"},"reconnect":{"index":10,"kind":"parameter","displayName":"Reconnect","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Whether or not using reconnection feature"},"reconnectTimeWait":{"index":11,"kind":"parameter","displayName":"Reconnect Time Wait","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2000,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Waiting time before attempts reconnection (in milliseconds)"},"requestCleanupInterval":{"index":12,"kind":"parameter","displayName":"Request Cleanup Interval","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Interval to clean up cancelled/timed out requests."},"servers":{"index":13,"kind":"parameter","displayName":"Servers","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"URLs to one or more NAT servers. Use comma to separate URLs when specifying multiple servers."},"verbose":{"index":14,"kind":"parameter","displayName":"Verbose","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Whether or not running in verbose mode"},"maxMessages":{"index":15,"kind":"parameter","displayName":"Max Messages","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Stop receiving messages from a topic we are subscribing to after maxMessages"},"poolSize":{"index":16,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Consumer thread pool size (default is 10)"},"queueName":{"index":17,"kind":"parameter","displayName":"Queue Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"The Queue name if we are using nats for a queue configuration"},"replyToDisabled":{"index":18,"kind":"parameter","displayName":"Reply To Disabled","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Can be used to turn off sending back reply message in the consumer."},"bridgeErrorHandler":{"index":19,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":20,"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":{"index":21,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"replySubject":{"index":22,"kind":"parameter","displayName":"Reply Subject","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"the subject to which subscribers should send response"},"requestTimeout":{"index":23,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":20000,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Request timeout in milliseconds"},"lazyStartProducer":{"index":24,"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."},"connection":{"index":25,"kind":"parameter","displayName":"Connection","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.nats.client.Connection","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Reference an already instantiated connection to Nats server"},"headerFilterStrategy":{"index":26,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Define the header filtering strategy"},"traceConnection":{"index":27,"kind":"parameter","displayName":"Trace Connection","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Whether or not connection trace messages should be printed to standard out for fine grained debugging of connection issues."},"credentialsFilePath":{"index":28,"kind":"parameter","displayName":"Credentials File Path","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"If we use useCredentialsFile to true we'll need to set the credentialsFilePath option. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"secure":{"index":29,"kind":"parameter","displayName":"Secure","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"Set secure option indicating TLS is required"},"sslContextParameters":{"index":30,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.nats.NatsConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}}} , -{"component":{"kind":"component","name":"netty","title":"Netty","description":"Socket level networking using TCP or UDP with Netty 4.x.","deprecated":false,"firstVersion":"2.14.0","label":"networking","javaType":"org.apache.camel.component.netty.NettyComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-netty","version":"4.8.1","scheme":"netty","extendsScheme":"","syntax":"netty:protocol://host:port","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelNettyCloseChannelWhenComplete":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates whether the channel should be closed after complete.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_CLOSE_CHANNEL_WHEN_COMPLETE"},"CamelNettyChannelHandlerContext":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"io.netty.channel.ChannelHandlerContext","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channel handler context.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_CHANNEL_HANDLER_CONTEXT"},"CamelNettyRemoteAddress":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote address.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_REMOTE_ADDRESS"},"CamelNettyLocalAddress":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local address.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_LOCAL_ADDRESS"},"CamelNettySSLSession":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"javax.net.ssl.SSLSession","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL session.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_SESSION"},"CamelNettySSLClientCertSubjectName":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate subject name.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_SUBJECT_NAME"},"CamelNettySSLClientCertIssuerName":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate issuer name.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_ISSUER_NAME"},"CamelNettySSLClientCertSerialNumber":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate serial number.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_SERIAL_NO"},"CamelNettySSLClientCertNotBefore":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate not before.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_NOT_BEFORE"},"CamelNettySSLClientCertNotAfter":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate not after.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_NOT_AFTER"},"CamelNettyRequestTimeout":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The read timeout.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_REQUEST_TIMEOUT"}},"properties":{"protocol":{"index":0,"kind":"path","displayName":"Protocol","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["tcp","udp"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The protocol to use which can be tcp or udp."},"host":{"index":1,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The hostname. For the consumer the hostname is localhost or 0.0.0.0. For the producer the hostname is the remote host to connect to"},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The host port number"},"disconnect":{"index":3,"kind":"parameter","displayName":"Disconnect","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer."},"keepAlive":{"index":4,"kind":"parameter","displayName":"Keep Alive","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Setting to ensure socket is not closed due to inactivity"},"reuseAddress":{"index":5,"kind":"parameter","displayName":"Reuse Address","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Setting to facilitate socket multiplexing"},"reuseChannel":{"index":6,"kind":"parameter","displayName":"Reuse Channel","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useful if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this, the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key NettyConstants#NETTY_CHANNEL which allows you to obtain the channel during routing and use it as well."},"sync":{"index":7,"kind":"parameter","displayName":"Sync","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Setting to set endpoint as one-way or request-response"},"tcpNoDelay":{"index":8,"kind":"parameter","displayName":"Tcp No Delay","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Setting to improve TCP protocol performance"},"broadcast":{"index":9,"kind":"parameter","displayName":"Broadcast","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Setting to choose Multicast over UDP"},"clientMode":{"index":10,"kind":"parameter","displayName":"Client Mode","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"If the clientMode is true, netty consumer will connect the address as a TCP client."},"reconnect":{"index":11,"kind":"parameter","displayName":"Reconnect","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Used only in clientMode in consumer, the consumer will attempt to reconnect on disconnection if this is enabled"},"reconnectInterval":{"index":12,"kind":"parameter","displayName":"Reconnect Interval","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection"},"backlog":{"index":13,"kind":"parameter","displayName":"Backlog","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200, 500 or 1000, tells the TCP stack how long the accept queue can be If this option is not configured, then the backlog depends on OS setting."},"bossCount":{"index":14,"kind":"parameter","displayName":"Boss Count","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"When netty works on nio mode, it uses default bossCount parameter from Netty, which is 1. User can use this option to override the default bossCount from Netty"},"bossGroup":{"index":15,"kind":"parameter","displayName":"Boss Group","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"io.netty.channel.EventLoopGroup","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"disconnectOnNoReply":{"index":17,"kind":"parameter","displayName":"Disconnect On No Reply","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back."},"exceptionHandler":{"index":18,"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":{"index":19,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"nettyServerBootstrapFactory":{"index":20,"kind":"parameter","displayName":"Netty Server Bootstrap Factory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.NettyServerBootstrapFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To use a custom NettyServerBootstrapFactory"},"networkInterface":{"index":21,"kind":"parameter","displayName":"Network Interface","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"When using UDP then this option can be used to specify a network interface by its name, such as eth0 to join a multicast group."},"noReplyLogLevel":{"index":22,"kind":"parameter","displayName":"No Reply Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back."},"serverClosedChannelExceptionCaughtLogLevel":{"index":23,"kind":"parameter","displayName":"Server Closed Channel Exception Caught Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions, as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server."},"serverExceptionCaughtLogLevel":{"index":24,"kind":"parameter","displayName":"Server Exception Caught Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"If the server (NettyConsumer) catches an exception then its logged using this logging level."},"serverInitializerFactory":{"index":25,"kind":"parameter","displayName":"Server Initializer Factory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.ServerInitializerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To use a custom ServerInitializerFactory"},"usingExecutorService":{"index":26,"kind":"parameter","displayName":"Using Executor Service","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Whether to use ordered thread pool, to ensure events are processed orderly on the same channel."},"connectTimeout":{"index":27,"kind":"parameter","displayName":"Connect Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Time to wait for a socket connection to be available. Value is in milliseconds."},"requestTimeout":{"index":28,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds, so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout."},"clientInitializerFactory":{"index":29,"kind":"parameter","displayName":"Client Initializer Factory","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.ClientInitializerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To use a custom ClientInitializerFactory"},"correlationManager":{"index":30,"kind":"parameter","displayName":"Correlation Manager","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.NettyCamelStateCorrelationManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To use a custom correlation manager to manage how request and reply messages are mapped when using request/reply with the netty producer. This should only be used if you have a way to map requests together with replies such as if there is correlation ids in both the request and reply messages. This can be used if you want to multiplex concurrent messages on the same channel (aka connection) in netty. When doing this you must have a way to correlate the request and reply messages so you can store the right reply on the inflight Camel Exchange before its continued routed. We recommend extending the TimeoutCorrelationManagerSupport when you build custom correlation managers. This provides support for timeout and other complexities you otherwise would need to implement as well. See also the producerPoolEnabled option for more details."},"lazyChannelCreation":{"index":31,"kind":"parameter","displayName":"Lazy Channel Creation","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Channels can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started."},"lazyStartProducer":{"index":32,"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."},"producerPoolBlockWhenExhausted":{"index":33,"kind":"parameter","displayName":"Producer Pool Block When Exhausted","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Sets the value for the blockWhenExhausted configuration attribute. It determines whether to block when the borrowObject() method is invoked when the pool is exhausted (the maximum number of active objects has been reached)."},"producerPoolEnabled":{"index":34,"kind":"parameter","displayName":"Producer Pool Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Whether producer pool is enabled or not. Important: If you turn this off then a single shared connection is used for the producer, also if you are doing request/reply. That means there is a potential issue with interleaved responses if replies comes back out-of-order. Therefore you need to have a correlation id in both the request and reply messages so you can properly correlate the replies to the Camel callback that is responsible for continue processing the message in Camel. To do this you need to implement NettyCamelStateCorrelationManager as correlation manager and configure it via the correlationManager option. See also the correlationManager option for more details."},"producerPoolMaxIdle":{"index":35,"kind":"parameter","displayName":"Producer Pool Max Idle","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Sets the cap on the number of idle instances in the pool."},"producerPoolMaxTotal":{"index":36,"kind":"parameter","displayName":"Producer Pool Max Total","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. Use a negative value for no limit."},"producerPoolMaxWait":{"index":37,"kind":"parameter","displayName":"Producer Pool Max Wait","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Sets the maximum duration (value in millis) the borrowObject() method should block before throwing an exception when the pool is exhausted and producerPoolBlockWhenExhausted is true. When less than 0, the borrowObject() method may block indefinitely."},"producerPoolMinEvictableIdle":{"index":38,"kind":"parameter","displayName":"Producer Pool Min Evictable Idle","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":300000,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor."},"producerPoolMinIdle":{"index":39,"kind":"parameter","displayName":"Producer Pool Min Idle","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects."},"udpConnectionlessSending":{"index":40,"kind":"parameter","displayName":"Udp Connectionless Sending","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port."},"useByteBuf":{"index":41,"kind":"parameter","displayName":"Use Byte Buf","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"If the useByteBuf is true, netty producer will turn the message body into ByteBuf before sending it out."},"allowSerializedHeaders":{"index":42,"kind":"parameter","displayName":"Allow Serialized Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Only used for TCP when transferExchange is true. When set to true, serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level."},"channelGroup":{"index":43,"kind":"parameter","displayName":"Channel Group","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.netty.channel.group.ChannelGroup","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To use a explicit ChannelGroup."},"nativeTransport":{"index":44,"kind":"parameter","displayName":"Native Transport","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html"},"options":{"index":45,"kind":"parameter","displayName":"Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"option.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used."},"receiveBufferSize":{"index":46,"kind":"parameter","displayName":"Receive Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":65536,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes."},"receiveBufferSizePredictor":{"index":47,"kind":"parameter","displayName":"Receive Buffer Size Predictor","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Configures the buffer size predictor. See details at Jetty documentation and this mail thread."},"sendBufferSize":{"index":48,"kind":"parameter","displayName":"Send Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":65536,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes."},"synchronous":{"index":49,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"transferExchange":{"index":50,"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."},"udpByteArrayCodec":{"index":51,"kind":"parameter","displayName":"Udp Byte Array Codec","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"For UDP only. If enabled the using byte array codec instead of Java serialization protocol."},"unixDomainSocketPath":{"index":52,"kind":"parameter","displayName":"Unix Domain Socket Path","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Path to unix domain socket to use instead of inet socket. Host and port parameters will not be used, however required. It is ok to set dummy values for them. Must be used with nativeTransport=true and clientMode=false."},"workerCount":{"index":53,"kind":"parameter","displayName":"Worker Count","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2). User can use this option to override the default workerCount from Netty."},"workerGroup":{"index":54,"kind":"parameter","displayName":"Worker Group","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.netty.channel.EventLoopGroup","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads."},"allowDefaultCodec":{"index":55,"kind":"parameter","displayName":"Allow Default Codec","group":"codec","label":"codec","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The netty component installs a default codec if both, encoder/decoder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain."},"autoAppendDelimiter":{"index":56,"kind":"parameter","displayName":"Auto Append Delimiter","group":"codec","label":"codec","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Whether or not to auto append missing end delimiter when sending using the textline codec."},"decoderMaxLineLength":{"index":57,"kind":"parameter","displayName":"Decoder Max Line Length","group":"codec","label":"codec","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The max line length to use for the textline codec."},"decoders":{"index":58,"kind":"parameter","displayName":"Decoders","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"A list of decoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup."},"delimiter":{"index":59,"kind":"parameter","displayName":"Delimiter","group":"codec","label":"codec","required":false,"type":"object","javaType":"org.apache.camel.component.netty.TextLineDelimiter","enum":["LINE","NULL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"LINE","configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The delimiter to use for the textline codec. Possible values are LINE and NULL."},"encoders":{"index":60,"kind":"parameter","displayName":"Encoders","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"A list of encoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup."},"encoding":{"index":61,"kind":"parameter","displayName":"Encoding","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The encoding (a charset name) to use for the textline codec. If not provided, Camel will use the JVM default Charset."},"textline":{"index":62,"kind":"parameter","displayName":"Textline","group":"codec","label":"codec","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP - however only Strings are allowed to be serialized by default."},"enabledProtocols":{"index":63,"kind":"parameter","displayName":"Enabled Protocols","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"TLSv1.2,TLSv1.3","configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Which protocols to enable when using SSL"},"hostnameVerification":{"index":64,"kind":"parameter","displayName":"Hostname Verification","group":"security","label":"common,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To enable/disable hostname verification on SSLEngine"},"keyStoreFile":{"index":65,"kind":"parameter","displayName":"Key Store File","group":"security","label":"security","required":false,"type":"string","javaType":"java.io.File","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Client side certificate keystore to be used for encryption"},"keyStoreFormat":{"index":66,"kind":"parameter","displayName":"Key Store Format","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Keystore format to be used for payload encryption. Defaults to JKS if not set"},"keyStoreResource":{"index":67,"kind":"parameter","displayName":"Key Store Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Client side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"needClientAuth":{"index":68,"kind":"parameter","displayName":"Need Client Auth","group":"security","label":"consumer,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Configures whether the server needs client authentication when using SSL."},"passphrase":{"index":69,"kind":"parameter","displayName":"Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Password setting to use in order to encrypt/decrypt payloads sent using SSH"},"securityProvider":{"index":70,"kind":"parameter","displayName":"Security Provider","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Security provider to be used for payload encryption. Defaults to SunX509 if not set."},"ssl":{"index":71,"kind":"parameter","displayName":"Ssl","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Setting to specify whether SSL encryption is applied to this endpoint"},"sslClientCertHeaders":{"index":72,"kind":"parameter","displayName":"Ssl Client Cert Headers","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range."},"sslContextParameters":{"index":73,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"},"sslHandler":{"index":74,"kind":"parameter","displayName":"Ssl Handler","group":"security","label":"security","required":false,"type":"object","javaType":"io.netty.handler.ssl.SslHandler","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Reference to a class that could be used to return an SSL Handler"},"trustStoreFile":{"index":75,"kind":"parameter","displayName":"Trust Store File","group":"security","label":"security","required":false,"type":"string","javaType":"java.io.File","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Server side certificate keystore to be used for encryption"},"trustStoreResource":{"index":76,"kind":"parameter","displayName":"Trust Store Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Server side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."}}} +{"component":{"kind":"component","name":"netty","title":"Netty","description":"Socket level networking using TCP or UDP with Netty 4.x.","deprecated":false,"firstVersion":"2.14.0","label":"networking","javaType":"org.apache.camel.component.netty.NettyComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-netty","version":"4.8.2","scheme":"netty","extendsScheme":"","syntax":"netty:protocol://host:port","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelNettyCloseChannelWhenComplete":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates whether the channel should be closed after complete.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_CLOSE_CHANNEL_WHEN_COMPLETE"},"CamelNettyChannelHandlerContext":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"io.netty.channel.ChannelHandlerContext","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channel handler context.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_CHANNEL_HANDLER_CONTEXT"},"CamelNettyRemoteAddress":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote address.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_REMOTE_ADDRESS"},"CamelNettyLocalAddress":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local address.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_LOCAL_ADDRESS"},"CamelNettySSLSession":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"javax.net.ssl.SSLSession","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL session.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_SESSION"},"CamelNettySSLClientCertSubjectName":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate subject name.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_SUBJECT_NAME"},"CamelNettySSLClientCertIssuerName":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate issuer name.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_ISSUER_NAME"},"CamelNettySSLClientCertSerialNumber":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate serial number.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_SERIAL_NO"},"CamelNettySSLClientCertNotBefore":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate not before.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_NOT_BEFORE"},"CamelNettySSLClientCertNotAfter":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate not after.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_NOT_AFTER"},"CamelNettyRequestTimeout":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The read timeout.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_REQUEST_TIMEOUT"}},"properties":{"protocol":{"index":0,"kind":"path","displayName":"Protocol","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["tcp","udp"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The protocol to use which can be tcp or udp."},"host":{"index":1,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The hostname. For the consumer the hostname is localhost or 0.0.0.0. For the producer the hostname is the remote host to connect to"},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The host port number"},"disconnect":{"index":3,"kind":"parameter","displayName":"Disconnect","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer."},"keepAlive":{"index":4,"kind":"parameter","displayName":"Keep Alive","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Setting to ensure socket is not closed due to inactivity"},"reuseAddress":{"index":5,"kind":"parameter","displayName":"Reuse Address","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Setting to facilitate socket multiplexing"},"reuseChannel":{"index":6,"kind":"parameter","displayName":"Reuse Channel","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useful if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this, the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key NettyConstants#NETTY_CHANNEL which allows you to obtain the channel during routing and use it as well."},"sync":{"index":7,"kind":"parameter","displayName":"Sync","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Setting to set endpoint as one-way or request-response"},"tcpNoDelay":{"index":8,"kind":"parameter","displayName":"Tcp No Delay","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Setting to improve TCP protocol performance"},"broadcast":{"index":9,"kind":"parameter","displayName":"Broadcast","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Setting to choose Multicast over UDP"},"clientMode":{"index":10,"kind":"parameter","displayName":"Client Mode","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"If the clientMode is true, netty consumer will connect the address as a TCP client."},"reconnect":{"index":11,"kind":"parameter","displayName":"Reconnect","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Used only in clientMode in consumer, the consumer will attempt to reconnect on disconnection if this is enabled"},"reconnectInterval":{"index":12,"kind":"parameter","displayName":"Reconnect Interval","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection"},"backlog":{"index":13,"kind":"parameter","displayName":"Backlog","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200, 500 or 1000, tells the TCP stack how long the accept queue can be If this option is not configured, then the backlog depends on OS setting."},"bossCount":{"index":14,"kind":"parameter","displayName":"Boss Count","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"When netty works on nio mode, it uses default bossCount parameter from Netty, which is 1. User can use this option to override the default bossCount from Netty"},"bossGroup":{"index":15,"kind":"parameter","displayName":"Boss Group","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"io.netty.channel.EventLoopGroup","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"disconnectOnNoReply":{"index":17,"kind":"parameter","displayName":"Disconnect On No Reply","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back."},"exceptionHandler":{"index":18,"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":{"index":19,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"nettyServerBootstrapFactory":{"index":20,"kind":"parameter","displayName":"Netty Server Bootstrap Factory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.NettyServerBootstrapFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To use a custom NettyServerBootstrapFactory"},"networkInterface":{"index":21,"kind":"parameter","displayName":"Network Interface","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"When using UDP then this option can be used to specify a network interface by its name, such as eth0 to join a multicast group."},"noReplyLogLevel":{"index":22,"kind":"parameter","displayName":"No Reply Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back."},"serverClosedChannelExceptionCaughtLogLevel":{"index":23,"kind":"parameter","displayName":"Server Closed Channel Exception Caught Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions, as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server."},"serverExceptionCaughtLogLevel":{"index":24,"kind":"parameter","displayName":"Server Exception Caught Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"If the server (NettyConsumer) catches an exception then its logged using this logging level."},"serverInitializerFactory":{"index":25,"kind":"parameter","displayName":"Server Initializer Factory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.ServerInitializerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To use a custom ServerInitializerFactory"},"usingExecutorService":{"index":26,"kind":"parameter","displayName":"Using Executor Service","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Whether to use ordered thread pool, to ensure events are processed orderly on the same channel."},"connectTimeout":{"index":27,"kind":"parameter","displayName":"Connect Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Time to wait for a socket connection to be available. Value is in milliseconds."},"requestTimeout":{"index":28,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds, so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout."},"clientInitializerFactory":{"index":29,"kind":"parameter","displayName":"Client Initializer Factory","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.ClientInitializerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To use a custom ClientInitializerFactory"},"correlationManager":{"index":30,"kind":"parameter","displayName":"Correlation Manager","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.NettyCamelStateCorrelationManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To use a custom correlation manager to manage how request and reply messages are mapped when using request/reply with the netty producer. This should only be used if you have a way to map requests together with replies such as if there is correlation ids in both the request and reply messages. This can be used if you want to multiplex concurrent messages on the same channel (aka connection) in netty. When doing this you must have a way to correlate the request and reply messages so you can store the right reply on the inflight Camel Exchange before its continued routed. We recommend extending the TimeoutCorrelationManagerSupport when you build custom correlation managers. This provides support for timeout and other complexities you otherwise would need to implement as well. See also the producerPoolEnabled option for more details."},"lazyChannelCreation":{"index":31,"kind":"parameter","displayName":"Lazy Channel Creation","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Channels can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started."},"lazyStartProducer":{"index":32,"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."},"producerPoolBlockWhenExhausted":{"index":33,"kind":"parameter","displayName":"Producer Pool Block When Exhausted","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Sets the value for the blockWhenExhausted configuration attribute. It determines whether to block when the borrowObject() method is invoked when the pool is exhausted (the maximum number of active objects has been reached)."},"producerPoolEnabled":{"index":34,"kind":"parameter","displayName":"Producer Pool Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Whether producer pool is enabled or not. Important: If you turn this off then a single shared connection is used for the producer, also if you are doing request/reply. That means there is a potential issue with interleaved responses if replies comes back out-of-order. Therefore you need to have a correlation id in both the request and reply messages so you can properly correlate the replies to the Camel callback that is responsible for continue processing the message in Camel. To do this you need to implement NettyCamelStateCorrelationManager as correlation manager and configure it via the correlationManager option. See also the correlationManager option for more details."},"producerPoolMaxIdle":{"index":35,"kind":"parameter","displayName":"Producer Pool Max Idle","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Sets the cap on the number of idle instances in the pool."},"producerPoolMaxTotal":{"index":36,"kind":"parameter","displayName":"Producer Pool Max Total","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. Use a negative value for no limit."},"producerPoolMaxWait":{"index":37,"kind":"parameter","displayName":"Producer Pool Max Wait","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Sets the maximum duration (value in millis) the borrowObject() method should block before throwing an exception when the pool is exhausted and producerPoolBlockWhenExhausted is true. When less than 0, the borrowObject() method may block indefinitely."},"producerPoolMinEvictableIdle":{"index":38,"kind":"parameter","displayName":"Producer Pool Min Evictable Idle","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":300000,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor."},"producerPoolMinIdle":{"index":39,"kind":"parameter","displayName":"Producer Pool Min Idle","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects."},"udpConnectionlessSending":{"index":40,"kind":"parameter","displayName":"Udp Connectionless Sending","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port."},"useByteBuf":{"index":41,"kind":"parameter","displayName":"Use Byte Buf","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"If the useByteBuf is true, netty producer will turn the message body into ByteBuf before sending it out."},"allowSerializedHeaders":{"index":42,"kind":"parameter","displayName":"Allow Serialized Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Only used for TCP when transferExchange is true. When set to true, serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level."},"channelGroup":{"index":43,"kind":"parameter","displayName":"Channel Group","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.netty.channel.group.ChannelGroup","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To use a explicit ChannelGroup."},"nativeTransport":{"index":44,"kind":"parameter","displayName":"Native Transport","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html"},"options":{"index":45,"kind":"parameter","displayName":"Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"option.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used."},"receiveBufferSize":{"index":46,"kind":"parameter","displayName":"Receive Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":65536,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes."},"receiveBufferSizePredictor":{"index":47,"kind":"parameter","displayName":"Receive Buffer Size Predictor","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Configures the buffer size predictor. See details at Jetty documentation and this mail thread."},"sendBufferSize":{"index":48,"kind":"parameter","displayName":"Send Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":65536,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes."},"synchronous":{"index":49,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"transferExchange":{"index":50,"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."},"udpByteArrayCodec":{"index":51,"kind":"parameter","displayName":"Udp Byte Array Codec","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"For UDP only. If enabled the using byte array codec instead of Java serialization protocol."},"unixDomainSocketPath":{"index":52,"kind":"parameter","displayName":"Unix Domain Socket Path","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Path to unix domain socket to use instead of inet socket. Host and port parameters will not be used, however required. It is ok to set dummy values for them. Must be used with nativeTransport=true and clientMode=false."},"workerCount":{"index":53,"kind":"parameter","displayName":"Worker Count","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2). User can use this option to override the default workerCount from Netty."},"workerGroup":{"index":54,"kind":"parameter","displayName":"Worker Group","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.netty.channel.EventLoopGroup","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads."},"allowDefaultCodec":{"index":55,"kind":"parameter","displayName":"Allow Default Codec","group":"codec","label":"codec","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The netty component installs a default codec if both, encoder/decoder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain."},"autoAppendDelimiter":{"index":56,"kind":"parameter","displayName":"Auto Append Delimiter","group":"codec","label":"codec","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Whether or not to auto append missing end delimiter when sending using the textline codec."},"decoderMaxLineLength":{"index":57,"kind":"parameter","displayName":"Decoder Max Line Length","group":"codec","label":"codec","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The max line length to use for the textline codec."},"decoders":{"index":58,"kind":"parameter","displayName":"Decoders","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"A list of decoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup."},"delimiter":{"index":59,"kind":"parameter","displayName":"Delimiter","group":"codec","label":"codec","required":false,"type":"object","javaType":"org.apache.camel.component.netty.TextLineDelimiter","enum":["LINE","NULL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"LINE","configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The delimiter to use for the textline codec. Possible values are LINE and NULL."},"encoders":{"index":60,"kind":"parameter","displayName":"Encoders","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"A list of encoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup."},"encoding":{"index":61,"kind":"parameter","displayName":"Encoding","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"The encoding (a charset name) to use for the textline codec. If not provided, Camel will use the JVM default Charset."},"textline":{"index":62,"kind":"parameter","displayName":"Textline","group":"codec","label":"codec","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP - however only Strings are allowed to be serialized by default."},"enabledProtocols":{"index":63,"kind":"parameter","displayName":"Enabled Protocols","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"TLSv1.2,TLSv1.3","configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Which protocols to enable when using SSL"},"hostnameVerification":{"index":64,"kind":"parameter","displayName":"Hostname Verification","group":"security","label":"common,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To enable/disable hostname verification on SSLEngine"},"keyStoreFile":{"index":65,"kind":"parameter","displayName":"Key Store File","group":"security","label":"security","required":false,"type":"string","javaType":"java.io.File","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Client side certificate keystore to be used for encryption"},"keyStoreFormat":{"index":66,"kind":"parameter","displayName":"Key Store Format","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Keystore format to be used for payload encryption. Defaults to JKS if not set"},"keyStoreResource":{"index":67,"kind":"parameter","displayName":"Key Store Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Client side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"needClientAuth":{"index":68,"kind":"parameter","displayName":"Need Client Auth","group":"security","label":"consumer,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Configures whether the server needs client authentication when using SSL."},"passphrase":{"index":69,"kind":"parameter","displayName":"Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Password setting to use in order to encrypt/decrypt payloads sent using SSH"},"securityProvider":{"index":70,"kind":"parameter","displayName":"Security Provider","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Security provider to be used for payload encryption. Defaults to SunX509 if not set."},"ssl":{"index":71,"kind":"parameter","displayName":"Ssl","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Setting to specify whether SSL encryption is applied to this endpoint"},"sslClientCertHeaders":{"index":72,"kind":"parameter","displayName":"Ssl Client Cert Headers","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range."},"sslContextParameters":{"index":73,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"},"sslHandler":{"index":74,"kind":"parameter","displayName":"Ssl Handler","group":"security","label":"security","required":false,"type":"object","javaType":"io.netty.handler.ssl.SslHandler","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Reference to a class that could be used to return an SSL Handler"},"trustStoreFile":{"index":75,"kind":"parameter","displayName":"Trust Store File","group":"security","label":"security","required":false,"type":"string","javaType":"java.io.File","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Server side certificate keystore to be used for encryption"},"trustStoreResource":{"index":76,"kind":"parameter","displayName":"Trust Store Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.netty.NettyConfiguration","configurationField":"configuration","description":"Server side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."}}} , -{"component":{"kind":"component","name":"netty-http","title":"Netty HTTP","description":"Netty HTTP server and client using the Netty 4.x.","deprecated":false,"firstVersion":"2.14.0","label":"networking,http","javaType":"org.apache.camel.component.netty.http.NettyHttpComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-netty-http","version":"4.8.1","scheme":"netty-http","extendsScheme":"netty","syntax":"netty-http:protocol://host:port/path","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelHttpAuthentication":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the user was authenticated using HTTP Basic then this header is added with the value Basic.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_AUTHENTICATION"},"Content-Type":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To set the content-type of the HTTP body. For example: text/plain; charset=UTF-8.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#CONTENT_TYPE"},"connection":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of the HTTP header connection to use.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#CONNECTION"},"CamelNettyCloseChannelWhenComplete":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates whether the channel should be closed after complete.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#NETTY_CLOSE_CHANNEL_WHEN_COMPLETE"},"CamelHttpResponseCode":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows to set the HTTP Status code to use. By default 200 is used for success, and 500 for failure.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_RESPONSE_CODE"},"CamelHttpProtocolVersion":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"HTTP/1.1","description":"The version of the HTTP protocol.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_PROTOCOL_VERSION"},"CamelHttpMethod":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"GET","description":"The HTTP method used, such as GET, POST, TRACE etc.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_METHOD"},"CamelHttpQuery":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Any query parameters, such as foo=bar&beer=yes","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_QUERY"},"CamelHttpPath":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows to provide URI context-path and query parameters as a String value that overrides the endpoint configuration. This allows to reuse the same producer for calling same remote http server, but using a dynamic context-path and query parameters.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_PATH"},"CamelHttpRawQuery":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Any query parameters, such as foo=bar&beer=yes. Stored in the raw form, as they arrived to the consumer (i.e. before URL decoding).","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_RAW_QUERY"},"CamelHttpUrl":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The URL including protocol, host and port, etc: http://0.0.0.0:8080/myapp.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_URL"},"CamelHttpCharacterEncoding":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The charset from the content-type header.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_CHARACTER_ENCODING"},"CamelHttpUri":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The URI without protocol, host and port, etc: /myapp.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_URI"},"CamelNettyChannelHandlerContext":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"io.netty.channel.ChannelHandlerContext","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channel handler context.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_CHANNEL_HANDLER_CONTEXT"},"CamelNettyRemoteAddress":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote address.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_REMOTE_ADDRESS"},"CamelNettyLocalAddress":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local address.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_LOCAL_ADDRESS"},"CamelNettySSLSession":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"javax.net.ssl.SSLSession","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL session.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_SESSION"},"CamelNettySSLClientCertSubjectName":{"index":17,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate subject name.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_SUBJECT_NAME"},"CamelNettySSLClientCertIssuerName":{"index":18,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate issuer name.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_ISSUER_NAME"},"CamelNettySSLClientCertSerialNumber":{"index":19,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate serial number.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_SERIAL_NO"},"CamelNettySSLClientCertNotBefore":{"index":20,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate not before.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_NOT_BEFORE"},"CamelNettySSLClientCertNotAfter":{"index":21,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate not after.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_NOT_AFTER"},"CamelNettyRequestTimeout":{"index":22,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The read timeout.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_REQUEST_TIMEOUT"}},"properties":{"protocol":{"index":0,"kind":"path","displayName":"Protocol","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["http","https"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The protocol to use which is either http, https or proxy - a consumer only option."},"host":{"index":1,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The local hostname such as localhost, or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer."},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The host port number"},"path":{"index":3,"kind":"path","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Resource path"},"bridgeEndpoint":{"index":4,"kind":"parameter","displayName":"Bridge Endpoint","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If the option is true, the producer will ignore the NettyHttpConstants.HTTP_URI header, and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange)."},"disconnect":{"index":5,"kind":"parameter","displayName":"Disconnect","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer."},"keepAlive":{"index":6,"kind":"parameter","displayName":"Keep Alive","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Setting to ensure socket is not closed due to inactivity"},"reuseAddress":{"index":7,"kind":"parameter","displayName":"Reuse Address","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Setting to facilitate socket multiplexing"},"reuseChannel":{"index":8,"kind":"parameter","displayName":"Reuse Channel","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useful if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this, the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key NettyConstants#NETTY_CHANNEL which allows you to obtain the channel during routing and use it as well."},"sync":{"index":9,"kind":"parameter","displayName":"Sync","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Setting to set endpoint as one-way or request-response"},"tcpNoDelay":{"index":10,"kind":"parameter","displayName":"Tcp No Delay","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Setting to improve TCP protocol performance"},"matchOnUriPrefix":{"index":11,"kind":"parameter","displayName":"Match On Uri Prefix","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found."},"muteException":{"index":12,"kind":"parameter","displayName":"Mute Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace."},"send503whenSuspended":{"index":13,"kind":"parameter","displayName":"Send503when Suspended","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Whether to send back HTTP status code 503 when the consumer has been suspended. If the option is false then the Netty Acceptor is unbound when the consumer is suspended, so clients cannot connect anymore."},"backlog":{"index":14,"kind":"parameter","displayName":"Backlog","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200, 500 or 1000, tells the TCP stack how long the accept queue can be If this option is not configured, then the backlog depends on OS setting."},"bossCount":{"index":15,"kind":"parameter","displayName":"Boss Count","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"When netty works on nio mode, it uses default bossCount parameter from Netty, which is 1. User can use this option to override the default bossCount from Netty"},"bossGroup":{"index":16,"kind":"parameter","displayName":"Boss Group","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"io.netty.channel.EventLoopGroup","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint"},"bridgeErrorHandler":{"index":17,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"chunkedMaxContentLength":{"index":18,"kind":"parameter","displayName":"Chunked Max Content Length","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1048576,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Value in bytes the max content length per chunked frame received on the Netty HTTP server."},"compression":{"index":19,"kind":"parameter","displayName":"Compression","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers."},"disconnectOnNoReply":{"index":20,"kind":"parameter","displayName":"Disconnect On No Reply","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back."},"exceptionHandler":{"index":21,"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":{"index":22,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"httpMethodRestrict":{"index":23,"kind":"parameter","displayName":"Http Method Restrict","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma."},"logWarnOnBadRequest":{"index":24,"kind":"parameter","displayName":"Log Warn On Bad Request","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Whether Netty HTTP server should log a WARN if decoding the HTTP request failed and a HTTP Status 400 (bad request) is returned."},"mapHeaders":{"index":25,"kind":"parameter","displayName":"Map Headers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If this option is enabled, then during binding from Netty to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.netty.http.NettyHttpMessage message with the method getHttpRequest() that returns the Netty HTTP request io.netty.handler.codec.http.HttpRequest instance."},"maxChunkSize":{"index":26,"kind":"parameter","displayName":"Max Chunk Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The maximum length of the content or each chunk. If the content length (or the length of each chunk) exceeds this value, the content or chunk will be split into multiple io.netty.handler.codec.http.HttpContents whose length is maxChunkSize at maximum. See io.netty.handler.codec.http.HttpObjectDecoder"},"maxHeaderSize":{"index":27,"kind":"parameter","displayName":"Max Header Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The maximum length of all headers. If the sum of the length of each header exceeds this value, a io.netty.handler.codec.TooLongFrameException will be raised."},"maxInitialLineLength":{"index":28,"kind":"parameter","displayName":"Max Initial Line Length","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":4096,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The maximum length of the initial line (e.g. {code GET / HTTP/1.0} or {code HTTP/1.0 200 OK}) If the length of the initial line exceeds this value, a TooLongFrameException will be raised. See io.netty.handler.codec.http.HttpObjectDecoder"},"nettyServerBootstrapFactory":{"index":29,"kind":"parameter","displayName":"Netty Server Bootstrap Factory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.NettyServerBootstrapFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"To use a custom NettyServerBootstrapFactory"},"nettySharedHttpServer":{"index":30,"kind":"parameter","displayName":"Netty Shared Http Server","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.http.NettySharedHttpServer","deprecated":false,"autowired":false,"secret":false,"description":"To use a shared Netty HTTP server. See Netty HTTP Server Example for more details."},"noReplyLogLevel":{"index":31,"kind":"parameter","displayName":"No Reply Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back."},"serverClosedChannelExceptionCaughtLogLevel":{"index":32,"kind":"parameter","displayName":"Server Closed Channel Exception Caught Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions, as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server."},"serverExceptionCaughtLogLevel":{"index":33,"kind":"parameter","displayName":"Server Exception Caught Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If the server (NettyConsumer) catches an exception then its logged using this logging level."},"serverInitializerFactory":{"index":34,"kind":"parameter","displayName":"Server Initializer Factory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.ServerInitializerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"To use a custom ServerInitializerFactory"},"traceEnabled":{"index":35,"kind":"parameter","displayName":"Trace Enabled","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off."},"urlDecodeHeaders":{"index":36,"kind":"parameter","displayName":"Url Decode Headers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If this option is enabled, then during binding from Netty to Camel Message then the header values will be URL decoded (eg %20 will be a space character. Notice this option is used by the default org.apache.camel.component.netty.http.NettyHttpBinding and therefore if you implement a custom org.apache.camel.component.netty.http.NettyHttpBinding then you would need to decode the headers accordingly to this option."},"usingExecutorService":{"index":37,"kind":"parameter","displayName":"Using Executor Service","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Whether to use ordered thread pool, to ensure events are processed orderly on the same channel."},"connectTimeout":{"index":38,"kind":"parameter","displayName":"Connect Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Time to wait for a socket connection to be available. Value is in milliseconds."},"cookieHandler":{"index":39,"kind":"parameter","displayName":"Cookie Handler","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.http.base.cookie.CookieHandler","deprecated":false,"autowired":false,"secret":false,"description":"Configure a cookie handler to maintain a HTTP session"},"requestTimeout":{"index":40,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds, so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout."},"throwExceptionOnFailure":{"index":41,"kind":"parameter","displayName":"Throw Exception On Failure","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code."},"clientInitializerFactory":{"index":42,"kind":"parameter","displayName":"Client Initializer Factory","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.ClientInitializerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"To use a custom ClientInitializerFactory"},"lazyChannelCreation":{"index":43,"kind":"parameter","displayName":"Lazy Channel Creation","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Channels can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started."},"lazyStartProducer":{"index":44,"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."},"okStatusCodeRange":{"index":45,"kind":"parameter","displayName":"Ok Status Code Range","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"200-299","configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included. The default range is 200-299"},"producerPoolBlockWhenExhausted":{"index":46,"kind":"parameter","displayName":"Producer Pool Block When Exhausted","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets the value for the blockWhenExhausted configuration attribute. It determines whether to block when the borrowObject() method is invoked when the pool is exhausted (the maximum number of active objects has been reached)."},"producerPoolEnabled":{"index":47,"kind":"parameter","displayName":"Producer Pool Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Whether producer pool is enabled or not. Important: If you turn this off then a single shared connection is used for the producer, also if you are doing request/reply. That means there is a potential issue with interleaved responses if replies comes back out-of-order. Therefore you need to have a correlation id in both the request and reply messages so you can properly correlate the replies to the Camel callback that is responsible for continue processing the message in Camel. To do this you need to implement NettyCamelStateCorrelationManager as correlation manager and configure it via the correlationManager option. See also the correlationManager option for more details."},"producerPoolMaxIdle":{"index":48,"kind":"parameter","displayName":"Producer Pool Max Idle","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets the cap on the number of idle instances in the pool."},"producerPoolMaxTotal":{"index":49,"kind":"parameter","displayName":"Producer Pool Max Total","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. Use a negative value for no limit."},"producerPoolMaxWait":{"index":50,"kind":"parameter","displayName":"Producer Pool Max Wait","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets the maximum duration (value in millis) the borrowObject() method should block before throwing an exception when the pool is exhausted and producerPoolBlockWhenExhausted is true. When less than 0, the borrowObject() method may block indefinitely."},"producerPoolMinEvictableIdle":{"index":51,"kind":"parameter","displayName":"Producer Pool Min Evictable Idle","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":300000,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor."},"producerPoolMinIdle":{"index":52,"kind":"parameter","displayName":"Producer Pool Min Idle","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects."},"useRelativePath":{"index":53,"kind":"parameter","displayName":"Use Relative Path","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets whether to use a relative path in HTTP requests."},"allowSerializedHeaders":{"index":54,"kind":"parameter","displayName":"Allow Serialized Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Only used for TCP when transferExchange is true. When set to true, serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level."},"channelGroup":{"index":55,"kind":"parameter","displayName":"Channel Group","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.netty.channel.group.ChannelGroup","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"To use a explicit ChannelGroup."},"configuration":{"index":56,"kind":"parameter","displayName":"Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.http.NettyHttpConfiguration","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom configured NettyHttpConfiguration for configuring this endpoint."},"disableStreamCache":{"index":57,"kind":"parameter","displayName":"Disable Stream Cache","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Determines whether or not the raw input stream from Netty HttpRequest#getContent() or HttpResponset#getContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. Mind that if you enable this option, then you cannot read the Netty stream multiple times out of the box, and you would need manually to reset the reader index on the Netty raw stream. Also Netty will auto-close the Netty stream when the Netty HTTP server/HTTP client is done processing, which means that if the asynchronous routing engine is in use then any asynchronous thread that may continue routing the org.apache.camel.Exchange may not be able to read the Netty stream, because Netty has closed it."},"headerFilterStrategy":{"index":58,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."},"nativeTransport":{"index":59,"kind":"parameter","displayName":"Native Transport","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html"},"nettyHttpBinding":{"index":60,"kind":"parameter","displayName":"Netty Http Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.http.NettyHttpBinding","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API."},"options":{"index":61,"kind":"parameter","displayName":"Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"option.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used."},"receiveBufferSize":{"index":62,"kind":"parameter","displayName":"Receive Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":65536,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes."},"receiveBufferSizePredictor":{"index":63,"kind":"parameter","displayName":"Receive Buffer Size Predictor","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Configures the buffer size predictor. See details at Jetty documentation and this mail thread."},"sendBufferSize":{"index":64,"kind":"parameter","displayName":"Send Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":65536,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes."},"synchronous":{"index":65,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used"},"transferException":{"index":66,"kind":"parameter","displayName":"Transfer Exception","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk."},"transferExchange":{"index":67,"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."},"unixDomainSocketPath":{"index":68,"kind":"parameter","displayName":"Unix Domain Socket Path","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Path to unix domain socket to use instead of inet socket. Host and port parameters will not be used, however required. It is ok to set dummy values for them. Must be used with nativeTransport=true and clientMode=false."},"workerCount":{"index":69,"kind":"parameter","displayName":"Worker Count","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2). User can use this option to override the default workerCount from Netty."},"workerGroup":{"index":70,"kind":"parameter","displayName":"Worker Group","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.netty.channel.EventLoopGroup","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads."},"decoders":{"index":71,"kind":"parameter","displayName":"Decoders","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"A list of decoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup."},"encoders":{"index":72,"kind":"parameter","displayName":"Encoders","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"A list of encoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup."},"enabledProtocols":{"index":73,"kind":"parameter","displayName":"Enabled Protocols","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"TLSv1.2,TLSv1.3","configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Which protocols to enable when using SSL"},"hostnameVerification":{"index":74,"kind":"parameter","displayName":"Hostname Verification","group":"security","label":"common,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"To enable/disable hostname verification on SSLEngine"},"keyStoreFile":{"index":75,"kind":"parameter","displayName":"Key Store File","group":"security","label":"security","required":false,"type":"string","javaType":"java.io.File","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Client side certificate keystore to be used for encryption"},"keyStoreFormat":{"index":76,"kind":"parameter","displayName":"Key Store Format","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Keystore format to be used for payload encryption. Defaults to JKS if not set"},"keyStoreResource":{"index":77,"kind":"parameter","displayName":"Key Store Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Client side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"needClientAuth":{"index":78,"kind":"parameter","displayName":"Need Client Auth","group":"security","label":"consumer,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Configures whether the server needs client authentication when using SSL."},"passphrase":{"index":79,"kind":"parameter","displayName":"Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Password setting to use in order to encrypt/decrypt payloads sent using SSH"},"securityConfiguration":{"index":80,"kind":"parameter","displayName":"Security Configuration","group":"security","label":"consumer,security","required":false,"type":"object","javaType":"org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration","deprecated":false,"autowired":false,"secret":false,"description":"Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources."},"securityOptions":{"index":81,"kind":"parameter","displayName":"Security Options","group":"security","label":"consumer,security","required":false,"type":"object","javaType":"java.util.Map","prefix":"securityConfiguration.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure NettyHttpSecurityConfiguration using key/value pairs from the map"},"securityProvider":{"index":82,"kind":"parameter","displayName":"Security Provider","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Security provider to be used for payload encryption. Defaults to SunX509 if not set."},"ssl":{"index":83,"kind":"parameter","displayName":"Ssl","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Setting to specify whether SSL encryption is applied to this endpoint"},"sslClientCertHeaders":{"index":84,"kind":"parameter","displayName":"Ssl Client Cert Headers","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range."},"sslContextParameters":{"index":85,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"},"sslHandler":{"index":86,"kind":"parameter","displayName":"Ssl Handler","group":"security","label":"security","required":false,"type":"object","javaType":"io.netty.handler.ssl.SslHandler","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Reference to a class that could be used to return an SSL Handler"},"trustStoreFile":{"index":87,"kind":"parameter","displayName":"Trust Store File","group":"security","label":"security","required":false,"type":"string","javaType":"java.io.File","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Server side certificate keystore to be used for encryption"},"trustStoreResource":{"index":88,"kind":"parameter","displayName":"Trust Store Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Server side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."}}} +{"component":{"kind":"component","name":"netty-http","title":"Netty HTTP","description":"Netty HTTP server and client using the Netty 4.x.","deprecated":false,"firstVersion":"2.14.0","label":"networking,http","javaType":"org.apache.camel.component.netty.http.NettyHttpComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-netty-http","version":"4.8.2","scheme":"netty-http","extendsScheme":"netty","syntax":"netty-http:protocol://host:port/path","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelHttpAuthentication":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the user was authenticated using HTTP Basic then this header is added with the value Basic.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_AUTHENTICATION"},"Content-Type":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To set the content-type of the HTTP body. For example: text/plain; charset=UTF-8.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#CONTENT_TYPE"},"connection":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of the HTTP header connection to use.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#CONNECTION"},"CamelNettyCloseChannelWhenComplete":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates whether the channel should be closed after complete.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#NETTY_CLOSE_CHANNEL_WHEN_COMPLETE"},"CamelHttpResponseCode":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows to set the HTTP Status code to use. By default 200 is used for success, and 500 for failure.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_RESPONSE_CODE"},"CamelHttpProtocolVersion":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"HTTP/1.1","description":"The version of the HTTP protocol.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_PROTOCOL_VERSION"},"CamelHttpMethod":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"GET","description":"The HTTP method used, such as GET, POST, TRACE etc.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_METHOD"},"CamelHttpQuery":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Any query parameters, such as foo=bar&beer=yes","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_QUERY"},"CamelHttpPath":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows to provide URI context-path and query parameters as a String value that overrides the endpoint configuration. This allows to reuse the same producer for calling same remote http server, but using a dynamic context-path and query parameters.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_PATH"},"CamelHttpRawQuery":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Any query parameters, such as foo=bar&beer=yes. Stored in the raw form, as they arrived to the consumer (i.e. before URL decoding).","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_RAW_QUERY"},"CamelHttpUrl":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The URL including protocol, host and port, etc: http://0.0.0.0:8080/myapp.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_URL"},"CamelHttpCharacterEncoding":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The charset from the content-type header.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_CHARACTER_ENCODING"},"CamelHttpUri":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The URI without protocol, host and port, etc: /myapp.","constantName":"org.apache.camel.component.netty.http.NettyHttpConstants#HTTP_URI"},"CamelNettyChannelHandlerContext":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"io.netty.channel.ChannelHandlerContext","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channel handler context.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_CHANNEL_HANDLER_CONTEXT"},"CamelNettyRemoteAddress":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote address.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_REMOTE_ADDRESS"},"CamelNettyLocalAddress":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local address.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_LOCAL_ADDRESS"},"CamelNettySSLSession":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"javax.net.ssl.SSLSession","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL session.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_SESSION"},"CamelNettySSLClientCertSubjectName":{"index":17,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate subject name.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_SUBJECT_NAME"},"CamelNettySSLClientCertIssuerName":{"index":18,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate issuer name.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_ISSUER_NAME"},"CamelNettySSLClientCertSerialNumber":{"index":19,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate serial number.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_SERIAL_NO"},"CamelNettySSLClientCertNotBefore":{"index":20,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate not before.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_NOT_BEFORE"},"CamelNettySSLClientCertNotAfter":{"index":21,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSL client certificate not after.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_SSL_CLIENT_CERT_NOT_AFTER"},"CamelNettyRequestTimeout":{"index":22,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The read timeout.","constantName":"org.apache.camel.component.netty.NettyConstants#NETTY_REQUEST_TIMEOUT"}},"properties":{"protocol":{"index":0,"kind":"path","displayName":"Protocol","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["http","https"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The protocol to use which is either http, https or proxy - a consumer only option."},"host":{"index":1,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The local hostname such as localhost, or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer."},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The host port number"},"path":{"index":3,"kind":"path","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Resource path"},"bridgeEndpoint":{"index":4,"kind":"parameter","displayName":"Bridge Endpoint","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If the option is true, the producer will ignore the NettyHttpConstants.HTTP_URI header, and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange)."},"disconnect":{"index":5,"kind":"parameter","displayName":"Disconnect","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer."},"keepAlive":{"index":6,"kind":"parameter","displayName":"Keep Alive","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Setting to ensure socket is not closed due to inactivity"},"reuseAddress":{"index":7,"kind":"parameter","displayName":"Reuse Address","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Setting to facilitate socket multiplexing"},"reuseChannel":{"index":8,"kind":"parameter","displayName":"Reuse Channel","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useful if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this, the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key NettyConstants#NETTY_CHANNEL which allows you to obtain the channel during routing and use it as well."},"sync":{"index":9,"kind":"parameter","displayName":"Sync","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Setting to set endpoint as one-way or request-response"},"tcpNoDelay":{"index":10,"kind":"parameter","displayName":"Tcp No Delay","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Setting to improve TCP protocol performance"},"matchOnUriPrefix":{"index":11,"kind":"parameter","displayName":"Match On Uri Prefix","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found."},"muteException":{"index":12,"kind":"parameter","displayName":"Mute Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace."},"send503whenSuspended":{"index":13,"kind":"parameter","displayName":"Send503when Suspended","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Whether to send back HTTP status code 503 when the consumer has been suspended. If the option is false then the Netty Acceptor is unbound when the consumer is suspended, so clients cannot connect anymore."},"backlog":{"index":14,"kind":"parameter","displayName":"Backlog","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200, 500 or 1000, tells the TCP stack how long the accept queue can be If this option is not configured, then the backlog depends on OS setting."},"bossCount":{"index":15,"kind":"parameter","displayName":"Boss Count","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"When netty works on nio mode, it uses default bossCount parameter from Netty, which is 1. User can use this option to override the default bossCount from Netty"},"bossGroup":{"index":16,"kind":"parameter","displayName":"Boss Group","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"io.netty.channel.EventLoopGroup","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint"},"bridgeErrorHandler":{"index":17,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"chunkedMaxContentLength":{"index":18,"kind":"parameter","displayName":"Chunked Max Content Length","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1048576,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Value in bytes the max content length per chunked frame received on the Netty HTTP server."},"compression":{"index":19,"kind":"parameter","displayName":"Compression","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers."},"disconnectOnNoReply":{"index":20,"kind":"parameter","displayName":"Disconnect On No Reply","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back."},"exceptionHandler":{"index":21,"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":{"index":22,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"httpMethodRestrict":{"index":23,"kind":"parameter","displayName":"Http Method Restrict","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma."},"logWarnOnBadRequest":{"index":24,"kind":"parameter","displayName":"Log Warn On Bad Request","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Whether Netty HTTP server should log a WARN if decoding the HTTP request failed and a HTTP Status 400 (bad request) is returned."},"mapHeaders":{"index":25,"kind":"parameter","displayName":"Map Headers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If this option is enabled, then during binding from Netty to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.netty.http.NettyHttpMessage message with the method getHttpRequest() that returns the Netty HTTP request io.netty.handler.codec.http.HttpRequest instance."},"maxChunkSize":{"index":26,"kind":"parameter","displayName":"Max Chunk Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The maximum length of the content or each chunk. If the content length (or the length of each chunk) exceeds this value, the content or chunk will be split into multiple io.netty.handler.codec.http.HttpContents whose length is maxChunkSize at maximum. See io.netty.handler.codec.http.HttpObjectDecoder"},"maxHeaderSize":{"index":27,"kind":"parameter","displayName":"Max Header Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8192,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The maximum length of all headers. If the sum of the length of each header exceeds this value, a io.netty.handler.codec.TooLongFrameException will be raised."},"maxInitialLineLength":{"index":28,"kind":"parameter","displayName":"Max Initial Line Length","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":4096,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The maximum length of the initial line (e.g. {code GET / HTTP/1.0} or {code HTTP/1.0 200 OK}) If the length of the initial line exceeds this value, a TooLongFrameException will be raised. See io.netty.handler.codec.http.HttpObjectDecoder"},"nettyServerBootstrapFactory":{"index":29,"kind":"parameter","displayName":"Netty Server Bootstrap Factory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.NettyServerBootstrapFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"To use a custom NettyServerBootstrapFactory"},"nettySharedHttpServer":{"index":30,"kind":"parameter","displayName":"Netty Shared Http Server","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.http.NettySharedHttpServer","deprecated":false,"autowired":false,"secret":false,"description":"To use a shared Netty HTTP server. See Netty HTTP Server Example for more details."},"noReplyLogLevel":{"index":31,"kind":"parameter","displayName":"No Reply Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back."},"serverClosedChannelExceptionCaughtLogLevel":{"index":32,"kind":"parameter","displayName":"Server Closed Channel Exception Caught Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions, as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server."},"serverExceptionCaughtLogLevel":{"index":33,"kind":"parameter","displayName":"Server Exception Caught Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If the server (NettyConsumer) catches an exception then its logged using this logging level."},"serverInitializerFactory":{"index":34,"kind":"parameter","displayName":"Server Initializer Factory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.ServerInitializerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"To use a custom ServerInitializerFactory"},"traceEnabled":{"index":35,"kind":"parameter","displayName":"Trace Enabled","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off."},"urlDecodeHeaders":{"index":36,"kind":"parameter","displayName":"Url Decode Headers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If this option is enabled, then during binding from Netty to Camel Message then the header values will be URL decoded (eg %20 will be a space character. Notice this option is used by the default org.apache.camel.component.netty.http.NettyHttpBinding and therefore if you implement a custom org.apache.camel.component.netty.http.NettyHttpBinding then you would need to decode the headers accordingly to this option."},"usingExecutorService":{"index":37,"kind":"parameter","displayName":"Using Executor Service","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Whether to use ordered thread pool, to ensure events are processed orderly on the same channel."},"connectTimeout":{"index":38,"kind":"parameter","displayName":"Connect Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Time to wait for a socket connection to be available. Value is in milliseconds."},"cookieHandler":{"index":39,"kind":"parameter","displayName":"Cookie Handler","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.http.base.cookie.CookieHandler","deprecated":false,"autowired":false,"secret":false,"description":"Configure a cookie handler to maintain a HTTP session"},"requestTimeout":{"index":40,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds, so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout."},"throwExceptionOnFailure":{"index":41,"kind":"parameter","displayName":"Throw Exception On Failure","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code."},"clientInitializerFactory":{"index":42,"kind":"parameter","displayName":"Client Initializer Factory","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.ClientInitializerFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"To use a custom ClientInitializerFactory"},"lazyChannelCreation":{"index":43,"kind":"parameter","displayName":"Lazy Channel Creation","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Channels can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started."},"lazyStartProducer":{"index":44,"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."},"okStatusCodeRange":{"index":45,"kind":"parameter","displayName":"Ok Status Code Range","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"200-299","configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included. The default range is 200-299"},"producerPoolBlockWhenExhausted":{"index":46,"kind":"parameter","displayName":"Producer Pool Block When Exhausted","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets the value for the blockWhenExhausted configuration attribute. It determines whether to block when the borrowObject() method is invoked when the pool is exhausted (the maximum number of active objects has been reached)."},"producerPoolEnabled":{"index":47,"kind":"parameter","displayName":"Producer Pool Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Whether producer pool is enabled or not. Important: If you turn this off then a single shared connection is used for the producer, also if you are doing request/reply. That means there is a potential issue with interleaved responses if replies comes back out-of-order. Therefore you need to have a correlation id in both the request and reply messages so you can properly correlate the replies to the Camel callback that is responsible for continue processing the message in Camel. To do this you need to implement NettyCamelStateCorrelationManager as correlation manager and configure it via the correlationManager option. See also the correlationManager option for more details."},"producerPoolMaxIdle":{"index":48,"kind":"parameter","displayName":"Producer Pool Max Idle","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets the cap on the number of idle instances in the pool."},"producerPoolMaxTotal":{"index":49,"kind":"parameter","displayName":"Producer Pool Max Total","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. Use a negative value for no limit."},"producerPoolMaxWait":{"index":50,"kind":"parameter","displayName":"Producer Pool Max Wait","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets the maximum duration (value in millis) the borrowObject() method should block before throwing an exception when the pool is exhausted and producerPoolBlockWhenExhausted is true. When less than 0, the borrowObject() method may block indefinitely."},"producerPoolMinEvictableIdle":{"index":51,"kind":"parameter","displayName":"Producer Pool Min Evictable Idle","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":300000,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor."},"producerPoolMinIdle":{"index":52,"kind":"parameter","displayName":"Producer Pool Min Idle","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects."},"useRelativePath":{"index":53,"kind":"parameter","displayName":"Use Relative Path","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets whether to use a relative path in HTTP requests."},"allowSerializedHeaders":{"index":54,"kind":"parameter","displayName":"Allow Serialized Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Only used for TCP when transferExchange is true. When set to true, serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level."},"channelGroup":{"index":55,"kind":"parameter","displayName":"Channel Group","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.netty.channel.group.ChannelGroup","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"To use a explicit ChannelGroup."},"configuration":{"index":56,"kind":"parameter","displayName":"Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.http.NettyHttpConfiguration","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom configured NettyHttpConfiguration for configuring this endpoint."},"disableStreamCache":{"index":57,"kind":"parameter","displayName":"Disable Stream Cache","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Determines whether or not the raw input stream from Netty HttpRequest#getContent() or HttpResponset#getContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. Mind that if you enable this option, then you cannot read the Netty stream multiple times out of the box, and you would need manually to reset the reader index on the Netty raw stream. Also Netty will auto-close the Netty stream when the Netty HTTP server/HTTP client is done processing, which means that if the asynchronous routing engine is in use then any asynchronous thread that may continue routing the org.apache.camel.Exchange may not be able to read the Netty stream, because Netty has closed it."},"headerFilterStrategy":{"index":58,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."},"nativeTransport":{"index":59,"kind":"parameter","displayName":"Native Transport","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html"},"nettyHttpBinding":{"index":60,"kind":"parameter","displayName":"Netty Http Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.netty.http.NettyHttpBinding","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API."},"options":{"index":61,"kind":"parameter","displayName":"Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"option.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used."},"receiveBufferSize":{"index":62,"kind":"parameter","displayName":"Receive Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":65536,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes."},"receiveBufferSizePredictor":{"index":63,"kind":"parameter","displayName":"Receive Buffer Size Predictor","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Configures the buffer size predictor. See details at Jetty documentation and this mail thread."},"sendBufferSize":{"index":64,"kind":"parameter","displayName":"Send Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":65536,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes."},"synchronous":{"index":65,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Sets whether synchronous processing should be strictly used"},"transferException":{"index":66,"kind":"parameter","displayName":"Transfer Exception","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk."},"transferExchange":{"index":67,"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."},"unixDomainSocketPath":{"index":68,"kind":"parameter","displayName":"Unix Domain Socket Path","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Path to unix domain socket to use instead of inet socket. Host and port parameters will not be used, however required. It is ok to set dummy values for them. Must be used with nativeTransport=true and clientMode=false."},"workerCount":{"index":69,"kind":"parameter","displayName":"Worker Count","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2). User can use this option to override the default workerCount from Netty."},"workerGroup":{"index":70,"kind":"parameter","displayName":"Worker Group","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.netty.channel.EventLoopGroup","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads."},"decoders":{"index":71,"kind":"parameter","displayName":"Decoders","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"A list of decoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup."},"encoders":{"index":72,"kind":"parameter","displayName":"Encoders","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"A list of encoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup."},"enabledProtocols":{"index":73,"kind":"parameter","displayName":"Enabled Protocols","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"TLSv1.2,TLSv1.3","configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Which protocols to enable when using SSL"},"hostnameVerification":{"index":74,"kind":"parameter","displayName":"Hostname Verification","group":"security","label":"common,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"To enable/disable hostname verification on SSLEngine"},"keyStoreFile":{"index":75,"kind":"parameter","displayName":"Key Store File","group":"security","label":"security","required":false,"type":"string","javaType":"java.io.File","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Client side certificate keystore to be used for encryption"},"keyStoreFormat":{"index":76,"kind":"parameter","displayName":"Key Store Format","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Keystore format to be used for payload encryption. Defaults to JKS if not set"},"keyStoreResource":{"index":77,"kind":"parameter","displayName":"Key Store Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Client side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"needClientAuth":{"index":78,"kind":"parameter","displayName":"Need Client Auth","group":"security","label":"consumer,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Configures whether the server needs client authentication when using SSL."},"passphrase":{"index":79,"kind":"parameter","displayName":"Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Password setting to use in order to encrypt/decrypt payloads sent using SSH"},"securityConfiguration":{"index":80,"kind":"parameter","displayName":"Security Configuration","group":"security","label":"consumer,security","required":false,"type":"object","javaType":"org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration","deprecated":false,"autowired":false,"secret":false,"description":"Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources."},"securityOptions":{"index":81,"kind":"parameter","displayName":"Security Options","group":"security","label":"consumer,security","required":false,"type":"object","javaType":"java.util.Map","prefix":"securityConfiguration.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure NettyHttpSecurityConfiguration using key/value pairs from the map"},"securityProvider":{"index":82,"kind":"parameter","displayName":"Security Provider","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Security provider to be used for payload encryption. Defaults to SunX509 if not set."},"ssl":{"index":83,"kind":"parameter","displayName":"Ssl","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Setting to specify whether SSL encryption is applied to this endpoint"},"sslClientCertHeaders":{"index":84,"kind":"parameter","displayName":"Ssl Client Cert Headers","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range."},"sslContextParameters":{"index":85,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"},"sslHandler":{"index":86,"kind":"parameter","displayName":"Ssl Handler","group":"security","label":"security","required":false,"type":"object","javaType":"io.netty.handler.ssl.SslHandler","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Reference to a class that could be used to return an SSL Handler"},"trustStoreFile":{"index":87,"kind":"parameter","displayName":"Trust Store File","group":"security","label":"security","required":false,"type":"string","javaType":"java.io.File","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Server side certificate keystore to be used for encryption"},"trustStoreResource":{"index":88,"kind":"parameter","displayName":"Trust Store Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.netty.http.NettyHttpConfiguration","configurationField":"configuration","description":"Server side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."}}} , -{"component":{"kind":"component","name":"oaipmh","title":"OAI-PMH","description":"Harvest metadata using OAI-PMH protocol","deprecated":false,"firstVersion":"3.5.0","label":"search","javaType":"org.apache.camel.oaipmh.component.OAIPMHComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-oaipmh","version":"4.8.1","scheme":"oaipmh","extendsScheme":"","syntax":"oaipmh:baseUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelOaimphResumptionToken":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header is obtained when onlyFirst option is enable. Return resumption token of the request when data is still available.","constantName":"org.apache.camel.oaipmh.component.model.OAIPMHConstants#RESUMPTION_TOKEN"}},"properties":{"baseUrl":{"index":0,"kind":"path","displayName":"Base Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Base URL of the repository to which the request is made through the OAI-PMH protocol"},"from":{"index":1,"kind":"parameter","displayName":"From","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies a lower bound for datestamp-based selective harvesting. UTC DateTime value"},"identifier":{"index":2,"kind":"parameter","displayName":"Identifier","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Identifier of the requested resources. Applicable only with certain verbs"},"metadataPrefix":{"index":3,"kind":"parameter","displayName":"Metadata Prefix","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"oai_dc","description":"Specifies the metadataPrefix of the format that should be included in the metadata part of the returned records."},"set":{"index":4,"kind":"parameter","displayName":"Set","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies membership as a criteria for set-based selective harvesting"},"until":{"index":5,"kind":"parameter","displayName":"Until","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies an upper bound for datestamp-based selective harvesting. UTC DateTime value."},"verb":{"index":6,"kind":"parameter","displayName":"Verb","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ListRecords","description":"Request name supported by OAI-PMh protocol"},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"onlyFirst":{"index":12,"kind":"parameter","displayName":"Only First","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Returns the response of a single request. Otherwise it will make requests until there is no more data to return."},"lazyStartProducer":{"index":13,"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."},"backoffErrorThreshold":{"index":14,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":16,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":17,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":18,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":19,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":20,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":21,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":22,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":23,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":24,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":25,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":26,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":27,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"ignoreSSLWarnings":{"index":28,"kind":"parameter","displayName":"Ignore SSLWarnings","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL certificate warnings"},"ssl":{"index":29,"kind":"parameter","displayName":"Ssl","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Causes the defined url to make an https request"}}} +{"component":{"kind":"component","name":"oaipmh","title":"OAI-PMH","description":"Harvest metadata using OAI-PMH protocol","deprecated":false,"firstVersion":"3.5.0","label":"search","javaType":"org.apache.camel.oaipmh.component.OAIPMHComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-oaipmh","version":"4.8.2","scheme":"oaipmh","extendsScheme":"","syntax":"oaipmh:baseUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelOaimphResumptionToken":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header is obtained when onlyFirst option is enable. Return resumption token of the request when data is still available.","constantName":"org.apache.camel.oaipmh.component.model.OAIPMHConstants#RESUMPTION_TOKEN"}},"properties":{"baseUrl":{"index":0,"kind":"path","displayName":"Base Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Base URL of the repository to which the request is made through the OAI-PMH protocol"},"from":{"index":1,"kind":"parameter","displayName":"From","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies a lower bound for datestamp-based selective harvesting. UTC DateTime value"},"identifier":{"index":2,"kind":"parameter","displayName":"Identifier","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Identifier of the requested resources. Applicable only with certain verbs"},"metadataPrefix":{"index":3,"kind":"parameter","displayName":"Metadata Prefix","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"oai_dc","description":"Specifies the metadataPrefix of the format that should be included in the metadata part of the returned records."},"set":{"index":4,"kind":"parameter","displayName":"Set","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies membership as a criteria for set-based selective harvesting"},"until":{"index":5,"kind":"parameter","displayName":"Until","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies an upper bound for datestamp-based selective harvesting. UTC DateTime value."},"verb":{"index":6,"kind":"parameter","displayName":"Verb","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ListRecords","description":"Request name supported by OAI-PMh protocol"},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"onlyFirst":{"index":12,"kind":"parameter","displayName":"Only First","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Returns the response of a single request. Otherwise it will make requests until there is no more data to return."},"lazyStartProducer":{"index":13,"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."},"backoffErrorThreshold":{"index":14,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":16,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":17,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":18,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":19,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":20,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":21,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":22,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":23,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":24,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":25,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":26,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":27,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"ignoreSSLWarnings":{"index":28,"kind":"parameter","displayName":"Ignore SSLWarnings","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL certificate warnings"},"ssl":{"index":29,"kind":"parameter","displayName":"Ssl","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Causes the defined url to make an https request"}}} , -{"component":{"kind":"component","name":"olingo2","title":"Olingo2","description":"Communicate with OData 2.0 services using Apache Olingo.","deprecated":false,"firstVersion":"2.14.0","label":"cloud","javaType":"org.apache.camel.component.olingo2.Olingo2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-olingo2","version":"4.8.1","scheme":"olingo2","extendsScheme":"","syntax":"olingo2:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelOlingo2.responseHttpHeaders":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response Http headers","constantName":"org.apache.camel.component.olingo2.internal.Olingo2Constants#RESPONSE_HTTP_HEADERS"}},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.olingo2.internal.Olingo2ApiName","enum":["DEFAULT"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"connectTimeout":{"index":2,"kind":"parameter","displayName":"Connect Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds)"},"contentType":{"index":3,"kind":"parameter","displayName":"Content Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"application/json;charset=utf-8","configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8"},"entityProviderReadProperties":{"index":4,"kind":"parameter","displayName":"Entity Provider Read Properties","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.ep.EntityProviderReadProperties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Custom entity provider read properties applied to all read operations."},"entityProviderWriteProperties":{"index":5,"kind":"parameter","displayName":"Entity Provider Write Properties","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.ep.EntityProviderWriteProperties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Custom entity provider write properties applied to create, update, patch, batch and merge operations. For instance users can skip the Json object wrapper or enable content only mode when sending request data. A service URI set in the properties will always be overwritten by the serviceUri configuration parameter. Please consider to using the serviceUri configuration parameter instead of setting the respective write property here."},"filterAlreadySeen":{"index":6,"kind":"parameter","displayName":"Filter Already Seen","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Set this to true to filter out results that have already been communicated by this component."},"httpHeaders":{"index":7,"kind":"parameter","displayName":"Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Custom HTTP headers to inject into every request, this could include OAuth tokens, etc."},"inBody":{"index":8,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"proxy":{"index":9,"kind":"parameter","displayName":"Proxy","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.http.HttpHost","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"HTTP proxy server configuration"},"serviceUri":{"index":10,"kind":"parameter","displayName":"Service Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Target OData service base URI, e.g. http://services.odata.org/OData/OData.svc"},"socketTimeout":{"index":11,"kind":"parameter","displayName":"Socket Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds)"},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"splitResult":{"index":13,"kind":"parameter","displayName":"Split Result","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":17,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":18,"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."},"httpAsyncClientBuilder":{"index":19,"kind":"parameter","displayName":"Http Async Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.http.impl.nio.client.HttpAsyncClientBuilder","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely"},"httpClientBuilder":{"index":20,"kind":"parameter","displayName":"Http Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.http.impl.client.HttpClientBuilder","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely"},"backoffErrorThreshold":{"index":21,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":22,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":23,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":24,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":25,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":26,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":27,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":28,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":29,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":30,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":31,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":32,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":33,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":34,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"sslContextParameters":{"index":35,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}},"apis":{"DEFAULT":{"consumerOnly":false,"producerOnly":false,"description":"Olingo2 Client Api Interface","methods":{"batch":{"description":"Executes a batch request","signatures":["void batch(org.apache.olingo.odata2.api.edm.Edm edm, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler> responseHandler)"]},"create":{"description":"Creates a new OData resource","signatures":["void create(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)"]},"delete":{"description":"Deletes an OData resource and invokes callback with org","signatures":["void delete(String resourcePath, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)"]},"merge":{"description":"Patches/merges an OData resource using HTTP MERGE","signatures":["void merge(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)"]},"patch":{"description":"Patches/merges an OData resource using HTTP PATCH","signatures":["void patch(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)"]},"read":{"description":"Reads an OData resource and invokes callback with appropriate result","signatures":["void read(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map queryParams, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)"]},"update":{"description":"Updates an OData resource","signatures":["void update(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)"]},"uread":{"description":"Reads an OData resource and invokes callback with the unparsed input stream","signatures":["void uread(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map queryParams, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)"]}}}},"apiProperties":{"DEFAULT":{"methods":{"batch":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Ordered org.apache.camel.component.olingo2.api.batch.Olingo2BatchRequest list","optional":false},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"responseHandler":{"index":3,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}},"create":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Request data","optional":false},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to create","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}},"delete":{"properties":{"endpointHttpHeaders":{"index":0,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":1,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path for Entry","optional":false},"responseHandler":{"index":2,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.odata2.api.commons.HttpStatusCodes callback handler","optional":true}}},"merge":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Patch/merge data","optional":false},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to update","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.odata2.api.ep.entry.ODataEntry callback handler","optional":true}}},"patch":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Patch/merge data","optional":false},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to update","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.odata2.api.ep.entry.ODataEntry callback handler","optional":true}}},"read":{"properties":{"edm":{"index":0,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm, read from calling read(null, $metdata, null, responseHandler)","optional":true},"endpointHttpHeaders":{"index":1,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"queryParams":{"index":2,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"OData query params from http://www.odata.org/documentation/odata-version-2-0/uri-conventions#SystemQueryOptions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OData Resource path","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}},"update":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Updated data","optional":false},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to update","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.odata2.api.ep.entry.ODataEntry callback handler","optional":true}}},"uread":{"properties":{"edm":{"index":0,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm, read from calling read(null, $metdata, null, responseHandler)","optional":true},"endpointHttpHeaders":{"index":1,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"queryParams":{"index":2,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"OData query params from http://www.odata.org/documentation/odata-version-2-0/uri-conventions#SystemQueryOptions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OData Resource path","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}}}}}} +{"component":{"kind":"component","name":"olingo2","title":"Olingo2","description":"Communicate with OData 2.0 services using Apache Olingo.","deprecated":false,"firstVersion":"2.14.0","label":"cloud","javaType":"org.apache.camel.component.olingo2.Olingo2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-olingo2","version":"4.8.2","scheme":"olingo2","extendsScheme":"","syntax":"olingo2:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelOlingo2.responseHttpHeaders":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response Http headers","constantName":"org.apache.camel.component.olingo2.internal.Olingo2Constants#RESPONSE_HTTP_HEADERS"}},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.olingo2.internal.Olingo2ApiName","enum":["DEFAULT"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"connectTimeout":{"index":2,"kind":"parameter","displayName":"Connect Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds)"},"contentType":{"index":3,"kind":"parameter","displayName":"Content Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"application/json;charset=utf-8","configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8"},"entityProviderReadProperties":{"index":4,"kind":"parameter","displayName":"Entity Provider Read Properties","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.ep.EntityProviderReadProperties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Custom entity provider read properties applied to all read operations."},"entityProviderWriteProperties":{"index":5,"kind":"parameter","displayName":"Entity Provider Write Properties","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.ep.EntityProviderWriteProperties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Custom entity provider write properties applied to create, update, patch, batch and merge operations. For instance users can skip the Json object wrapper or enable content only mode when sending request data. A service URI set in the properties will always be overwritten by the serviceUri configuration parameter. Please consider to using the serviceUri configuration parameter instead of setting the respective write property here."},"filterAlreadySeen":{"index":6,"kind":"parameter","displayName":"Filter Already Seen","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Set this to true to filter out results that have already been communicated by this component."},"httpHeaders":{"index":7,"kind":"parameter","displayName":"Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Custom HTTP headers to inject into every request, this could include OAuth tokens, etc."},"inBody":{"index":8,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"proxy":{"index":9,"kind":"parameter","displayName":"Proxy","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.http.HttpHost","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"HTTP proxy server configuration"},"serviceUri":{"index":10,"kind":"parameter","displayName":"Service Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Target OData service base URI, e.g. http://services.odata.org/OData/OData.svc"},"socketTimeout":{"index":11,"kind":"parameter","displayName":"Socket Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds)"},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"splitResult":{"index":13,"kind":"parameter","displayName":"Split Result","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":17,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":18,"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."},"httpAsyncClientBuilder":{"index":19,"kind":"parameter","displayName":"Http Async Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.http.impl.nio.client.HttpAsyncClientBuilder","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely"},"httpClientBuilder":{"index":20,"kind":"parameter","displayName":"Http Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.http.impl.client.HttpClientBuilder","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely"},"backoffErrorThreshold":{"index":21,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":22,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":23,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":24,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":25,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":26,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":27,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":28,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":29,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":30,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":31,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":32,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":33,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":34,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"sslContextParameters":{"index":35,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo2.Olingo2Configuration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}},"apis":{"DEFAULT":{"consumerOnly":false,"producerOnly":false,"description":"Olingo2 Client Api Interface","methods":{"batch":{"description":"Executes a batch request","signatures":["void batch(org.apache.olingo.odata2.api.edm.Edm edm, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler> responseHandler)"]},"create":{"description":"Creates a new OData resource","signatures":["void create(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)"]},"delete":{"description":"Deletes an OData resource and invokes callback with org","signatures":["void delete(String resourcePath, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)"]},"merge":{"description":"Patches/merges an OData resource using HTTP MERGE","signatures":["void merge(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)"]},"patch":{"description":"Patches/merges an OData resource using HTTP PATCH","signatures":["void patch(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)"]},"read":{"description":"Reads an OData resource and invokes callback with appropriate result","signatures":["void read(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map queryParams, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)"]},"update":{"description":"Updates an OData resource","signatures":["void update(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)"]},"uread":{"description":"Reads an OData resource and invokes callback with the unparsed input stream","signatures":["void uread(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map queryParams, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)"]}}}},"apiProperties":{"DEFAULT":{"methods":{"batch":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Ordered org.apache.camel.component.olingo2.api.batch.Olingo2BatchRequest list","optional":false},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"responseHandler":{"index":3,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}},"create":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Request data","optional":false},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to create","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}},"delete":{"properties":{"endpointHttpHeaders":{"index":0,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":1,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path for Entry","optional":false},"responseHandler":{"index":2,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.odata2.api.commons.HttpStatusCodes callback handler","optional":true}}},"merge":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Patch/merge data","optional":false},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to update","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.odata2.api.ep.entry.ODataEntry callback handler","optional":true}}},"patch":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Patch/merge data","optional":false},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to update","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.odata2.api.ep.entry.ODataEntry callback handler","optional":true}}},"read":{"properties":{"edm":{"index":0,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm, read from calling read(null, $metdata, null, responseHandler)","optional":true},"endpointHttpHeaders":{"index":1,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"queryParams":{"index":2,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"OData query params from http://www.odata.org/documentation/odata-version-2-0/uri-conventions#SystemQueryOptions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OData Resource path","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}},"update":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Updated data","optional":false},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to update","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.odata2.api.ep.entry.ODataEntry callback handler","optional":true}}},"uread":{"properties":{"edm":{"index":0,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.odata2.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm, read from calling read(null, $metdata, null, responseHandler)","optional":true},"endpointHttpHeaders":{"index":1,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"queryParams":{"index":2,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"OData query params from http://www.odata.org/documentation/odata-version-2-0/uri-conventions#SystemQueryOptions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OData Resource path","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo2.api.Olingo2ResponseHandler>","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}}}}}} , -{"component":{"kind":"component","name":"olingo4","title":"Olingo4","description":"Communicate with OData 4.0 services using Apache Olingo OData API.","deprecated":false,"firstVersion":"2.19.0","label":"cloud","javaType":"org.apache.camel.component.olingo4.Olingo4Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-olingo4","version":"4.8.1","scheme":"olingo4","extendsScheme":"","syntax":"olingo4:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelOlingo4.responseHttpHeaders":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response Http headers","constantName":"org.apache.camel.component.olingo4.internal.Olingo4Constants#FULL_RESPONSE_HTTP_HEADERS"}},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.olingo4.internal.Olingo4ApiName","enum":["DEFAULT"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"connectTimeout":{"index":2,"kind":"parameter","displayName":"Connect Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds)"},"contentType":{"index":3,"kind":"parameter","displayName":"Content Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"application/json;charset=utf-8","configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8"},"filterAlreadySeen":{"index":4,"kind":"parameter","displayName":"Filter Already Seen","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"Set this to true to filter out results that have already been communicated by this component."},"httpHeaders":{"index":5,"kind":"parameter","displayName":"Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"Custom HTTP headers to inject into every request, this could include OAuth tokens, etc."},"inBody":{"index":6,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"proxy":{"index":7,"kind":"parameter","displayName":"Proxy","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.http.HttpHost","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"HTTP proxy server configuration"},"serviceUri":{"index":8,"kind":"parameter","displayName":"Service Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"Target OData service base URI, e.g. http://services.odata.org/OData/OData.svc"},"socketTimeout":{"index":9,"kind":"parameter","displayName":"Socket Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds)"},"sendEmptyMessageWhenIdle":{"index":10,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"splitResult":{"index":11,"kind":"parameter","displayName":"Split Result","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":15,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":16,"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."},"httpAsyncClientBuilder":{"index":17,"kind":"parameter","displayName":"Http Async Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.http.impl.nio.client.HttpAsyncClientBuilder","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely"},"httpClientBuilder":{"index":18,"kind":"parameter","displayName":"Http Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.http.impl.client.HttpClientBuilder","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely"},"backoffErrorThreshold":{"index":19,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":20,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":21,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":22,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":23,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":24,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":25,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":26,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":27,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":28,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":29,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":30,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":31,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":32,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"sslContextParameters":{"index":33,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}},"apis":{"DEFAULT":{"consumerOnly":false,"producerOnly":false,"description":"Olingo4 Client Api Interface","methods":{"action":{"description":"Calls a OData action","signatures":["void action(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]},"batch":{"description":"Executes a batch request","signatures":["void batch(org.apache.olingo.commons.api.edm.Edm edm, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler> responseHandler)"]},"create":{"description":"Creates a new OData resource","signatures":["void create(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]},"delete":{"description":"Deletes an OData resource and invokes callback with org","signatures":["void delete(String resourcePath, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]},"merge":{"description":"Patches/merges an OData resource using HTTP MERGE","signatures":["void merge(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]},"patch":{"description":"Patches/merges an OData resource using HTTP PATCH","signatures":["void patch(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]},"read":{"description":"Reads an OData resource and invokes callback with appropriate result","signatures":["void read(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map queryParams, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]},"update":{"description":"Updates an OData resource","signatures":["void update(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]},"uread":{"description":"Reads an OData resource and invokes callback with the unparsed input stream","signatures":["void uread(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map queryParams, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]}}}},"apiProperties":{"DEFAULT":{"methods":{"action":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Action data","optional":true},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to action","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.client.api.domain.ClientEntity callback handler","optional":true}}},"batch":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Ordered org.apache.camel.component.olingo4.api.batch.Olingo4BatchRequest list","optional":true},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"responseHandler":{"index":3,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}},"create":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Request data","optional":true},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to create","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}},"delete":{"properties":{"endpointHttpHeaders":{"index":0,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":1,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path for Entry","optional":false},"responseHandler":{"index":2,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.commons.api.http.HttpStatusCode callback handler","optional":true}}},"merge":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Patch/merge data","optional":true},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to update","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.client.api.domain.ClientEntity callback handler","optional":true}}},"patch":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Patch/merge data","optional":true},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to update","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.client.api.domain.ClientEntity callback handler","optional":true}}},"read":{"properties":{"edm":{"index":0,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm, read from calling read(null, $metdata, null, responseHandler)","optional":true},"endpointHttpHeaders":{"index":1,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"queryParams":{"index":2,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"OData query params http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc453752288","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OData Resource path","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}},"update":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Updated data","optional":true},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to update","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.client.api.domain.ClientEntity callback handler","optional":true}}},"uread":{"properties":{"edm":{"index":0,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm, read from calling read(null, $metdata, null, responseHandler)","optional":true},"endpointHttpHeaders":{"index":1,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"queryParams":{"index":2,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"OData query params http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc453752288","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OData Resource path","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}}}}}} +{"component":{"kind":"component","name":"olingo4","title":"Olingo4","description":"Communicate with OData 4.0 services using Apache Olingo OData API.","deprecated":false,"firstVersion":"2.19.0","label":"cloud","javaType":"org.apache.camel.component.olingo4.Olingo4Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-olingo4","version":"4.8.2","scheme":"olingo4","extendsScheme":"","syntax":"olingo4:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelOlingo4.responseHttpHeaders":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response Http headers","constantName":"org.apache.camel.component.olingo4.internal.Olingo4Constants#FULL_RESPONSE_HTTP_HEADERS"}},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.olingo4.internal.Olingo4ApiName","enum":["DEFAULT"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"connectTimeout":{"index":2,"kind":"parameter","displayName":"Connect Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds)"},"contentType":{"index":3,"kind":"parameter","displayName":"Content Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"application/json;charset=utf-8","configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8"},"filterAlreadySeen":{"index":4,"kind":"parameter","displayName":"Filter Already Seen","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"Set this to true to filter out results that have already been communicated by this component."},"httpHeaders":{"index":5,"kind":"parameter","displayName":"Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"Custom HTTP headers to inject into every request, this could include OAuth tokens, etc."},"inBody":{"index":6,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"proxy":{"index":7,"kind":"parameter","displayName":"Proxy","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.http.HttpHost","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"HTTP proxy server configuration"},"serviceUri":{"index":8,"kind":"parameter","displayName":"Service Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"Target OData service base URI, e.g. http://services.odata.org/OData/OData.svc"},"socketTimeout":{"index":9,"kind":"parameter","displayName":"Socket Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds)"},"sendEmptyMessageWhenIdle":{"index":10,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"splitResult":{"index":11,"kind":"parameter","displayName":"Split Result","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":15,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":16,"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."},"httpAsyncClientBuilder":{"index":17,"kind":"parameter","displayName":"Http Async Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.http.impl.nio.client.HttpAsyncClientBuilder","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely"},"httpClientBuilder":{"index":18,"kind":"parameter","displayName":"Http Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.http.impl.client.HttpClientBuilder","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely"},"backoffErrorThreshold":{"index":19,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":20,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":21,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":22,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":23,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":24,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":25,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":26,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":27,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":28,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":29,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":30,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":31,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":32,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"sslContextParameters":{"index":33,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.olingo4.Olingo4Configuration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}},"apis":{"DEFAULT":{"consumerOnly":false,"producerOnly":false,"description":"Olingo4 Client Api Interface","methods":{"action":{"description":"Calls a OData action","signatures":["void action(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]},"batch":{"description":"Executes a batch request","signatures":["void batch(org.apache.olingo.commons.api.edm.Edm edm, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler> responseHandler)"]},"create":{"description":"Creates a new OData resource","signatures":["void create(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]},"delete":{"description":"Deletes an OData resource and invokes callback with org","signatures":["void delete(String resourcePath, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]},"merge":{"description":"Patches/merges an OData resource using HTTP MERGE","signatures":["void merge(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]},"patch":{"description":"Patches/merges an OData resource using HTTP PATCH","signatures":["void patch(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]},"read":{"description":"Reads an OData resource and invokes callback with appropriate result","signatures":["void read(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map queryParams, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]},"update":{"description":"Updates an OData resource","signatures":["void update(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]},"uread":{"description":"Reads an OData resource and invokes callback with the unparsed input stream","signatures":["void uread(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map queryParams, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)"]}}}},"apiProperties":{"DEFAULT":{"methods":{"action":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Action data","optional":true},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to action","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.client.api.domain.ClientEntity callback handler","optional":true}}},"batch":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Ordered org.apache.camel.component.olingo4.api.batch.Olingo4BatchRequest list","optional":true},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"responseHandler":{"index":3,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}},"create":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Request data","optional":true},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to create","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}},"delete":{"properties":{"endpointHttpHeaders":{"index":0,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":1,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path for Entry","optional":false},"responseHandler":{"index":2,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.commons.api.http.HttpStatusCode callback handler","optional":true}}},"merge":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Patch/merge data","optional":true},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to update","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.client.api.domain.ClientEntity callback handler","optional":true}}},"patch":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Patch/merge data","optional":true},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to update","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.client.api.domain.ClientEntity callback handler","optional":true}}},"read":{"properties":{"edm":{"index":0,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm, read from calling read(null, $metdata, null, responseHandler)","optional":true},"endpointHttpHeaders":{"index":1,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"queryParams":{"index":2,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"OData query params http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc453752288","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OData Resource path","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}},"update":{"properties":{"data":{"index":0,"kind":"parameter","displayName":"Data","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Updated data","optional":true},"edm":{"index":1,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm","optional":true},"endpointHttpHeaders":{"index":2,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Resource path to update","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Org.apache.olingo.client.api.domain.ClientEntity callback handler","optional":true}}},"uread":{"properties":{"edm":{"index":0,"kind":"parameter","displayName":"Edm","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.olingo.commons.api.edm.Edm","deprecated":false,"autowired":false,"secret":false,"description":"Service Edm, read from calling read(null, $metdata, null, responseHandler)","optional":true},"endpointHttpHeaders":{"index":1,"kind":"parameter","displayName":"Endpoint Http Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"HTTP Headers to add/override the component versions","optional":true},"queryParams":{"index":2,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"OData query params http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc453752288","optional":true},"resourcePath":{"index":3,"kind":"parameter","displayName":"Resource Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"OData Resource path","optional":false},"responseHandler":{"index":4,"kind":"parameter","displayName":"Response Handler","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.olingo4.api.Olingo4ResponseHandler","deprecated":false,"autowired":false,"secret":false,"description":"Callback handler","optional":true}}}}}}} , -{"component":{"kind":"component","name":"opensearch","title":"OpenSearch","description":"Send requests to OpenSearch via Java Client API.","deprecated":false,"firstVersion":"4.0.0","label":"search,monitoring","javaType":"org.apache.camel.component.opensearch.OpensearchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-opensearch","version":"4.8.1","scheme":"opensearch","extendsScheme":"","syntax":"opensearch:clusterName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"operation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.opensearch.OpensearchOperation","enum":["Index","Update","Bulk","GetById","MultiGet","MultiSearch","Delete","DeleteIndex","Search","Exists","Ping"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_OPERATION"},"indexId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the indexed document.","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_INDEX_ID"},"indexName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the index to act against","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_INDEX_NAME"},"documentClass":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"ObjectNode","description":"The full qualified name of the class of the document to unmarshall","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_DOCUMENT_CLASS"},"waitForActiveShards":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index creation waits for the write consistency number of shards to be available","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_WAIT_FOR_ACTIVE_SHARDS"},"scrollKeepAliveMs":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The starting index of the response.","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_SCROLL_KEEP_ALIVE_MS"},"useScroll":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set to true to enable scroll usage","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_SCROLL"},"size":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the response.","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_SIZE"},"from":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The starting index of the response.","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_FROM"}},"properties":{"clusterName":{"index":0,"kind":"path","displayName":"Cluster Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Name of the cluster"},"connectionTimeout":{"index":1,"kind":"parameter","displayName":"Connection Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The time in ms to wait before connection will time out."},"disconnect":{"index":2,"kind":"parameter","displayName":"Disconnect","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Disconnect after it finish calling the producer"},"from":{"index":3,"kind":"parameter","displayName":"From","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Starting index of the response."},"hostAddresses":{"index":4,"kind":"parameter","displayName":"Host Addresses","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Comma separated list with ip:port formatted remote transport addresses to use."},"indexName":{"index":5,"kind":"parameter","displayName":"Index Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The name of the index to act against"},"maxRetryTimeout":{"index":6,"kind":"parameter","displayName":"Max Retry Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The time in ms before retry"},"operation":{"index":7,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.opensearch.OpensearchOperation","enum":["Index","Update","Bulk","GetById","MultiGet","MultiSearch","Delete","DeleteIndex","Search","Exists","Ping"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"What operation to perform"},"scrollKeepAliveMs":{"index":8,"kind":"parameter","displayName":"Scroll Keep Alive Ms","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Time in ms during which OpenSearch will keep search context alive"},"size":{"index":9,"kind":"parameter","displayName":"Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Size of the response."},"socketTimeout":{"index":10,"kind":"parameter","displayName":"Socket Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The timeout in ms to wait before the socket will time out."},"useScroll":{"index":11,"kind":"parameter","displayName":"Use Scroll","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Enable scroll usage"},"waitForActiveShards":{"index":12,"kind":"parameter","displayName":"Wait For Active Shards","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Index creation waits for the write consistency number of shards to be available"},"lazyStartProducer":{"index":13,"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."},"documentClass":{"index":14,"kind":"parameter","displayName":"Document Class","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ObjectNode","configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The class to use when deserializing the documents."},"enableSniffer":{"index":15,"kind":"parameter","displayName":"Enable Sniffer","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Enable automatically discover nodes from a running OpenSearch cluster. If this option is used in conjunction with Spring Boot, then it's managed by the Spring Boot configuration (see: Disable Sniffer in Spring Boot)."},"sniffAfterFailureDelay":{"index":16,"kind":"parameter","displayName":"Sniff After Failure Delay","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The delay of a sniff execution scheduled after a failure (in milliseconds)"},"snifferInterval":{"index":17,"kind":"parameter","displayName":"Sniffer Interval","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":300000,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions"},"certificatePath":{"index":18,"kind":"parameter","displayName":"Certificate Path","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The certificate that can be used to access the ES Cluster. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"enableSSL":{"index":19,"kind":"parameter","displayName":"Enable SSL","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Enable SSL"}}} +{"component":{"kind":"component","name":"opensearch","title":"OpenSearch","description":"Send requests to OpenSearch via Java Client API.","deprecated":false,"firstVersion":"4.0.0","label":"search,monitoring","javaType":"org.apache.camel.component.opensearch.OpensearchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-opensearch","version":"4.8.2","scheme":"opensearch","extendsScheme":"","syntax":"opensearch:clusterName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"operation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.opensearch.OpensearchOperation","enum":["Index","Update","Bulk","GetById","MultiGet","MultiSearch","Delete","DeleteIndex","Search","Exists","Ping"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_OPERATION"},"indexId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the indexed document.","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_INDEX_ID"},"indexName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the index to act against","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_INDEX_NAME"},"documentClass":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"ObjectNode","description":"The full qualified name of the class of the document to unmarshall","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_DOCUMENT_CLASS"},"waitForActiveShards":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index creation waits for the write consistency number of shards to be available","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_WAIT_FOR_ACTIVE_SHARDS"},"scrollKeepAliveMs":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The starting index of the response.","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_SCROLL_KEEP_ALIVE_MS"},"useScroll":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set to true to enable scroll usage","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_SCROLL"},"size":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the response.","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_SIZE"},"from":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The starting index of the response.","constantName":"org.apache.camel.component.opensearch.OpensearchConstants#PARAM_FROM"}},"properties":{"clusterName":{"index":0,"kind":"path","displayName":"Cluster Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Name of the cluster"},"connectionTimeout":{"index":1,"kind":"parameter","displayName":"Connection Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The time in ms to wait before connection will time out."},"disconnect":{"index":2,"kind":"parameter","displayName":"Disconnect","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Disconnect after it finish calling the producer"},"from":{"index":3,"kind":"parameter","displayName":"From","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Starting index of the response."},"hostAddresses":{"index":4,"kind":"parameter","displayName":"Host Addresses","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Comma separated list with ip:port formatted remote transport addresses to use."},"indexName":{"index":5,"kind":"parameter","displayName":"Index Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The name of the index to act against"},"maxRetryTimeout":{"index":6,"kind":"parameter","displayName":"Max Retry Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The time in ms before retry"},"operation":{"index":7,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.opensearch.OpensearchOperation","enum":["Index","Update","Bulk","GetById","MultiGet","MultiSearch","Delete","DeleteIndex","Search","Exists","Ping"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"What operation to perform"},"scrollKeepAliveMs":{"index":8,"kind":"parameter","displayName":"Scroll Keep Alive Ms","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Time in ms during which OpenSearch will keep search context alive"},"size":{"index":9,"kind":"parameter","displayName":"Size","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Size of the response."},"socketTimeout":{"index":10,"kind":"parameter","displayName":"Socket Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The timeout in ms to wait before the socket will time out."},"useScroll":{"index":11,"kind":"parameter","displayName":"Use Scroll","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Enable scroll usage"},"waitForActiveShards":{"index":12,"kind":"parameter","displayName":"Wait For Active Shards","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Index creation waits for the write consistency number of shards to be available"},"lazyStartProducer":{"index":13,"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."},"documentClass":{"index":14,"kind":"parameter","displayName":"Document Class","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ObjectNode","configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The class to use when deserializing the documents."},"enableSniffer":{"index":15,"kind":"parameter","displayName":"Enable Sniffer","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Enable automatically discover nodes from a running OpenSearch cluster. If this option is used in conjunction with Spring Boot, then it's managed by the Spring Boot configuration (see: Disable Sniffer in Spring Boot)."},"sniffAfterFailureDelay":{"index":16,"kind":"parameter","displayName":"Sniff After Failure Delay","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The delay of a sniff execution scheduled after a failure (in milliseconds)"},"snifferInterval":{"index":17,"kind":"parameter","displayName":"Sniffer Interval","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":300000,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions"},"certificatePath":{"index":18,"kind":"parameter","displayName":"Certificate Path","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"The certificate that can be used to access the ES Cluster. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."},"enableSSL":{"index":19,"kind":"parameter","displayName":"Enable SSL","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.opensearch.OpensearchConfiguration","configurationField":"configuration","description":"Enable SSL"}}} , -{"component":{"kind":"component","name":"openshift-build-configs","title":"Openshift Build Config","description":"Perform operations on OpenShift Build Configs.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.openshift.build_configs.OpenshiftBuildConfigsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"openshift-build-configs","extendsScheme":"","syntax":"openshift-build-configs:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesBuildConfigsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Openshift Config Build labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_BUILD_CONFIGS_LABELS"},"CamelKubernetesBuildConfigName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Openshift Config Build name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_BUILD_CONFIG_NAME"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"openshift-build-configs","title":"Openshift Build Config","description":"Perform operations on OpenShift Build Configs.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.openshift.build_configs.OpenshiftBuildConfigsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"openshift-build-configs","extendsScheme":"","syntax":"openshift-build-configs:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesBuildConfigsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Openshift Config Build labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_BUILD_CONFIGS_LABELS"},"CamelKubernetesBuildConfigName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Openshift Config Build name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_BUILD_CONFIG_NAME"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"openshift-builds","title":"Openshift Builds","description":"Perform operations on OpenShift Builds.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.openshift.builds.OpenshiftBuildsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"openshift-builds","extendsScheme":"","syntax":"openshift-builds:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesBuildsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Openshift build labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_BUILDS_LABELS"},"CamelKubernetesBuildName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Openshift build name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_BUILD_NAME"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"openshift-builds","title":"Openshift Builds","description":"Perform operations on OpenShift Builds.","deprecated":false,"firstVersion":"2.17.0","label":"container,cloud","javaType":"org.apache.camel.component.openshift.builds.OpenshiftBuildsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"openshift-builds","extendsScheme":"","syntax":"openshift-builds:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesBuildsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Openshift build labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_BUILDS_LABELS"},"CamelKubernetesBuildName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Openshift build name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_BUILD_NAME"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"producer","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"operation":{"index":5,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"portName":{"index":6,"kind":"parameter","displayName":"Port Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":7,"kind":"parameter","displayName":"Port Protocol","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"lazyStartProducer":{"index":8,"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."},"connectionTimeout":{"index":9,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":10,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":11,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":12,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":13,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":14,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":15,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":16,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":17,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":18,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":20,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":21,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"openshift-deploymentconfigs","title":"Openshift Deployment Configs","description":"Perform operations on Openshift Deployment Configs and get notified on Deployment Config changes.","deprecated":false,"firstVersion":"3.18.0","label":"container,cloud","javaType":"org.apache.camel.component.openshift.deploymentconfigs.OpenshiftDeploymentConfigsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.1","scheme":"openshift-deploymentconfigs","extendsScheme":"","syntax":"openshift-deploymentconfigs:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesDeploymentsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENTS_LABELS"},"CamelKubernetesDeploymentsAnnotations":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENTS_ANNOTATIONS"},"CamelKubernetesDeploymentName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENT_NAME"},"CamelKubernetesDeploymentReplicas":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The desired instance count","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENT_REPLICAS"},"CamelKubernetesDeploymentConfigSpec":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.openshift.api.model.DeploymentConfigSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a deployment config","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENT_CONFIG_SPEC"},"CamelKubernetesEventAction":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} +{"component":{"kind":"component","name":"openshift-deploymentconfigs","title":"Openshift Deployment Configs","description":"Perform operations on Openshift Deployment Configs and get notified on Deployment Config changes.","deprecated":false,"firstVersion":"3.18.0","label":"container,cloud","javaType":"org.apache.camel.component.openshift.deploymentconfigs.OpenshiftDeploymentConfigsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-kubernetes","version":"4.8.2","scheme":"openshift-deploymentconfigs","extendsScheme":"","syntax":"openshift-deploymentconfigs:masterUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelKubernetesOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Producer operation","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_OPERATION"},"CamelKubernetesNamespaceName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_NAMESPACE_NAME"},"CamelKubernetesDeploymentsLabels":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENTS_LABELS"},"CamelKubernetesDeploymentsAnnotations":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment labels","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENTS_ANNOTATIONS"},"CamelKubernetesDeploymentName":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment name","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENT_NAME"},"CamelKubernetesDeploymentReplicas":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The desired instance count","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENT_REPLICAS"},"CamelKubernetesDeploymentConfigSpec":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"io.fabric8.openshift.api.model.DeploymentConfigSpec","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The spec for a deployment config","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_DEPLOYMENT_CONFIG_SPEC"},"CamelKubernetesEventAction":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.fabric8.kubernetes.client.Watcher.Action","enum":["ADDED","MODIFIED","DELETED","ERROR","BOOKMARK"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_ACTION"},"CamelKubernetesEventTimestamp":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Timestamp of the action watched by the consumer","constantName":"org.apache.camel.component.kubernetes.KubernetesConstants#KUBERNETES_EVENT_TIMESTAMP"}},"properties":{"masterUrl":{"index":0,"kind":"path","displayName":"Master Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc."},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Kubernetes API Version to use"},"dnsDomain":{"index":2,"kind":"parameter","displayName":"Dns Domain","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The dns domain, used for ServiceCall EIP"},"kubernetesClient":{"index":3,"kind":"parameter","displayName":"Kubernetes Client","group":"common","label":"","required":false,"type":"object","javaType":"io.fabric8.kubernetes.client.KubernetesClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Default KubernetesClient to use if provided"},"namespace":{"index":4,"kind":"parameter","displayName":"Namespace","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The namespace"},"portName":{"index":5,"kind":"parameter","displayName":"Port Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port name, used for ServiceCall EIP"},"portProtocol":{"index":6,"kind":"parameter","displayName":"Port Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp","configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The port protocol, used for ServiceCall EIP"},"crdGroup":{"index":7,"kind":"parameter","displayName":"Crd Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Group we would like to watch"},"crdName":{"index":8,"kind":"parameter","displayName":"Crd Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource name we would like to watch"},"crdPlural":{"index":9,"kind":"parameter","displayName":"Crd Plural","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Plural we would like to watch"},"crdScope":{"index":10,"kind":"parameter","displayName":"Crd Scope","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Scope we would like to watch"},"crdVersion":{"index":11,"kind":"parameter","displayName":"Crd Version","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer CRD Resource Version we would like to watch"},"labelKey":{"index":12,"kind":"parameter","displayName":"Label Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label key when watching at some resources"},"labelValue":{"index":13,"kind":"parameter","displayName":"Label Value","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Label value when watching at some resources"},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer pool size"},"resourceName":{"index":15,"kind":"parameter","displayName":"Resource Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Consumer Resource Name we would like to watch"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":19,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Producer operation to do on Kubernetes"},"lazyStartProducer":{"index":20,"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."},"connectionTimeout":{"index":21,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Connection timeout in milliseconds to use when making requests to the Kubernetes API server."},"caCertData":{"index":22,"kind":"parameter","displayName":"Ca Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert Data"},"caCertFile":{"index":23,"kind":"parameter","displayName":"Ca Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The CA Cert File"},"clientCertData":{"index":24,"kind":"parameter","displayName":"Client Cert Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert Data"},"clientCertFile":{"index":25,"kind":"parameter","displayName":"Client Cert File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Cert File"},"clientKeyAlgo":{"index":26,"kind":"parameter","displayName":"Client Key Algo","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Key Algorithm used by the client"},"clientKeyData":{"index":27,"kind":"parameter","displayName":"Client Key Data","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key data"},"clientKeyFile":{"index":28,"kind":"parameter","displayName":"Client Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key file"},"clientKeyPassphrase":{"index":29,"kind":"parameter","displayName":"Client Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Client Key Passphrase"},"oauthToken":{"index":30,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"The Auth Token"},"password":{"index":31,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Password to connect to Kubernetes"},"trustCerts":{"index":32,"kind":"parameter","displayName":"Trust Certs","group":"security","label":"security","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Define if the certs we used are trusted anyway or not"},"username":{"index":33,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.kubernetes.KubernetesConfiguration","configurationField":"configuration","description":"Username to connect to Kubernetes"}}} , -{"component":{"kind":"component","name":"openstack-cinder","title":"OpenStack Cinder","description":"Access data in OpenStack Cinder block storage.","deprecated":false,"firstVersion":"2.19.0","label":"container","javaType":"org.apache.camel.component.openstack.cinder.CinderComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-openstack","version":"4.8.1","scheme":"openstack-cinder","extendsScheme":"","syntax":"openstack-cinder:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"size":{"index":0,"kind":"header","displayName":"","group":"volume","label":"volume","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Size of volume.","constantName":"org.apache.camel.component.openstack.cinder.CinderConstants#SIZE"},"volumeType":{"index":1,"kind":"header","displayName":"","group":"volume","label":"volume","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Volume type.","constantName":"org.apache.camel.component.openstack.cinder.CinderConstants#VOLUME_TYPE"},"imageRef":{"index":2,"kind":"header","displayName":"","group":"volume","label":"volume","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of image.","constantName":"org.apache.camel.component.openstack.cinder.CinderConstants#IMAGE_REF"},"snapshotId":{"index":3,"kind":"header","displayName":"","group":"volume","label":"volume","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of snapshot.","constantName":"org.apache.camel.component.openstack.cinder.CinderConstants#SNAPSHOT_ID"},"isBootable":{"index":4,"kind":"header","displayName":"","group":"volume","label":"volume","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is bootable.","constantName":"org.apache.camel.component.openstack.cinder.CinderConstants#IS_BOOTABLE"},"volumeId":{"index":5,"kind":"header","displayName":"","group":"snapshot","label":"snapshot","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Volume ID.","constantName":"org.apache.camel.component.openstack.cinder.CinderConstants#VOLUME_ID"},"force":{"index":6,"kind":"header","displayName":"","group":"snapshot","label":"snapshot","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Force.","constantName":"org.apache.camel.component.openstack.cinder.CinderConstants#FORCE"},"operation":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#OPERATION"},"ID":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#ID"},"name":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#NAME"},"description":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The description.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#DESCRIPTION"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack host url"},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["V2","V3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"V3","description":"OpenStack API version"},"config":{"index":2,"kind":"parameter","displayName":"Config","group":"producer","label":"","required":false,"type":"object","javaType":"org.openstack4j.core.transport.Config","deprecated":false,"autowired":false,"secret":false,"description":"OpenStack configuration"},"domain":{"index":3,"kind":"parameter","displayName":"Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Authentication domain"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The operation to do"},"password":{"index":5,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack password"},"project":{"index":6,"kind":"parameter","displayName":"Project","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project ID"},"subsystem":{"index":7,"kind":"parameter","displayName":"Subsystem","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["snapshots","volumes"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack Cinder subsystem"},"username":{"index":8,"kind":"parameter","displayName":"Username","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack username"},"lazyStartProducer":{"index":9,"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."}}} +{"component":{"kind":"component","name":"openstack-cinder","title":"OpenStack Cinder","description":"Access data in OpenStack Cinder block storage.","deprecated":false,"firstVersion":"2.19.0","label":"container","javaType":"org.apache.camel.component.openstack.cinder.CinderComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-openstack","version":"4.8.2","scheme":"openstack-cinder","extendsScheme":"","syntax":"openstack-cinder:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"size":{"index":0,"kind":"header","displayName":"","group":"volume","label":"volume","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Size of volume.","constantName":"org.apache.camel.component.openstack.cinder.CinderConstants#SIZE"},"volumeType":{"index":1,"kind":"header","displayName":"","group":"volume","label":"volume","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Volume type.","constantName":"org.apache.camel.component.openstack.cinder.CinderConstants#VOLUME_TYPE"},"imageRef":{"index":2,"kind":"header","displayName":"","group":"volume","label":"volume","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of image.","constantName":"org.apache.camel.component.openstack.cinder.CinderConstants#IMAGE_REF"},"snapshotId":{"index":3,"kind":"header","displayName":"","group":"volume","label":"volume","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of snapshot.","constantName":"org.apache.camel.component.openstack.cinder.CinderConstants#SNAPSHOT_ID"},"isBootable":{"index":4,"kind":"header","displayName":"","group":"volume","label":"volume","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is bootable.","constantName":"org.apache.camel.component.openstack.cinder.CinderConstants#IS_BOOTABLE"},"volumeId":{"index":5,"kind":"header","displayName":"","group":"snapshot","label":"snapshot","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Volume ID.","constantName":"org.apache.camel.component.openstack.cinder.CinderConstants#VOLUME_ID"},"force":{"index":6,"kind":"header","displayName":"","group":"snapshot","label":"snapshot","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Force.","constantName":"org.apache.camel.component.openstack.cinder.CinderConstants#FORCE"},"operation":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#OPERATION"},"ID":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#ID"},"name":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#NAME"},"description":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The description.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#DESCRIPTION"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack host url"},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["V2","V3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"V3","description":"OpenStack API version"},"config":{"index":2,"kind":"parameter","displayName":"Config","group":"producer","label":"","required":false,"type":"object","javaType":"org.openstack4j.core.transport.Config","deprecated":false,"autowired":false,"secret":false,"description":"OpenStack configuration"},"domain":{"index":3,"kind":"parameter","displayName":"Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Authentication domain"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The operation to do"},"password":{"index":5,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack password"},"project":{"index":6,"kind":"parameter","displayName":"Project","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project ID"},"subsystem":{"index":7,"kind":"parameter","displayName":"Subsystem","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["snapshots","volumes"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack Cinder subsystem"},"username":{"index":8,"kind":"parameter","displayName":"Username","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack username"},"lazyStartProducer":{"index":9,"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."}}} , -{"component":{"kind":"component","name":"openstack-glance","title":"OpenStack Glance","description":"Manage VM images and metadata definitions in OpenStack Glance.","deprecated":false,"firstVersion":"2.19.0","label":"container","javaType":"org.apache.camel.component.openstack.glance.GlanceComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-openstack","version":"4.8.1","scheme":"openstack-glance","extendsScheme":"","syntax":"openstack-glance:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"diskFormat":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.openstack4j.model.image.DiskFormat","enum":["RAW","VHD","VMDK","VDI","ISO","QCOW2","AKI","ARI","AMI","UNRECOGNIZED"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of flavor VCPU.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#DISK_FORMAT"},"containerFormat":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.openstack4j.model.image.ContainerFormat","enum":["BARE","OVF","AKI","ARI","AMI","DOCKER","UNRECOGNIZED"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Size of RAM.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#CONTAINER_FORMAT"},"owner":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Image owner.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#OWNER"},"isPublic":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is public.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#IS_PUBLIC"},"minRam":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Minimum ram.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#MIN_RAM"},"minDisk":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Minimum disk.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#MIN_DISK"},"size":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Size.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#SIZE"},"checksum":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Checksum.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#CHECKSUM"},"operation":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#OPERATION"},"ID":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#ID"},"name":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#NAME"},"properties":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The image properties.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#PROPERTIES"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack host url"},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["V2","V3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"V3","description":"OpenStack API version"},"config":{"index":2,"kind":"parameter","displayName":"Config","group":"producer","label":"","required":false,"type":"object","javaType":"org.openstack4j.core.transport.Config","deprecated":false,"autowired":false,"secret":false,"description":"OpenStack configuration"},"domain":{"index":3,"kind":"parameter","displayName":"Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Authentication domain"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The operation to do"},"password":{"index":5,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack password"},"project":{"index":6,"kind":"parameter","displayName":"Project","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project ID"},"username":{"index":7,"kind":"parameter","displayName":"Username","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack username"},"lazyStartProducer":{"index":8,"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."}}} +{"component":{"kind":"component","name":"openstack-glance","title":"OpenStack Glance","description":"Manage VM images and metadata definitions in OpenStack Glance.","deprecated":false,"firstVersion":"2.19.0","label":"container","javaType":"org.apache.camel.component.openstack.glance.GlanceComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-openstack","version":"4.8.2","scheme":"openstack-glance","extendsScheme":"","syntax":"openstack-glance:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"diskFormat":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.openstack4j.model.image.DiskFormat","enum":["RAW","VHD","VMDK","VDI","ISO","QCOW2","AKI","ARI","AMI","UNRECOGNIZED"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of flavor VCPU.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#DISK_FORMAT"},"containerFormat":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.openstack4j.model.image.ContainerFormat","enum":["BARE","OVF","AKI","ARI","AMI","DOCKER","UNRECOGNIZED"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Size of RAM.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#CONTAINER_FORMAT"},"owner":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Image owner.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#OWNER"},"isPublic":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is public.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#IS_PUBLIC"},"minRam":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Minimum ram.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#MIN_RAM"},"minDisk":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Minimum disk.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#MIN_DISK"},"size":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Size.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#SIZE"},"checksum":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Checksum.","constantName":"org.apache.camel.component.openstack.glance.GlanceConstants#CHECKSUM"},"operation":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#OPERATION"},"ID":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#ID"},"name":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#NAME"},"properties":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The image properties.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#PROPERTIES"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack host url"},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["V2","V3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"V3","description":"OpenStack API version"},"config":{"index":2,"kind":"parameter","displayName":"Config","group":"producer","label":"","required":false,"type":"object","javaType":"org.openstack4j.core.transport.Config","deprecated":false,"autowired":false,"secret":false,"description":"OpenStack configuration"},"domain":{"index":3,"kind":"parameter","displayName":"Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Authentication domain"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The operation to do"},"password":{"index":5,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack password"},"project":{"index":6,"kind":"parameter","displayName":"Project","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project ID"},"username":{"index":7,"kind":"parameter","displayName":"Username","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack username"},"lazyStartProducer":{"index":8,"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."}}} , -{"component":{"kind":"component","name":"openstack-keystone","title":"OpenStack Keystone","description":"Access OpenStack Keystone for API client authentication, service discovery and distributed multi-tenant authorization.","deprecated":false,"firstVersion":"2.19.0","label":"container","javaType":"org.apache.camel.component.openstack.keystone.KeystoneComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-openstack","version":"4.8.1","scheme":"openstack-keystone","extendsScheme":"","syntax":"openstack-keystone:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"description":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The description.","constantName":"org.apache.camel.component.openstack.keystone.KeystoneConstants#DESCRIPTION"},"domainId":{"index":1,"kind":"header","displayName":"","group":"group project user","label":"group project user","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the domain.","constantName":"org.apache.camel.component.openstack.keystone.KeystoneConstants#DOMAIN_ID"},"parentId":{"index":2,"kind":"header","displayName":"","group":"project","label":"project","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent project ID.","constantName":"org.apache.camel.component.openstack.keystone.KeystoneConstants#PARENT_ID"},"password":{"index":3,"kind":"header","displayName":"","group":"user","label":"user","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"User's password.","constantName":"org.apache.camel.component.openstack.keystone.KeystoneConstants#PASSWORD"},"email":{"index":4,"kind":"header","displayName":"","group":"user","label":"user","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"User's email.","constantName":"org.apache.camel.component.openstack.keystone.KeystoneConstants#EMAIL"},"userId":{"index":5,"kind":"header","displayName":"","group":"group","label":"group","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the user.","constantName":"org.apache.camel.component.openstack.keystone.KeystoneConstants#USER_ID"},"groupId":{"index":6,"kind":"header","displayName":"","group":"group","label":"group","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the group.","constantName":"org.apache.camel.component.openstack.keystone.KeystoneConstants#GROUP_ID"},"operation":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#OPERATION"},"ID":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#ID"},"name":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#NAME"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack host url"},"config":{"index":1,"kind":"parameter","displayName":"Config","group":"producer","label":"","required":false,"type":"object","javaType":"org.openstack4j.core.transport.Config","deprecated":false,"autowired":false,"secret":false,"description":"OpenStack configuration"},"domain":{"index":2,"kind":"parameter","displayName":"Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Authentication domain"},"operation":{"index":3,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The operation to do"},"password":{"index":4,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack password"},"project":{"index":5,"kind":"parameter","displayName":"Project","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project ID"},"subsystem":{"index":6,"kind":"parameter","displayName":"Subsystem","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["regions","domains","projects","users","groups"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack Keystone subsystem"},"username":{"index":7,"kind":"parameter","displayName":"Username","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack username"},"lazyStartProducer":{"index":8,"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."}}} +{"component":{"kind":"component","name":"openstack-keystone","title":"OpenStack Keystone","description":"Access OpenStack Keystone for API client authentication, service discovery and distributed multi-tenant authorization.","deprecated":false,"firstVersion":"2.19.0","label":"container","javaType":"org.apache.camel.component.openstack.keystone.KeystoneComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-openstack","version":"4.8.2","scheme":"openstack-keystone","extendsScheme":"","syntax":"openstack-keystone:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"description":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The description.","constantName":"org.apache.camel.component.openstack.keystone.KeystoneConstants#DESCRIPTION"},"domainId":{"index":1,"kind":"header","displayName":"","group":"group project user","label":"group project user","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the domain.","constantName":"org.apache.camel.component.openstack.keystone.KeystoneConstants#DOMAIN_ID"},"parentId":{"index":2,"kind":"header","displayName":"","group":"project","label":"project","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent project ID.","constantName":"org.apache.camel.component.openstack.keystone.KeystoneConstants#PARENT_ID"},"password":{"index":3,"kind":"header","displayName":"","group":"user","label":"user","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"User's password.","constantName":"org.apache.camel.component.openstack.keystone.KeystoneConstants#PASSWORD"},"email":{"index":4,"kind":"header","displayName":"","group":"user","label":"user","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"User's email.","constantName":"org.apache.camel.component.openstack.keystone.KeystoneConstants#EMAIL"},"userId":{"index":5,"kind":"header","displayName":"","group":"group","label":"group","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the user.","constantName":"org.apache.camel.component.openstack.keystone.KeystoneConstants#USER_ID"},"groupId":{"index":6,"kind":"header","displayName":"","group":"group","label":"group","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the group.","constantName":"org.apache.camel.component.openstack.keystone.KeystoneConstants#GROUP_ID"},"operation":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#OPERATION"},"ID":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#ID"},"name":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#NAME"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack host url"},"config":{"index":1,"kind":"parameter","displayName":"Config","group":"producer","label":"","required":false,"type":"object","javaType":"org.openstack4j.core.transport.Config","deprecated":false,"autowired":false,"secret":false,"description":"OpenStack configuration"},"domain":{"index":2,"kind":"parameter","displayName":"Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Authentication domain"},"operation":{"index":3,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The operation to do"},"password":{"index":4,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack password"},"project":{"index":5,"kind":"parameter","displayName":"Project","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project ID"},"subsystem":{"index":6,"kind":"parameter","displayName":"Subsystem","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["regions","domains","projects","users","groups"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack Keystone subsystem"},"username":{"index":7,"kind":"parameter","displayName":"Username","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack username"},"lazyStartProducer":{"index":8,"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."}}} , -{"component":{"kind":"component","name":"openstack-neutron","title":"OpenStack Neutron","description":"Access OpenStack Neutron for network services.","deprecated":false,"firstVersion":"2.19.0","label":"container","javaType":"org.apache.camel.component.openstack.neutron.NeutronComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-openstack","version":"4.8.1","scheme":"openstack-neutron","extendsScheme":"","syntax":"openstack-neutron:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"tenantId":{"index":0,"kind":"header","displayName":"","group":"network port router","label":"network port router","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tenant ID.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#TENANT_ID"},"networkId":{"index":1,"kind":"header","displayName":"","group":"subnet port","label":"subnet port","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Network ID.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#NETWORK_ID"},"adminStateUp":{"index":2,"kind":"header","displayName":"","group":"network","label":"network","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"AdminStateUp header.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#ADMIN_STATE_UP"},"networkType":{"index":3,"kind":"header","displayName":"","group":"network","label":"network","required":false,"javaType":"org.openstack4j.model.network.NetworkType","enum":["LOCAL","FLAT","VLAN","VXLAN","GRE","GENEVE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Network type.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#NETWORK_TYPE"},"physicalNetwork":{"index":4,"kind":"header","displayName":"","group":"network","label":"network","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Physical network.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#PHYSICAL_NETWORK"},"segmentId":{"index":5,"kind":"header","displayName":"","group":"network","label":"network","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Segment ID.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#SEGMENT_ID"},"isShared":{"index":6,"kind":"header","displayName":"","group":"network","label":"network","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is shared.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#IS_SHARED"},"isRouterExternal":{"index":7,"kind":"header","displayName":"","group":"network","label":"network","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is router external.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#IS_ROUTER_EXTERNAL"},"enableDHCP":{"index":8,"kind":"header","displayName":"","group":"subnet","label":"subnet","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Enable DHCP.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#ENABLE_DHCP"},"gateway":{"index":9,"kind":"header","displayName":"","group":"subnet","label":"subnet","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gateway.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#GATEWAY"},"ipVersion":{"index":10,"kind":"header","displayName":"","group":"subnet","label":"subnet","required":false,"javaType":"org.openstack4j.model.network.IPVersionType","enum":["V4","V6"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"IP version.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#IP_VERSION"},"cidr":{"index":11,"kind":"header","displayName":"","group":"subnet","label":"subnet","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cidr representing the IP range for this subnet, based on IP version.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#CIDR"},"subnetPools":{"index":12,"kind":"header","displayName":"","group":"subnet","label":"subnet","required":false,"javaType":"org.openstack4j.openstack.networking.domain.NeutronPool","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The allocation pool.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#SUBNET_POOL"},"deviceId":{"index":13,"kind":"header","displayName":"","group":"port","label":"port","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Device ID.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#DEVICE_ID"},"macAddress":{"index":14,"kind":"header","displayName":"","group":"port","label":"port","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MAC address.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#MAC_ADDRESS"},"routerId":{"index":15,"kind":"header","displayName":"","group":"router","label":"router","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Router ID.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#ROUTER_ID"},"subnetId":{"index":16,"kind":"header","displayName":"","group":"router subnet","label":"router subnet","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Subnet ID.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#SUBNET_ID"},"portId":{"index":17,"kind":"header","displayName":"","group":"port router","label":"port router","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Port ID.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#PORT_ID"},"interfaceType":{"index":18,"kind":"header","displayName":"","group":"router","label":"router","required":false,"javaType":"org.openstack4j.model.network.AttachInterfaceType","enum":["PORT","SUBNET"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Interface type.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#ITERFACE_TYPE"},"operation":{"index":19,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#OPERATION"},"ID":{"index":20,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#ID"},"name":{"index":21,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#NAME"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack host url"},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["V2","V3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"V3","description":"OpenStack API version"},"config":{"index":2,"kind":"parameter","displayName":"Config","group":"producer","label":"","required":false,"type":"object","javaType":"org.openstack4j.core.transport.Config","deprecated":false,"autowired":false,"secret":false,"description":"OpenStack configuration"},"domain":{"index":3,"kind":"parameter","displayName":"Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Authentication domain"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The operation to do"},"password":{"index":5,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack password"},"project":{"index":6,"kind":"parameter","displayName":"Project","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project ID"},"subsystem":{"index":7,"kind":"parameter","displayName":"Subsystem","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["networks","subnets","ports","routers"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack Neutron subsystem"},"username":{"index":8,"kind":"parameter","displayName":"Username","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack username"},"lazyStartProducer":{"index":9,"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."}}} +{"component":{"kind":"component","name":"openstack-neutron","title":"OpenStack Neutron","description":"Access OpenStack Neutron for network services.","deprecated":false,"firstVersion":"2.19.0","label":"container","javaType":"org.apache.camel.component.openstack.neutron.NeutronComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-openstack","version":"4.8.2","scheme":"openstack-neutron","extendsScheme":"","syntax":"openstack-neutron:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"tenantId":{"index":0,"kind":"header","displayName":"","group":"network port router","label":"network port router","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tenant ID.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#TENANT_ID"},"networkId":{"index":1,"kind":"header","displayName":"","group":"subnet port","label":"subnet port","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Network ID.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#NETWORK_ID"},"adminStateUp":{"index":2,"kind":"header","displayName":"","group":"network","label":"network","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"AdminStateUp header.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#ADMIN_STATE_UP"},"networkType":{"index":3,"kind":"header","displayName":"","group":"network","label":"network","required":false,"javaType":"org.openstack4j.model.network.NetworkType","enum":["LOCAL","FLAT","VLAN","VXLAN","GRE","GENEVE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Network type.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#NETWORK_TYPE"},"physicalNetwork":{"index":4,"kind":"header","displayName":"","group":"network","label":"network","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Physical network.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#PHYSICAL_NETWORK"},"segmentId":{"index":5,"kind":"header","displayName":"","group":"network","label":"network","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Segment ID.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#SEGMENT_ID"},"isShared":{"index":6,"kind":"header","displayName":"","group":"network","label":"network","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is shared.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#IS_SHARED"},"isRouterExternal":{"index":7,"kind":"header","displayName":"","group":"network","label":"network","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is router external.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#IS_ROUTER_EXTERNAL"},"enableDHCP":{"index":8,"kind":"header","displayName":"","group":"subnet","label":"subnet","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Enable DHCP.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#ENABLE_DHCP"},"gateway":{"index":9,"kind":"header","displayName":"","group":"subnet","label":"subnet","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gateway.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#GATEWAY"},"ipVersion":{"index":10,"kind":"header","displayName":"","group":"subnet","label":"subnet","required":false,"javaType":"org.openstack4j.model.network.IPVersionType","enum":["V4","V6"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"IP version.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#IP_VERSION"},"cidr":{"index":11,"kind":"header","displayName":"","group":"subnet","label":"subnet","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cidr representing the IP range for this subnet, based on IP version.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#CIDR"},"subnetPools":{"index":12,"kind":"header","displayName":"","group":"subnet","label":"subnet","required":false,"javaType":"org.openstack4j.openstack.networking.domain.NeutronPool","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The allocation pool.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#SUBNET_POOL"},"deviceId":{"index":13,"kind":"header","displayName":"","group":"port","label":"port","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Device ID.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#DEVICE_ID"},"macAddress":{"index":14,"kind":"header","displayName":"","group":"port","label":"port","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"MAC address.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#MAC_ADDRESS"},"routerId":{"index":15,"kind":"header","displayName":"","group":"router","label":"router","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Router ID.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#ROUTER_ID"},"subnetId":{"index":16,"kind":"header","displayName":"","group":"router subnet","label":"router subnet","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Subnet ID.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#SUBNET_ID"},"portId":{"index":17,"kind":"header","displayName":"","group":"port router","label":"port router","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Port ID.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#PORT_ID"},"interfaceType":{"index":18,"kind":"header","displayName":"","group":"router","label":"router","required":false,"javaType":"org.openstack4j.model.network.AttachInterfaceType","enum":["PORT","SUBNET"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Interface type.","constantName":"org.apache.camel.component.openstack.neutron.NeutronConstants#ITERFACE_TYPE"},"operation":{"index":19,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#OPERATION"},"ID":{"index":20,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#ID"},"name":{"index":21,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#NAME"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack host url"},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["V2","V3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"V3","description":"OpenStack API version"},"config":{"index":2,"kind":"parameter","displayName":"Config","group":"producer","label":"","required":false,"type":"object","javaType":"org.openstack4j.core.transport.Config","deprecated":false,"autowired":false,"secret":false,"description":"OpenStack configuration"},"domain":{"index":3,"kind":"parameter","displayName":"Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Authentication domain"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The operation to do"},"password":{"index":5,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack password"},"project":{"index":6,"kind":"parameter","displayName":"Project","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project ID"},"subsystem":{"index":7,"kind":"parameter","displayName":"Subsystem","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["networks","subnets","ports","routers"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack Neutron subsystem"},"username":{"index":8,"kind":"parameter","displayName":"Username","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack username"},"lazyStartProducer":{"index":9,"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."}}} , -{"component":{"kind":"component","name":"openstack-nova","title":"OpenStack Nova","description":"Access OpenStack to manage compute resources.","deprecated":false,"firstVersion":"2.19.0","label":"container","javaType":"org.apache.camel.component.openstack.nova.NovaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-openstack","version":"4.8.1","scheme":"openstack-nova","extendsScheme":"","syntax":"openstack-nova:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"FlavorId":{"index":0,"kind":"header","displayName":"","group":"flavor server","label":"flavor server","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the flavor.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#FLAVOR_ID"},"RAM":{"index":1,"kind":"header","displayName":"","group":"flavor","label":"flavor","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Size of RAM.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#RAM"},"VCPU":{"index":2,"kind":"header","displayName":"","group":"flavor","label":"flavor","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of flavor VCPU.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#VCPU"},"disk":{"index":3,"kind":"header","displayName":"","group":"flavor","label":"flavor","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Size of disk.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#DISK"},"swap":{"index":4,"kind":"header","displayName":"","group":"flavor","label":"flavor","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Size of swap.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#SWAP"},"rxtxFactor":{"index":5,"kind":"header","displayName":"","group":"flavor","label":"flavor","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Rxtx Factor.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#RXTXFACTOR"},"AdminPassword":{"index":6,"kind":"header","displayName":"","group":"server","label":"server","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Admin password of the new server.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#ADMIN_PASSWORD"},"ImageId":{"index":7,"kind":"header","displayName":"","group":"server","label":"server","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Image ID.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#IMAGE_ID"},"KeypairName":{"index":8,"kind":"header","displayName":"","group":"server","label":"server","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Keypair name.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#KEYPAIR_NAME"},"NetworkId":{"index":9,"kind":"header","displayName":"","group":"server","label":"server","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of networks (by id).","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#NETWORK"},"action":{"index":10,"kind":"header","displayName":"","group":"server","label":"server","required":false,"javaType":"org.openstack4j.model.compute.Action","enum":["PAUSE","UNPAUSE","STOP","START","LOCK","UNLOCK","SUSPEND","RESUME","RESCUE","UNRESCUE","SHELVE","SHELVE_OFFLOAD","UNSHELVE","FORCEDELETE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"An action to perform.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#ACTION"},"operation":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#OPERATION"},"ID":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#ID"},"name":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#NAME"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack host url"},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["V2","V3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"V3","description":"OpenStack API version"},"config":{"index":2,"kind":"parameter","displayName":"Config","group":"producer","label":"","required":false,"type":"object","javaType":"org.openstack4j.core.transport.Config","deprecated":false,"autowired":false,"secret":false,"description":"OpenStack configuration"},"domain":{"index":3,"kind":"parameter","displayName":"Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Authentication domain"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The operation to do"},"password":{"index":5,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack password"},"project":{"index":6,"kind":"parameter","displayName":"Project","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project ID"},"subsystem":{"index":7,"kind":"parameter","displayName":"Subsystem","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["flavors","servers","keypairs"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack Nova subsystem"},"username":{"index":8,"kind":"parameter","displayName":"Username","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack username"},"lazyStartProducer":{"index":9,"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."}}} +{"component":{"kind":"component","name":"openstack-nova","title":"OpenStack Nova","description":"Access OpenStack to manage compute resources.","deprecated":false,"firstVersion":"2.19.0","label":"container","javaType":"org.apache.camel.component.openstack.nova.NovaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-openstack","version":"4.8.2","scheme":"openstack-nova","extendsScheme":"","syntax":"openstack-nova:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"FlavorId":{"index":0,"kind":"header","displayName":"","group":"flavor server","label":"flavor server","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the flavor.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#FLAVOR_ID"},"RAM":{"index":1,"kind":"header","displayName":"","group":"flavor","label":"flavor","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Size of RAM.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#RAM"},"VCPU":{"index":2,"kind":"header","displayName":"","group":"flavor","label":"flavor","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of flavor VCPU.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#VCPU"},"disk":{"index":3,"kind":"header","displayName":"","group":"flavor","label":"flavor","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Size of disk.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#DISK"},"swap":{"index":4,"kind":"header","displayName":"","group":"flavor","label":"flavor","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Size of swap.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#SWAP"},"rxtxFactor":{"index":5,"kind":"header","displayName":"","group":"flavor","label":"flavor","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Rxtx Factor.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#RXTXFACTOR"},"AdminPassword":{"index":6,"kind":"header","displayName":"","group":"server","label":"server","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Admin password of the new server.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#ADMIN_PASSWORD"},"ImageId":{"index":7,"kind":"header","displayName":"","group":"server","label":"server","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Image ID.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#IMAGE_ID"},"KeypairName":{"index":8,"kind":"header","displayName":"","group":"server","label":"server","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Keypair name.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#KEYPAIR_NAME"},"NetworkId":{"index":9,"kind":"header","displayName":"","group":"server","label":"server","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of networks (by id).","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#NETWORK"},"action":{"index":10,"kind":"header","displayName":"","group":"server","label":"server","required":false,"javaType":"org.openstack4j.model.compute.Action","enum":["PAUSE","UNPAUSE","STOP","START","LOCK","UNLOCK","SUSPEND","RESUME","RESCUE","UNRESCUE","SHELVE","SHELVE_OFFLOAD","UNSHELVE","FORCEDELETE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"An action to perform.","constantName":"org.apache.camel.component.openstack.nova.NovaConstants#ACTION"},"operation":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#OPERATION"},"ID":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#ID"},"name":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#NAME"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack host url"},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["V2","V3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"V3","description":"OpenStack API version"},"config":{"index":2,"kind":"parameter","displayName":"Config","group":"producer","label":"","required":false,"type":"object","javaType":"org.openstack4j.core.transport.Config","deprecated":false,"autowired":false,"secret":false,"description":"OpenStack configuration"},"domain":{"index":3,"kind":"parameter","displayName":"Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Authentication domain"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The operation to do"},"password":{"index":5,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack password"},"project":{"index":6,"kind":"parameter","displayName":"Project","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project ID"},"subsystem":{"index":7,"kind":"parameter","displayName":"Subsystem","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["flavors","servers","keypairs"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack Nova subsystem"},"username":{"index":8,"kind":"parameter","displayName":"Username","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack username"},"lazyStartProducer":{"index":9,"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."}}} , -{"component":{"kind":"component","name":"openstack-swift","title":"OpenStack Swift","description":"Access OpenStack Swift object/blob store.","deprecated":false,"firstVersion":"2.19.0","label":"container","javaType":"org.apache.camel.component.openstack.swift.SwiftComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-openstack","version":"4.8.1","scheme":"openstack-swift","extendsScheme":"","syntax":"openstack-swift:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"containerName":{"index":0,"kind":"header","displayName":"","group":"object container","label":"object container","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The container name.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#CONTAINER_NAME"},"objectName":{"index":1,"kind":"header","displayName":"","group":"object","label":"object","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object name.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#OBJECT_NAME"},"X-Container-Meta-":{"index":2,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Container metadata prefix.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#CONTAINER_METADATA_PREFIX"},"X-Versions-Location":{"index":3,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Versions location.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#VERSIONS_LOCATION"},"X-Container-Read":{"index":4,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ACL - container read.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#CONTAINER_READ"},"X-Container-Write":{"index":5,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ACL - container write.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#CONTAINER_WRITE"},"limit":{"index":6,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List options - limit.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#LIMIT"},"marker":{"index":7,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List options - marker.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#MARKER"},"end_marker":{"index":8,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List options - end marker.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#END_MARKER"},"delimiter":{"index":9,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"Character","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List options - delimiter.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#DELIMITER"},"path":{"index":10,"kind":"header","displayName":"","group":"container object","label":"container object","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The path.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#PATH"},"operation":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#OPERATION"},"ID":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#ID"},"name":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#NAME"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack host url"},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["V2","V3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"V3","description":"OpenStack API version"},"config":{"index":2,"kind":"parameter","displayName":"Config","group":"producer","label":"","required":false,"type":"object","javaType":"org.openstack4j.core.transport.Config","deprecated":false,"autowired":false,"secret":false,"description":"OpenStack configuration"},"domain":{"index":3,"kind":"parameter","displayName":"Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Authentication domain"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The operation to do"},"password":{"index":5,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack password"},"project":{"index":6,"kind":"parameter","displayName":"Project","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project ID"},"subsystem":{"index":7,"kind":"parameter","displayName":"Subsystem","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["objects","containers"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack Swift subsystem"},"username":{"index":8,"kind":"parameter","displayName":"Username","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack username"},"lazyStartProducer":{"index":9,"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."}}} +{"component":{"kind":"component","name":"openstack-swift","title":"OpenStack Swift","description":"Access OpenStack Swift object/blob store.","deprecated":false,"firstVersion":"2.19.0","label":"container","javaType":"org.apache.camel.component.openstack.swift.SwiftComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-openstack","version":"4.8.2","scheme":"openstack-swift","extendsScheme":"","syntax":"openstack-swift:host","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"containerName":{"index":0,"kind":"header","displayName":"","group":"object container","label":"object container","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The container name.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#CONTAINER_NAME"},"objectName":{"index":1,"kind":"header","displayName":"","group":"object","label":"object","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object name.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#OBJECT_NAME"},"X-Container-Meta-":{"index":2,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Container metadata prefix.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#CONTAINER_METADATA_PREFIX"},"X-Versions-Location":{"index":3,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Versions location.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#VERSIONS_LOCATION"},"X-Container-Read":{"index":4,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ACL - container read.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#CONTAINER_READ"},"X-Container-Write":{"index":5,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ACL - container write.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#CONTAINER_WRITE"},"limit":{"index":6,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List options - limit.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#LIMIT"},"marker":{"index":7,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List options - marker.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#MARKER"},"end_marker":{"index":8,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List options - end marker.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#END_MARKER"},"delimiter":{"index":9,"kind":"header","displayName":"","group":"container","label":"container","required":false,"javaType":"Character","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List options - delimiter.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#DELIMITER"},"path":{"index":10,"kind":"header","displayName":"","group":"container object","label":"container object","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The path.","constantName":"org.apache.camel.component.openstack.swift.SwiftConstants#PATH"},"operation":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#OPERATION"},"ID":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ID.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#ID"},"name":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name.","constantName":"org.apache.camel.component.openstack.common.OpenstackConstants#NAME"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack host url"},"apiVersion":{"index":1,"kind":"parameter","displayName":"Api Version","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["V2","V3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"V3","description":"OpenStack API version"},"config":{"index":2,"kind":"parameter","displayName":"Config","group":"producer","label":"","required":false,"type":"object","javaType":"org.openstack4j.core.transport.Config","deprecated":false,"autowired":false,"secret":false,"description":"OpenStack configuration"},"domain":{"index":3,"kind":"parameter","displayName":"Domain","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"Authentication domain"},"operation":{"index":4,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The operation to do"},"password":{"index":5,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack password"},"project":{"index":6,"kind":"parameter","displayName":"Project","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project ID"},"subsystem":{"index":7,"kind":"parameter","displayName":"Subsystem","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["objects","containers"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OpenStack Swift subsystem"},"username":{"index":8,"kind":"parameter","displayName":"Username","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"OpenStack username"},"lazyStartProducer":{"index":9,"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."}}} , -{"component":{"kind":"component","name":"optaplanner","title":"OptaPlanner","description":"Solve planning problems with OptaPlanner.","deprecated":false,"firstVersion":"2.13.0","label":"workflow","javaType":"org.apache.camel.component.optaplanner.OptaPlannerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-optaplanner","version":"4.8.1","scheme":"optaplanner","extendsScheme":"","syntax":"optaplanner:problemName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelOptaPlannerSolverId":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the solverId to use.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#SOLVER_ID"},"CamelOptaPlannerIsAsync":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specify whether to use another thread for submitting Solution instances rather than blocking the current thread.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#IS_ASYNC"},"CamelOptaPlannerBestSolution":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The best planning solution.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#BEST_SOLUTION"},"CamelOptaPlannerIsSolving":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is solving.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#IS_SOLVING"},"CamelOptaPlannerSolverManager":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.optaplanner.core.api.solver.SolverManager","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Solver Manager.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#SOLVER_MANAGER"}},"properties":{"problemName":{"index":0,"kind":"path","displayName":"Problem Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"Problem name"},"configFile":{"index":1,"kind":"parameter","displayName":"Config File","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"If SolverManager is absent from the header OptaPlannerConstants.SOLVER_MANAGER then a SolverManager will be created using this Optaplanner config file."},"problemId":{"index":2,"kind":"parameter","displayName":"Problem Id","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1L","configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"In case of using SolverManager : the problem id"},"solverId":{"index":3,"kind":"parameter","displayName":"Solver Id","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEFAULT_SOLVER","configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"Specifies the solverId to user for the solver instance key"},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"async":{"index":7,"kind":"parameter","displayName":"Async","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"Specifies to perform operations in async mode"},"threadPoolSize":{"index":8,"kind":"parameter","displayName":"Thread Pool Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"Specifies the thread pool size to use when async is true"},"lazyStartProducer":{"index":9,"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."},"solverManager":{"index":10,"kind":"parameter","displayName":"Solver Manager","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.optaplanner.core.api.solver.SolverManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"SolverManager"}}} +{"component":{"kind":"component","name":"optaplanner","title":"OptaPlanner","description":"Solve planning problems with OptaPlanner.","deprecated":false,"firstVersion":"2.13.0","label":"workflow","javaType":"org.apache.camel.component.optaplanner.OptaPlannerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-optaplanner","version":"4.8.2","scheme":"optaplanner","extendsScheme":"","syntax":"optaplanner:problemName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelOptaPlannerSolverId":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the solverId to use.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#SOLVER_ID"},"CamelOptaPlannerIsAsync":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specify whether to use another thread for submitting Solution instances rather than blocking the current thread.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#IS_ASYNC"},"CamelOptaPlannerBestSolution":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The best planning solution.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#BEST_SOLUTION"},"CamelOptaPlannerIsSolving":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is solving.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#IS_SOLVING"},"CamelOptaPlannerSolverManager":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.optaplanner.core.api.solver.SolverManager","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Solver Manager.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#SOLVER_MANAGER"}},"properties":{"problemName":{"index":0,"kind":"path","displayName":"Problem Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"Problem name"},"configFile":{"index":1,"kind":"parameter","displayName":"Config File","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"If SolverManager is absent from the header OptaPlannerConstants.SOLVER_MANAGER then a SolverManager will be created using this Optaplanner config file."},"problemId":{"index":2,"kind":"parameter","displayName":"Problem Id","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1L","configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"In case of using SolverManager : the problem id"},"solverId":{"index":3,"kind":"parameter","displayName":"Solver Id","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEFAULT_SOLVER","configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"Specifies the solverId to user for the solver instance key"},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"async":{"index":7,"kind":"parameter","displayName":"Async","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"Specifies to perform operations in async mode"},"threadPoolSize":{"index":8,"kind":"parameter","displayName":"Thread Pool Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"Specifies the thread pool size to use when async is true"},"lazyStartProducer":{"index":9,"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."},"solverManager":{"index":10,"kind":"parameter","displayName":"Solver Manager","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.optaplanner.core.api.solver.SolverManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"SolverManager"}}} , -{"component":{"kind":"component","name":"paho","title":"Paho","description":"Communicate with MQTT message brokers using Eclipse Paho MQTT Client.","deprecated":false,"firstVersion":"2.16.0","label":"messaging,iot","javaType":"org.apache.camel.component.paho.PahoComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-paho","version":"4.8.1","scheme":"paho","extendsScheme":"","syntax":"paho:topic","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelMqttTopic":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the topic.","constantName":"org.apache.camel.component.paho.PahoConstants#MQTT_TOPIC"},"CamelMqttQoS":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The quality of service of the incoming message.","constantName":"org.apache.camel.component.paho.PahoConstants#MQTT_QOS"},"CamelPahoQos":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The client quality of service level (0-2).","constantName":"org.apache.camel.component.paho.PahoConstants#CAMEL_PAHO_MSG_QOS"},"CamelPahoRetained":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Retain option.","constantName":"org.apache.camel.component.paho.PahoConstants#CAMEL_PAHO_MSG_RETAINED"},"CamelPahoOverrideTopic":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of topic to override and send to instead of topic specified on endpoint.","constantName":"org.apache.camel.component.paho.PahoConstants#CAMEL_PAHO_OVERRIDE_TOPIC"}},"properties":{"topic":{"index":0,"kind":"path","displayName":"Topic","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the topic"},"automaticReconnect":{"index":1,"kind":"parameter","displayName":"Automatic Reconnect","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets whether the client will automatically attempt to reconnect to the server if the connection is lost. If set to false, the client will not attempt to automatically reconnect to the server in the event that the connection is lost. If set to true, in the event that the connection is lost, the client will attempt to reconnect to the server. It will initially wait 1 second before it attempts to reconnect, for every failed reconnect attempt, the delay will double until it is at 2 minutes at which point the delay will stay at 2 minutes."},"brokerUrl":{"index":2,"kind":"parameter","displayName":"Broker Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp://localhost:1883","configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"The URL of the MQTT broker."},"cleanSession":{"index":3,"kind":"parameter","displayName":"Clean Session","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets whether the client and server should remember state across restarts and reconnects. If set to false both the client and server will maintain state across restarts of the client, the server and the connection. As state is maintained: Message delivery will be reliable meeting the specified QOS even if the client, server or connection are restarted. The server will treat a subscription as durable. If set to true the client and server will not maintain state across restarts of the client, the server or the connection. This means Message delivery to the specified QOS cannot be maintained if the client, server or connection are restarted The server will treat a subscription as non-durable"},"clientId":{"index":4,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"MQTT client identifier. The identifier must be unique."},"connectionTimeout":{"index":5,"kind":"parameter","displayName":"Connection Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the connection timeout value. This value, measured in seconds, defines the maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails."},"filePersistenceDirectory":{"index":6,"kind":"parameter","displayName":"File Persistence Directory","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Base directory used by file persistence. Will by default use user directory."},"keepAliveInterval":{"index":7,"kind":"parameter","displayName":"Keep Alive Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the keep alive interval. This value, measured in seconds, defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small ping message, which the server will acknowledge. A value of 0 disables keepalive processing in the client. The default value is 60 seconds"},"maxInflight":{"index":8,"kind":"parameter","displayName":"Max Inflight","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the max inflight. please increase this value in a high traffic environment. The default value is 10"},"maxReconnectDelay":{"index":9,"kind":"parameter","displayName":"Max Reconnect Delay","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":128000,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Get the maximum time (in millis) to wait between reconnects"},"mqttVersion":{"index":10,"kind":"parameter","displayName":"Mqtt Version","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the MQTT version. The default action is to connect with version 3.1.1, and to fall back to 3.1 if that fails. Version 3.1.1 or 3.1 can be selected specifically, with no fall back, by using the MQTT_VERSION_3_1_1 or MQTT_VERSION_3_1 options respectively."},"persistence":{"index":11,"kind":"parameter","displayName":"Persistence","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.paho.PahoPersistence","enum":["FILE","MEMORY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MEMORY","configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Client persistence to be used - memory or file."},"qos":{"index":12,"kind":"parameter","displayName":"Qos","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Client quality of service level (0-2)."},"retained":{"index":13,"kind":"parameter","displayName":"Retained","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Retain option"},"serverURIs":{"index":14,"kind":"parameter","displayName":"Server URIs","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Set a list of one or more serverURIs the client may connect to. Multiple servers can be separated by comma. Each serverURI specifies the address of a server that the client may connect to. Two types of connection are supported tcp:// for a TCP connection and ssl:// for a TCP connection secured by SSL/TLS. For example: tcp://localhost:1883 ssl://localhost:8883 If the port is not specified, it will default to 1883 for tcp:// URIs, and 8883 for ssl:// URIs. If serverURIs is set then it overrides the serverURI parameter passed in on the constructor of the MQTT client. When an attempt to connect is initiated the client will start with the first serverURI in the list and work through the list until a connection is established with a server. If a connection cannot be made to any of the servers then the connect attempt fails. Specifying a list of servers that a client may connect to has several uses: High Availability and reliable message delivery Some MQTT servers support a high availability feature where two or more equal MQTT servers share state. An MQTT client can connect to any of the equal servers and be assured that messages are reliably delivered and durable subscriptions are maintained no matter which server the client connects to. The cleansession flag must be set to false if durable subscriptions and/or reliable message delivery is required. Hunt List A set of servers may be specified that are not equal (as in the high availability option). As no state is shared across the servers reliable message delivery and durable subscriptions are not valid. The cleansession flag must be set to true if the hunt list mode is used"},"willPayload":{"index":15,"kind":"parameter","displayName":"Will Payload","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. Sets the message for the LWT."},"willQos":{"index":16,"kind":"parameter","displayName":"Will Qos","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. Sets the quality of service to publish the message at (0, 1 or 2)."},"willRetained":{"index":17,"kind":"parameter","displayName":"Will Retained","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. Sets whether or not the message should be retained."},"willTopic":{"index":18,"kind":"parameter","displayName":"Will Topic","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. Sets the topic that the willPayload will be published to."},"bridgeErrorHandler":{"index":19,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":20,"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":{"index":21,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":22,"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."},"client":{"index":23,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.eclipse.paho.client.mqttv3.MqttClient","deprecated":false,"autowired":false,"secret":false,"description":"To use an existing mqtt client"},"customWebSocketHeaders":{"index":24,"kind":"parameter","displayName":"Custom Web Socket Headers","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the Custom WebSocket Headers for the WebSocket Connection."},"executorServiceTimeout":{"index":25,"kind":"parameter","displayName":"Executor Service Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Set the time in seconds that the executor service should wait when terminating before forcefully terminating. It is not recommended to change this value unless you are absolutely sure that you need to."},"httpsHostnameVerificationEnabled":{"index":26,"kind":"parameter","displayName":"Https Hostname Verification Enabled","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Whether SSL HostnameVerifier is enabled or not. The default value is true."},"password":{"index":27,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Password to be used for authentication against the MQTT broker"},"socketFactory":{"index":28,"kind":"parameter","displayName":"Socket Factory","group":"security","label":"security","required":false,"type":"object","javaType":"javax.net.SocketFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the SocketFactory to use. This allows an application to apply its own policies around the creation of network sockets. If using an SSL connection, an SSLSocketFactory can be used to supply application-specific security settings."},"sslClientProps":{"index":29,"kind":"parameter","displayName":"Ssl Client Props","group":"security","label":"security","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the SSL properties for the connection. Note that these properties are only valid if an implementation of the Java Secure Socket Extensions (JSSE) is available. These properties are not used if a custom SocketFactory has been set. The following properties can be used: com.ibm.ssl.protocol One of: SSL, SSLv3, TLS, TLSv1, SSL_TLS. com.ibm.ssl.contextProvider Underlying JSSE provider. For example IBMJSSE2 or SunJSSE com.ibm.ssl.keyStore The name of the file that contains the KeyStore object that you want the KeyManager to use. For example /mydir/etc/key.p12 com.ibm.ssl.keyStorePassword The password for the KeyStore object that you want the KeyManager to use. The password can either be in plain-text, or may be obfuscated using the static method: com.ibm.micro.security.Password.obfuscate(char password). This obfuscates the password using a simple and insecure XOR and Base64 encoding mechanism. Note that this is only a simple scrambler to obfuscate clear-text passwords. com.ibm.ssl.keyStoreType Type of key store, for example PKCS12, JKS, or JCEKS. com.ibm.ssl.keyStoreProvider Key store provider, for example IBMJCE or IBMJCEFIPS. com.ibm.ssl.trustStore The name of the file that contains the KeyStore object that you want the TrustManager to use. com.ibm.ssl.trustStorePassword The password for the TrustStore object that you want the TrustManager to use. The password can either be in plain-text, or may be obfuscated using the static method: com.ibm.micro.security.Password.obfuscate(char password). This obfuscates the password using a simple and insecure XOR and Base64 encoding mechanism. Note that this is only a simple scrambler to obfuscate clear-text passwords. com.ibm.ssl.trustStoreType The type of KeyStore object that you want the default TrustManager to use. Same possible values as keyStoreType. com.ibm.ssl.trustStoreProvider Trust store provider, for example IBMJCE or IBMJCEFIPS. com.ibm.ssl.enabledCipherSuites A list of which ciphers are enabled. Values are dependent on the provider, for example: SSL_RSA_WITH_AES_128_CBC_SHA;SSL_RSA_WITH_3DES_EDE_CBC_SHA. com.ibm.ssl.keyManager Sets the algorithm that will be used to instantiate a KeyManagerFactory object instead of using the default algorithm available in the platform. Example values: IbmX509 or IBMJ9X509. com.ibm.ssl.trustManager Sets the algorithm that will be used to instantiate a TrustManagerFactory object instead of using the default algorithm available in the platform. Example values: PKIX or IBMJ9X509."},"sslHostnameVerifier":{"index":30,"kind":"parameter","displayName":"Ssl Hostname Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the HostnameVerifier for the SSL connection. Note that it will be used after handshake on a connection and you should do actions by yourself when hostname is verified error. There is no default HostnameVerifier"},"userName":{"index":31,"kind":"parameter","displayName":"User Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Username to be used for authentication against the MQTT broker"}}} +{"component":{"kind":"component","name":"paho","title":"Paho","description":"Communicate with MQTT message brokers using Eclipse Paho MQTT Client.","deprecated":false,"firstVersion":"2.16.0","label":"messaging,iot","javaType":"org.apache.camel.component.paho.PahoComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-paho","version":"4.8.2","scheme":"paho","extendsScheme":"","syntax":"paho:topic","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelMqttTopic":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the topic.","constantName":"org.apache.camel.component.paho.PahoConstants#MQTT_TOPIC"},"CamelMqttQoS":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The quality of service of the incoming message.","constantName":"org.apache.camel.component.paho.PahoConstants#MQTT_QOS"},"CamelPahoQos":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The client quality of service level (0-2).","constantName":"org.apache.camel.component.paho.PahoConstants#CAMEL_PAHO_MSG_QOS"},"CamelPahoRetained":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Retain option.","constantName":"org.apache.camel.component.paho.PahoConstants#CAMEL_PAHO_MSG_RETAINED"},"CamelPahoOverrideTopic":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of topic to override and send to instead of topic specified on endpoint.","constantName":"org.apache.camel.component.paho.PahoConstants#CAMEL_PAHO_OVERRIDE_TOPIC"}},"properties":{"topic":{"index":0,"kind":"path","displayName":"Topic","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the topic"},"automaticReconnect":{"index":1,"kind":"parameter","displayName":"Automatic Reconnect","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets whether the client will automatically attempt to reconnect to the server if the connection is lost. If set to false, the client will not attempt to automatically reconnect to the server in the event that the connection is lost. If set to true, in the event that the connection is lost, the client will attempt to reconnect to the server. It will initially wait 1 second before it attempts to reconnect, for every failed reconnect attempt, the delay will double until it is at 2 minutes at which point the delay will stay at 2 minutes."},"brokerUrl":{"index":2,"kind":"parameter","displayName":"Broker Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp://localhost:1883","configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"The URL of the MQTT broker."},"cleanSession":{"index":3,"kind":"parameter","displayName":"Clean Session","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets whether the client and server should remember state across restarts and reconnects. If set to false both the client and server will maintain state across restarts of the client, the server and the connection. As state is maintained: Message delivery will be reliable meeting the specified QOS even if the client, server or connection are restarted. The server will treat a subscription as durable. If set to true the client and server will not maintain state across restarts of the client, the server or the connection. This means Message delivery to the specified QOS cannot be maintained if the client, server or connection are restarted The server will treat a subscription as non-durable"},"clientId":{"index":4,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"MQTT client identifier. The identifier must be unique."},"connectionTimeout":{"index":5,"kind":"parameter","displayName":"Connection Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the connection timeout value. This value, measured in seconds, defines the maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails."},"filePersistenceDirectory":{"index":6,"kind":"parameter","displayName":"File Persistence Directory","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Base directory used by file persistence. Will by default use user directory."},"keepAliveInterval":{"index":7,"kind":"parameter","displayName":"Keep Alive Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the keep alive interval. This value, measured in seconds, defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small ping message, which the server will acknowledge. A value of 0 disables keepalive processing in the client. The default value is 60 seconds"},"maxInflight":{"index":8,"kind":"parameter","displayName":"Max Inflight","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the max inflight. please increase this value in a high traffic environment. The default value is 10"},"maxReconnectDelay":{"index":9,"kind":"parameter","displayName":"Max Reconnect Delay","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":128000,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Get the maximum time (in millis) to wait between reconnects"},"mqttVersion":{"index":10,"kind":"parameter","displayName":"Mqtt Version","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the MQTT version. The default action is to connect with version 3.1.1, and to fall back to 3.1 if that fails. Version 3.1.1 or 3.1 can be selected specifically, with no fall back, by using the MQTT_VERSION_3_1_1 or MQTT_VERSION_3_1 options respectively."},"persistence":{"index":11,"kind":"parameter","displayName":"Persistence","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.paho.PahoPersistence","enum":["FILE","MEMORY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MEMORY","configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Client persistence to be used - memory or file."},"qos":{"index":12,"kind":"parameter","displayName":"Qos","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Client quality of service level (0-2)."},"retained":{"index":13,"kind":"parameter","displayName":"Retained","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Retain option"},"serverURIs":{"index":14,"kind":"parameter","displayName":"Server URIs","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Set a list of one or more serverURIs the client may connect to. Multiple servers can be separated by comma. Each serverURI specifies the address of a server that the client may connect to. Two types of connection are supported tcp:// for a TCP connection and ssl:// for a TCP connection secured by SSL/TLS. For example: tcp://localhost:1883 ssl://localhost:8883 If the port is not specified, it will default to 1883 for tcp:// URIs, and 8883 for ssl:// URIs. If serverURIs is set then it overrides the serverURI parameter passed in on the constructor of the MQTT client. When an attempt to connect is initiated the client will start with the first serverURI in the list and work through the list until a connection is established with a server. If a connection cannot be made to any of the servers then the connect attempt fails. Specifying a list of servers that a client may connect to has several uses: High Availability and reliable message delivery Some MQTT servers support a high availability feature where two or more equal MQTT servers share state. An MQTT client can connect to any of the equal servers and be assured that messages are reliably delivered and durable subscriptions are maintained no matter which server the client connects to. The cleansession flag must be set to false if durable subscriptions and/or reliable message delivery is required. Hunt List A set of servers may be specified that are not equal (as in the high availability option). As no state is shared across the servers reliable message delivery and durable subscriptions are not valid. The cleansession flag must be set to true if the hunt list mode is used"},"willPayload":{"index":15,"kind":"parameter","displayName":"Will Payload","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. Sets the message for the LWT."},"willQos":{"index":16,"kind":"parameter","displayName":"Will Qos","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. Sets the quality of service to publish the message at (0, 1 or 2)."},"willRetained":{"index":17,"kind":"parameter","displayName":"Will Retained","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. Sets whether or not the message should be retained."},"willTopic":{"index":18,"kind":"parameter","displayName":"Will Topic","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. Sets the topic that the willPayload will be published to."},"bridgeErrorHandler":{"index":19,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":20,"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":{"index":21,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":22,"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."},"client":{"index":23,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.eclipse.paho.client.mqttv3.MqttClient","deprecated":false,"autowired":false,"secret":false,"description":"To use an existing mqtt client"},"customWebSocketHeaders":{"index":24,"kind":"parameter","displayName":"Custom Web Socket Headers","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the Custom WebSocket Headers for the WebSocket Connection."},"executorServiceTimeout":{"index":25,"kind":"parameter","displayName":"Executor Service Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Set the time in seconds that the executor service should wait when terminating before forcefully terminating. It is not recommended to change this value unless you are absolutely sure that you need to."},"httpsHostnameVerificationEnabled":{"index":26,"kind":"parameter","displayName":"Https Hostname Verification Enabled","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Whether SSL HostnameVerifier is enabled or not. The default value is true."},"password":{"index":27,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Password to be used for authentication against the MQTT broker"},"socketFactory":{"index":28,"kind":"parameter","displayName":"Socket Factory","group":"security","label":"security","required":false,"type":"object","javaType":"javax.net.SocketFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the SocketFactory to use. This allows an application to apply its own policies around the creation of network sockets. If using an SSL connection, an SSLSocketFactory can be used to supply application-specific security settings."},"sslClientProps":{"index":29,"kind":"parameter","displayName":"Ssl Client Props","group":"security","label":"security","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the SSL properties for the connection. Note that these properties are only valid if an implementation of the Java Secure Socket Extensions (JSSE) is available. These properties are not used if a custom SocketFactory has been set. The following properties can be used: com.ibm.ssl.protocol One of: SSL, SSLv3, TLS, TLSv1, SSL_TLS. com.ibm.ssl.contextProvider Underlying JSSE provider. For example IBMJSSE2 or SunJSSE com.ibm.ssl.keyStore The name of the file that contains the KeyStore object that you want the KeyManager to use. For example /mydir/etc/key.p12 com.ibm.ssl.keyStorePassword The password for the KeyStore object that you want the KeyManager to use. The password can either be in plain-text, or may be obfuscated using the static method: com.ibm.micro.security.Password.obfuscate(char password). This obfuscates the password using a simple and insecure XOR and Base64 encoding mechanism. Note that this is only a simple scrambler to obfuscate clear-text passwords. com.ibm.ssl.keyStoreType Type of key store, for example PKCS12, JKS, or JCEKS. com.ibm.ssl.keyStoreProvider Key store provider, for example IBMJCE or IBMJCEFIPS. com.ibm.ssl.trustStore The name of the file that contains the KeyStore object that you want the TrustManager to use. com.ibm.ssl.trustStorePassword The password for the TrustStore object that you want the TrustManager to use. The password can either be in plain-text, or may be obfuscated using the static method: com.ibm.micro.security.Password.obfuscate(char password). This obfuscates the password using a simple and insecure XOR and Base64 encoding mechanism. Note that this is only a simple scrambler to obfuscate clear-text passwords. com.ibm.ssl.trustStoreType The type of KeyStore object that you want the default TrustManager to use. Same possible values as keyStoreType. com.ibm.ssl.trustStoreProvider Trust store provider, for example IBMJCE or IBMJCEFIPS. com.ibm.ssl.enabledCipherSuites A list of which ciphers are enabled. Values are dependent on the provider, for example: SSL_RSA_WITH_AES_128_CBC_SHA;SSL_RSA_WITH_3DES_EDE_CBC_SHA. com.ibm.ssl.keyManager Sets the algorithm that will be used to instantiate a KeyManagerFactory object instead of using the default algorithm available in the platform. Example values: IbmX509 or IBMJ9X509. com.ibm.ssl.trustManager Sets the algorithm that will be used to instantiate a TrustManagerFactory object instead of using the default algorithm available in the platform. Example values: PKIX or IBMJ9X509."},"sslHostnameVerifier":{"index":30,"kind":"parameter","displayName":"Ssl Hostname Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Sets the HostnameVerifier for the SSL connection. Note that it will be used after handshake on a connection and you should do actions by yourself when hostname is verified error. There is no default HostnameVerifier"},"userName":{"index":31,"kind":"parameter","displayName":"User Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.paho.PahoConfiguration","configurationField":"configuration","description":"Username to be used for authentication against the MQTT broker"}}} , -{"component":{"kind":"component","name":"paho-mqtt5","title":"Paho MQTT 5","description":"Communicate with MQTT message brokers using Eclipse Paho MQTT v5 Client.","deprecated":false,"firstVersion":"3.8.0","label":"messaging,iot","javaType":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-paho-mqtt5","version":"4.8.1","scheme":"paho-mqtt5","extendsScheme":"","syntax":"paho-mqtt5:topic","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelMqttTopic":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the topic.","constantName":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Constants#MQTT_TOPIC"},"CamelMqttQoS":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The quality of service of the incoming message.","constantName":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Constants#MQTT_QOS"},"CamelPahoMqtt5Qos":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The client quality of service level (0-2).","constantName":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Constants#CAMEL_PAHO_MSG_QOS"},"CamelPahoMqtt5Retained":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Retain option.","constantName":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Constants#CAMEL_PAHO_MSG_RETAINED"},"CamelPahoMqtt5OverrideTopic":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of topic to override and send to instead of topic specified on endpoint.","constantName":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Constants#CAMEL_PAHO_OVERRIDE_TOPIC"},"CamelPahoMqtt5MsgProperties":{"index":5,"kind":"header","displayName":"","group":"producer","label":"consumer,producer","required":false,"javaType":"org.eclipse.paho.mqttv5.common.packet.MqttProperties","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Consumer: The properties set on the incoming message. Producer: The properties to be set on the outgoing message.","constantName":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Constants#CAMEL_PAHO_MSG_PROPERTIES"}},"properties":{"topic":{"index":0,"kind":"path","displayName":"Topic","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the topic"},"automaticReconnect":{"index":1,"kind":"parameter","displayName":"Automatic Reconnect","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets whether the client will automatically attempt to reconnect to the server if the connection is lost. If set to false, the client will not attempt to automatically reconnect to the server in the event that the connection is lost. If set to true, in the event that the connection is lost, the client will attempt to reconnect to the server. It will initially wait 1 second before it attempts to reconnect, for every failed reconnect attempt, the delay will double until it is at 2 minutes at which point the delay will stay at 2 minutes."},"brokerUrl":{"index":2,"kind":"parameter","displayName":"Broker Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp://localhost:1883","configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"The URL of the MQTT broker."},"cleanStart":{"index":3,"kind":"parameter","displayName":"Clean Start","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets whether the client and server should remember state across restarts and reconnects. If set to false both the client and server will maintain state across restarts of the client, the server and the connection. As state is maintained: Message delivery will be reliable meeting the specified QOS even if the client, server or connection are restarted. The server will treat a subscription as durable. If set to true the client and server will not maintain state across restarts of the client, the server or the connection. This means Message delivery to the specified QOS cannot be maintained if the client, server or connection are restarted The server will treat a subscription as non-durable"},"clientId":{"index":4,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"MQTT client identifier. The identifier must be unique."},"connectionTimeout":{"index":5,"kind":"parameter","displayName":"Connection Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the connection timeout value. This value, measured in seconds, defines the maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails."},"filePersistenceDirectory":{"index":6,"kind":"parameter","displayName":"File Persistence Directory","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Base directory used by file persistence. Will by default use user directory."},"keepAliveInterval":{"index":7,"kind":"parameter","displayName":"Keep Alive Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the keep alive interval. This value, measured in seconds, defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small ping message, which the server will acknowledge. A value of 0 disables keepalive processing in the client. The default value is 60 seconds"},"maxReconnectDelay":{"index":8,"kind":"parameter","displayName":"Max Reconnect Delay","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":128000,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Get the maximum time (in millis) to wait between reconnects"},"persistence":{"index":9,"kind":"parameter","displayName":"Persistence","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Persistence","enum":["FILE","MEMORY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MEMORY","configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Client persistence to be used - memory or file."},"qos":{"index":10,"kind":"parameter","displayName":"Qos","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Client quality of service level (0-2)."},"receiveMaximum":{"index":11,"kind":"parameter","displayName":"Receive Maximum","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":65535,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Receive Maximum. This value represents the limit of QoS 1 and QoS 2 publications that the client is willing to process concurrently. There is no mechanism to limit the number of QoS 0 publications that the Server might try to send. The default value is 65535"},"retained":{"index":12,"kind":"parameter","displayName":"Retained","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Retain option"},"serverURIs":{"index":13,"kind":"parameter","displayName":"Server URIs","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Set a list of one or more serverURIs the client may connect to. Multiple servers can be separated by comma. Each serverURI specifies the address of a server that the client may connect to. Two types of connection are supported tcp:// for a TCP connection and ssl:// for a TCP connection secured by SSL/TLS. For example: tcp://localhost:1883 ssl://localhost:8883 If the port is not specified, it will default to 1883 for tcp:// URIs, and 8883 for ssl:// URIs. If serverURIs is set then it overrides the serverURI parameter passed in on the constructor of the MQTT client. When an attempt to connect is initiated the client will start with the first serverURI in the list and work through the list until a connection is established with a server. If a connection cannot be made to any of the servers then the connect attempt fails. Specifying a list of servers that a client may connect to has several uses: High Availability and reliable message delivery Some MQTT servers support a high availability feature where two or more equal MQTT servers share state. An MQTT client can connect to any of the equal servers and be assured that messages are reliably delivered and durable subscriptions are maintained no matter which server the client connects to. The cleansession flag must be set to false if durable subscriptions and/or reliable message delivery is required. Hunt List A set of servers may be specified that are not equal (as in the high availability option). As no state is shared across the servers reliable message delivery and durable subscriptions are not valid. The cleansession flag must be set to true if the hunt list mode is used"},"sessionExpiryInterval":{"index":14,"kind":"parameter","displayName":"Session Expiry Interval","group":"common","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Session Expiry Interval. This value, measured in seconds, defines the maximum time that the broker will maintain the session for once the client disconnects. Clients should only connect with a long Session Expiry interval if they intend to connect to the server at some later point in time. By default this value is -1 and so will not be sent, in this case, the session will not expire. If a 0 is sent, the session will end immediately once the Network Connection is closed. When the client has determined that it has no longer any use for the session, it should disconnect with a Session Expiry Interval set to 0."},"willMqttProperties":{"index":15,"kind":"parameter","displayName":"Will Mqtt Properties","group":"common","label":"","required":false,"type":"object","javaType":"org.eclipse.paho.mqttv5.common.packet.MqttProperties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The MQTT properties set for the message."},"willPayload":{"index":16,"kind":"parameter","displayName":"Will Payload","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The byte payload for the message."},"willQos":{"index":17,"kind":"parameter","displayName":"Will Qos","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The quality of service to publish the message at (0, 1 or 2)."},"willRetained":{"index":18,"kind":"parameter","displayName":"Will Retained","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. Whether or not the message should be retained."},"willTopic":{"index":19,"kind":"parameter","displayName":"Will Topic","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to."},"bridgeErrorHandler":{"index":20,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":21,"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":{"index":22,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":23,"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."},"client":{"index":24,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.eclipse.paho.mqttv5.client.MqttClient","deprecated":false,"autowired":false,"secret":false,"description":"To use an existing mqtt client"},"customWebSocketHeaders":{"index":25,"kind":"parameter","displayName":"Custom Web Socket Headers","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Custom WebSocket Headers for the WebSocket Connection."},"executorServiceTimeout":{"index":26,"kind":"parameter","displayName":"Executor Service Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Set the time in seconds that the executor service should wait when terminating before forcefully terminating. It is not recommended to change this value unless you are absolutely sure that you need to."},"httpsHostnameVerificationEnabled":{"index":27,"kind":"parameter","displayName":"Https Hostname Verification Enabled","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Whether SSL HostnameVerifier is enabled or not. The default value is true."},"password":{"index":28,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Password to be used for authentication against the MQTT broker"},"socketFactory":{"index":29,"kind":"parameter","displayName":"Socket Factory","group":"security","label":"security","required":false,"type":"object","javaType":"javax.net.SocketFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the SocketFactory to use. This allows an application to apply its own policies around the creation of network sockets. If using an SSL connection, an SSLSocketFactory can be used to supply application-specific security settings."},"sslClientProps":{"index":30,"kind":"parameter","displayName":"Ssl Client Props","group":"security","label":"security","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the SSL properties for the connection. Note that these properties are only valid if an implementation of the Java Secure Socket Extensions (JSSE) is available. These properties are not used if a custom SocketFactory has been set. The following properties can be used: com.ibm.ssl.protocol One of: SSL, SSLv3, TLS, TLSv1, SSL_TLS. com.ibm.ssl.contextProvider Underlying JSSE provider. For example IBMJSSE2 or SunJSSE com.ibm.ssl.keyStore The name of the file that contains the KeyStore object that you want the KeyManager to use. For example /mydir/etc/key.p12 com.ibm.ssl.keyStorePassword The password for the KeyStore object that you want the KeyManager to use. The password can either be in plain-text, or may be obfuscated using the static method: com.ibm.micro.security.Password.obfuscate(char password). This obfuscates the password using a simple and insecure XOR and Base64 encoding mechanism. Note that this is only a simple scrambler to obfuscate clear-text passwords. com.ibm.ssl.keyStoreType Type of key store, for example PKCS12, JKS, or JCEKS. com.ibm.ssl.keyStoreProvider Key store provider, for example IBMJCE or IBMJCEFIPS. com.ibm.ssl.trustStore The name of the file that contains the KeyStore object that you want the TrustManager to use. com.ibm.ssl.trustStorePassword The password for the TrustStore object that you want the TrustManager to use. The password can either be in plain-text, or may be obfuscated using the static method: com.ibm.micro.security.Password.obfuscate(char password). This obfuscates the password using a simple and insecure XOR and Base64 encoding mechanism. Note that this is only a simple scrambler to obfuscate clear-text passwords. com.ibm.ssl.trustStoreType The type of KeyStore object that you want the default TrustManager to use. Same possible values as keyStoreType. com.ibm.ssl.trustStoreProvider Trust store provider, for example IBMJCE or IBMJCEFIPS. com.ibm.ssl.enabledCipherSuites A list of which ciphers are enabled. Values are dependent on the provider, for example: SSL_RSA_WITH_AES_128_CBC_SHA;SSL_RSA_WITH_3DES_EDE_CBC_SHA. com.ibm.ssl.keyManager Sets the algorithm that will be used to instantiate a KeyManagerFactory object instead of using the default algorithm available in the platform. Example values: IbmX509 or IBMJ9X509. com.ibm.ssl.trustManager Sets the algorithm that will be used to instantiate a TrustManagerFactory object instead of using the default algorithm available in the platform. Example values: PKIX or IBMJ9X509."},"sslHostnameVerifier":{"index":31,"kind":"parameter","displayName":"Ssl Hostname Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the HostnameVerifier for the SSL connection. Note that it will be used after handshake on a connection and you should do actions by yourself when hostname is verified error. There is no default HostnameVerifier"},"userName":{"index":32,"kind":"parameter","displayName":"User Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Username to be used for authentication against the MQTT broker"}}} +{"component":{"kind":"component","name":"paho-mqtt5","title":"Paho MQTT 5","description":"Communicate with MQTT message brokers using Eclipse Paho MQTT v5 Client.","deprecated":false,"firstVersion":"3.8.0","label":"messaging,iot","javaType":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-paho-mqtt5","version":"4.8.2","scheme":"paho-mqtt5","extendsScheme":"","syntax":"paho-mqtt5:topic","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelMqttTopic":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the topic.","constantName":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Constants#MQTT_TOPIC"},"CamelMqttQoS":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The quality of service of the incoming message.","constantName":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Constants#MQTT_QOS"},"CamelPahoMqtt5Qos":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The client quality of service level (0-2).","constantName":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Constants#CAMEL_PAHO_MSG_QOS"},"CamelPahoMqtt5Retained":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Retain option.","constantName":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Constants#CAMEL_PAHO_MSG_RETAINED"},"CamelPahoMqtt5OverrideTopic":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of topic to override and send to instead of topic specified on endpoint.","constantName":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Constants#CAMEL_PAHO_OVERRIDE_TOPIC"},"CamelPahoMqtt5MsgProperties":{"index":5,"kind":"header","displayName":"","group":"producer","label":"consumer,producer","required":false,"javaType":"org.eclipse.paho.mqttv5.common.packet.MqttProperties","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Consumer: The properties set on the incoming message. Producer: The properties to be set on the outgoing message.","constantName":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Constants#CAMEL_PAHO_MSG_PROPERTIES"}},"properties":{"topic":{"index":0,"kind":"path","displayName":"Topic","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the topic"},"automaticReconnect":{"index":1,"kind":"parameter","displayName":"Automatic Reconnect","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets whether the client will automatically attempt to reconnect to the server if the connection is lost. If set to false, the client will not attempt to automatically reconnect to the server in the event that the connection is lost. If set to true, in the event that the connection is lost, the client will attempt to reconnect to the server. It will initially wait 1 second before it attempts to reconnect, for every failed reconnect attempt, the delay will double until it is at 2 minutes at which point the delay will stay at 2 minutes."},"brokerUrl":{"index":2,"kind":"parameter","displayName":"Broker Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"tcp://localhost:1883","configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"The URL of the MQTT broker."},"cleanStart":{"index":3,"kind":"parameter","displayName":"Clean Start","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets whether the client and server should remember state across restarts and reconnects. If set to false both the client and server will maintain state across restarts of the client, the server and the connection. As state is maintained: Message delivery will be reliable meeting the specified QOS even if the client, server or connection are restarted. The server will treat a subscription as durable. If set to true the client and server will not maintain state across restarts of the client, the server or the connection. This means Message delivery to the specified QOS cannot be maintained if the client, server or connection are restarted The server will treat a subscription as non-durable"},"clientId":{"index":4,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"MQTT client identifier. The identifier must be unique."},"connectionTimeout":{"index":5,"kind":"parameter","displayName":"Connection Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the connection timeout value. This value, measured in seconds, defines the maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails."},"filePersistenceDirectory":{"index":6,"kind":"parameter","displayName":"File Persistence Directory","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Base directory used by file persistence. Will by default use user directory."},"keepAliveInterval":{"index":7,"kind":"parameter","displayName":"Keep Alive Interval","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the keep alive interval. This value, measured in seconds, defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small ping message, which the server will acknowledge. A value of 0 disables keepalive processing in the client. The default value is 60 seconds"},"maxReconnectDelay":{"index":8,"kind":"parameter","displayName":"Max Reconnect Delay","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":128000,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Get the maximum time (in millis) to wait between reconnects"},"persistence":{"index":9,"kind":"parameter","displayName":"Persistence","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Persistence","enum":["FILE","MEMORY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MEMORY","configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Client persistence to be used - memory or file."},"qos":{"index":10,"kind":"parameter","displayName":"Qos","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Client quality of service level (0-2)."},"receiveMaximum":{"index":11,"kind":"parameter","displayName":"Receive Maximum","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":65535,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Receive Maximum. This value represents the limit of QoS 1 and QoS 2 publications that the client is willing to process concurrently. There is no mechanism to limit the number of QoS 0 publications that the Server might try to send. The default value is 65535"},"retained":{"index":12,"kind":"parameter","displayName":"Retained","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Retain option"},"serverURIs":{"index":13,"kind":"parameter","displayName":"Server URIs","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Set a list of one or more serverURIs the client may connect to. Multiple servers can be separated by comma. Each serverURI specifies the address of a server that the client may connect to. Two types of connection are supported tcp:// for a TCP connection and ssl:// for a TCP connection secured by SSL/TLS. For example: tcp://localhost:1883 ssl://localhost:8883 If the port is not specified, it will default to 1883 for tcp:// URIs, and 8883 for ssl:// URIs. If serverURIs is set then it overrides the serverURI parameter passed in on the constructor of the MQTT client. When an attempt to connect is initiated the client will start with the first serverURI in the list and work through the list until a connection is established with a server. If a connection cannot be made to any of the servers then the connect attempt fails. Specifying a list of servers that a client may connect to has several uses: High Availability and reliable message delivery Some MQTT servers support a high availability feature where two or more equal MQTT servers share state. An MQTT client can connect to any of the equal servers and be assured that messages are reliably delivered and durable subscriptions are maintained no matter which server the client connects to. The cleansession flag must be set to false if durable subscriptions and/or reliable message delivery is required. Hunt List A set of servers may be specified that are not equal (as in the high availability option). As no state is shared across the servers reliable message delivery and durable subscriptions are not valid. The cleansession flag must be set to true if the hunt list mode is used"},"sessionExpiryInterval":{"index":14,"kind":"parameter","displayName":"Session Expiry Interval","group":"common","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Session Expiry Interval. This value, measured in seconds, defines the maximum time that the broker will maintain the session for once the client disconnects. Clients should only connect with a long Session Expiry interval if they intend to connect to the server at some later point in time. By default this value is -1 and so will not be sent, in this case, the session will not expire. If a 0 is sent, the session will end immediately once the Network Connection is closed. When the client has determined that it has no longer any use for the session, it should disconnect with a Session Expiry Interval set to 0."},"willMqttProperties":{"index":15,"kind":"parameter","displayName":"Will Mqtt Properties","group":"common","label":"","required":false,"type":"object","javaType":"org.eclipse.paho.mqttv5.common.packet.MqttProperties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The MQTT properties set for the message."},"willPayload":{"index":16,"kind":"parameter","displayName":"Will Payload","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The byte payload for the message."},"willQos":{"index":17,"kind":"parameter","displayName":"Will Qos","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The quality of service to publish the message at (0, 1 or 2)."},"willRetained":{"index":18,"kind":"parameter","displayName":"Will Retained","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. Whether or not the message should be retained."},"willTopic":{"index":19,"kind":"parameter","displayName":"Will Topic","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to."},"bridgeErrorHandler":{"index":20,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":21,"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":{"index":22,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":23,"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."},"client":{"index":24,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.eclipse.paho.mqttv5.client.MqttClient","deprecated":false,"autowired":false,"secret":false,"description":"To use an existing mqtt client"},"customWebSocketHeaders":{"index":25,"kind":"parameter","displayName":"Custom Web Socket Headers","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the Custom WebSocket Headers for the WebSocket Connection."},"executorServiceTimeout":{"index":26,"kind":"parameter","displayName":"Executor Service Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Set the time in seconds that the executor service should wait when terminating before forcefully terminating. It is not recommended to change this value unless you are absolutely sure that you need to."},"httpsHostnameVerificationEnabled":{"index":27,"kind":"parameter","displayName":"Https Hostname Verification Enabled","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Whether SSL HostnameVerifier is enabled or not. The default value is true."},"password":{"index":28,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Password to be used for authentication against the MQTT broker"},"socketFactory":{"index":29,"kind":"parameter","displayName":"Socket Factory","group":"security","label":"security","required":false,"type":"object","javaType":"javax.net.SocketFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the SocketFactory to use. This allows an application to apply its own policies around the creation of network sockets. If using an SSL connection, an SSLSocketFactory can be used to supply application-specific security settings."},"sslClientProps":{"index":30,"kind":"parameter","displayName":"Ssl Client Props","group":"security","label":"security","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the SSL properties for the connection. Note that these properties are only valid if an implementation of the Java Secure Socket Extensions (JSSE) is available. These properties are not used if a custom SocketFactory has been set. The following properties can be used: com.ibm.ssl.protocol One of: SSL, SSLv3, TLS, TLSv1, SSL_TLS. com.ibm.ssl.contextProvider Underlying JSSE provider. For example IBMJSSE2 or SunJSSE com.ibm.ssl.keyStore The name of the file that contains the KeyStore object that you want the KeyManager to use. For example /mydir/etc/key.p12 com.ibm.ssl.keyStorePassword The password for the KeyStore object that you want the KeyManager to use. The password can either be in plain-text, or may be obfuscated using the static method: com.ibm.micro.security.Password.obfuscate(char password). This obfuscates the password using a simple and insecure XOR and Base64 encoding mechanism. Note that this is only a simple scrambler to obfuscate clear-text passwords. com.ibm.ssl.keyStoreType Type of key store, for example PKCS12, JKS, or JCEKS. com.ibm.ssl.keyStoreProvider Key store provider, for example IBMJCE or IBMJCEFIPS. com.ibm.ssl.trustStore The name of the file that contains the KeyStore object that you want the TrustManager to use. com.ibm.ssl.trustStorePassword The password for the TrustStore object that you want the TrustManager to use. The password can either be in plain-text, or may be obfuscated using the static method: com.ibm.micro.security.Password.obfuscate(char password). This obfuscates the password using a simple and insecure XOR and Base64 encoding mechanism. Note that this is only a simple scrambler to obfuscate clear-text passwords. com.ibm.ssl.trustStoreType The type of KeyStore object that you want the default TrustManager to use. Same possible values as keyStoreType. com.ibm.ssl.trustStoreProvider Trust store provider, for example IBMJCE or IBMJCEFIPS. com.ibm.ssl.enabledCipherSuites A list of which ciphers are enabled. Values are dependent on the provider, for example: SSL_RSA_WITH_AES_128_CBC_SHA;SSL_RSA_WITH_3DES_EDE_CBC_SHA. com.ibm.ssl.keyManager Sets the algorithm that will be used to instantiate a KeyManagerFactory object instead of using the default algorithm available in the platform. Example values: IbmX509 or IBMJ9X509. com.ibm.ssl.trustManager Sets the algorithm that will be used to instantiate a TrustManagerFactory object instead of using the default algorithm available in the platform. Example values: PKIX or IBMJ9X509."},"sslHostnameVerifier":{"index":31,"kind":"parameter","displayName":"Ssl Hostname Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Sets the HostnameVerifier for the SSL connection. Note that it will be used after handshake on a connection and you should do actions by yourself when hostname is verified error. There is no default HostnameVerifier"},"userName":{"index":32,"kind":"parameter","displayName":"User Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.paho.mqtt5.PahoMqtt5Configuration","configurationField":"configuration","description":"Username to be used for authentication against the MQTT broker"}}} , -{"component":{"kind":"component","name":"pdf","title":"PDF","description":"Create, modify or extract content from PDF documents.","deprecated":false,"firstVersion":"2.16.0","label":"document,transformation","javaType":"org.apache.camel.component.pdf.PdfComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-pdf","version":"4.8.1","scheme":"pdf","extendsScheme":"","syntax":"pdf:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"protection-policy":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.pdfbox.pdmodel.encryption.ProtectionPolicy","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Expected type is https://pdfbox.apache.org/docs/2.0.13/javadocs/org/apache/pdfbox/pdmodel/encryption/ProtectionPolicy.htmlProtectionPolicy. If specified then PDF document will be encrypted with it.","constantName":"org.apache.camel.component.pdf.PdfHeaderConstants#PROTECTION_POLICY_HEADER_NAME"},"pdf-document":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.pdfbox.pdmodel.PDDocument","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Mandatory header for append operation and ignored in all other operations. Expected type is https://pdfbox.apache.org/docs/2.0.13/javadocs/org/apache/pdfbox/pdmodel/PDDocument.htmlPDDocument. Stores PDF document which will be used for append operation.","constantName":"org.apache.camel.component.pdf.PdfHeaderConstants#PDF_DOCUMENT_HEADER_NAME"},"decryption-material":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.pdfbox.pdmodel.encryption.DecryptionMaterial","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Expected type is https://pdfbox.apache.org/docs/2.0.13/javadocs/org/apache/pdfbox/pdmodel/encryption/DecryptionMaterial.htmlDecryptionMaterial. Mandatory header if PDF document is encrypted.","constantName":"org.apache.camel.component.pdf.PdfHeaderConstants#DECRYPTION_MATERIAL_HEADER_NAME"},"files-to-merge":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.util.List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Mandatory header for merge operation and ignored in all other operations. The array of pdf files that will be merged.","constantName":"org.apache.camel.component.pdf.PdfHeaderConstants#FILES_TO_MERGE_HEADER_NAME"}},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.pdf.PdfOperation","enum":["create","append","extractText","merge"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Operation type"},"font":{"index":1,"kind":"parameter","displayName":"Font","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["COURIER","COURIER_BOLD","COURIER_OBLIQUE","COURIER_BOLD_OBLIQUE","HELVETICA","HELVETICA_BOLD","HELVETICA_OBLIQUE","HELVETICA_BOLD_OBLIQUE","TIMES_ROMAN","TIMES_BOLD","TIMES_ITALIC","TIMES_BOLD_ITALIC","SYMBOL","ZAPF_DINGBATS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HELVETICA","configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Font"},"fontSize":{"index":2,"kind":"parameter","displayName":"Font Size","group":"producer","label":"","required":false,"type":"number","javaType":"float","deprecated":false,"autowired":false,"secret":false,"defaultValue":14.0,"configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Font size in pixels"},"marginBottom":{"index":3,"kind":"parameter","displayName":"Margin Bottom","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20,"configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Margin bottom in pixels"},"marginLeft":{"index":4,"kind":"parameter","displayName":"Margin Left","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20,"configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Margin left in pixels"},"marginRight":{"index":5,"kind":"parameter","displayName":"Margin Right","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":40,"configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Margin right in pixels"},"marginTop":{"index":6,"kind":"parameter","displayName":"Margin Top","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20,"configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Margin top in pixels"},"pageSize":{"index":7,"kind":"parameter","displayName":"Page Size","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["LETTER","LEGAL","A0","A1","A2","A3","A4","A5","A6"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"A4","configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Page size"},"textProcessingFactory":{"index":8,"kind":"parameter","displayName":"Text Processing Factory","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.pdf.TextProcessingFactory","enum":["autoFormatting","lineTermination"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"lineTermination","configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Text processing to use. autoFormatting: Text is getting sliced by words, then max amount of words that fits in the line will be written into pdf document. With this strategy all words that doesn't fit in the line will be moved to the new line. lineTermination: Builds set of classes for line-termination writing strategy. Text getting sliced by line termination symbol and then it will be written regardless it fits in the line or not."},"lazyStartProducer":{"index":9,"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."}}} +{"component":{"kind":"component","name":"pdf","title":"PDF","description":"Create, modify or extract content from PDF documents.","deprecated":false,"firstVersion":"2.16.0","label":"document,transformation","javaType":"org.apache.camel.component.pdf.PdfComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-pdf","version":"4.8.2","scheme":"pdf","extendsScheme":"","syntax":"pdf:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"protection-policy":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.pdfbox.pdmodel.encryption.ProtectionPolicy","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Expected type is https://pdfbox.apache.org/docs/2.0.13/javadocs/org/apache/pdfbox/pdmodel/encryption/ProtectionPolicy.htmlProtectionPolicy. If specified then PDF document will be encrypted with it.","constantName":"org.apache.camel.component.pdf.PdfHeaderConstants#PROTECTION_POLICY_HEADER_NAME"},"pdf-document":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.pdfbox.pdmodel.PDDocument","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Mandatory header for append operation and ignored in all other operations. Expected type is https://pdfbox.apache.org/docs/2.0.13/javadocs/org/apache/pdfbox/pdmodel/PDDocument.htmlPDDocument. Stores PDF document which will be used for append operation.","constantName":"org.apache.camel.component.pdf.PdfHeaderConstants#PDF_DOCUMENT_HEADER_NAME"},"decryption-material":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.pdfbox.pdmodel.encryption.DecryptionMaterial","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Expected type is https://pdfbox.apache.org/docs/2.0.13/javadocs/org/apache/pdfbox/pdmodel/encryption/DecryptionMaterial.htmlDecryptionMaterial. Mandatory header if PDF document is encrypted.","constantName":"org.apache.camel.component.pdf.PdfHeaderConstants#DECRYPTION_MATERIAL_HEADER_NAME"},"files-to-merge":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.util.List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Mandatory header for merge operation and ignored in all other operations. The array of pdf files that will be merged.","constantName":"org.apache.camel.component.pdf.PdfHeaderConstants#FILES_TO_MERGE_HEADER_NAME"}},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.pdf.PdfOperation","enum":["create","append","extractText","merge"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Operation type"},"font":{"index":1,"kind":"parameter","displayName":"Font","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["COURIER","COURIER_BOLD","COURIER_OBLIQUE","COURIER_BOLD_OBLIQUE","HELVETICA","HELVETICA_BOLD","HELVETICA_OBLIQUE","HELVETICA_BOLD_OBLIQUE","TIMES_ROMAN","TIMES_BOLD","TIMES_ITALIC","TIMES_BOLD_ITALIC","SYMBOL","ZAPF_DINGBATS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HELVETICA","configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Font"},"fontSize":{"index":2,"kind":"parameter","displayName":"Font Size","group":"producer","label":"","required":false,"type":"number","javaType":"float","deprecated":false,"autowired":false,"secret":false,"defaultValue":14.0,"configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Font size in pixels"},"marginBottom":{"index":3,"kind":"parameter","displayName":"Margin Bottom","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20,"configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Margin bottom in pixels"},"marginLeft":{"index":4,"kind":"parameter","displayName":"Margin Left","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20,"configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Margin left in pixels"},"marginRight":{"index":5,"kind":"parameter","displayName":"Margin Right","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":40,"configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Margin right in pixels"},"marginTop":{"index":6,"kind":"parameter","displayName":"Margin Top","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20,"configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Margin top in pixels"},"pageSize":{"index":7,"kind":"parameter","displayName":"Page Size","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["LETTER","LEGAL","A0","A1","A2","A3","A4","A5","A6"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"A4","configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Page size"},"textProcessingFactory":{"index":8,"kind":"parameter","displayName":"Text Processing Factory","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.pdf.TextProcessingFactory","enum":["autoFormatting","lineTermination"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"lineTermination","configurationClass":"org.apache.camel.component.pdf.PdfConfiguration","configurationField":"pdfConfiguration","description":"Text processing to use. autoFormatting: Text is getting sliced by words, then max amount of words that fits in the line will be written into pdf document. With this strategy all words that doesn't fit in the line will be moved to the new line. lineTermination: Builds set of classes for line-termination writing strategy. Text getting sliced by line termination symbol and then it will be written regardless it fits in the line or not."},"lazyStartProducer":{"index":9,"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."}}} , -{"component":{"kind":"component","name":"pg-replication-slot","title":"PostgresSQL Replication Slot","description":"Poll for PostgreSQL Write-Ahead Log (WAL) records using Streaming Replication Slots.","deprecated":false,"firstVersion":"3.0.0","label":"database","javaType":"org.apache.camel.component.pg.replication.slot.PgReplicationSlotComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-pg-replication-slot","version":"4.8.1","scheme":"pg-replication-slot","extendsScheme":"","syntax":"pg-replication-slot:host:port/database/slot:outputPlugin","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"slot":{"index":0,"kind":"path","displayName":"Slot","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Replication Slot name"},"host":{"index":1,"kind":"path","displayName":"Host","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost","description":"Postgres host"},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5432","description":"Postgres port"},"database":{"index":3,"kind":"path","displayName":"Database","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Postgres database name"},"outputPlugin":{"index":4,"kind":"path","displayName":"Output Plugin","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Output plugin name"},"password":{"index":5,"kind":"parameter","displayName":"Password","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Postgres password"},"user":{"index":6,"kind":"parameter","displayName":"User","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"postgres","description":"Postgres user"},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"autoCreateSlot":{"index":12,"kind":"parameter","displayName":"Auto Create Slot","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","description":"Auto create slot if it does not exist"},"slotOptions":{"index":13,"kind":"parameter","displayName":"Slot Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"slotOptions.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Slot options to be passed to the output plugin."},"statusInterval":{"index":14,"kind":"parameter","displayName":"Status Interval","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10","description":"Specifies the number of seconds between status packets sent back to Postgres server."},"backoffErrorThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":17,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":18,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":19,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":20,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":21,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":22,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":23,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":24,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":25,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":26,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":27,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":28,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} +{"component":{"kind":"component","name":"pg-replication-slot","title":"PostgresSQL Replication Slot","description":"Poll for PostgreSQL Write-Ahead Log (WAL) records using Streaming Replication Slots.","deprecated":false,"firstVersion":"3.0.0","label":"database","javaType":"org.apache.camel.component.pg.replication.slot.PgReplicationSlotComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-pg-replication-slot","version":"4.8.2","scheme":"pg-replication-slot","extendsScheme":"","syntax":"pg-replication-slot:host:port/database/slot:outputPlugin","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"slot":{"index":0,"kind":"path","displayName":"Slot","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Replication Slot name"},"host":{"index":1,"kind":"path","displayName":"Host","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost","description":"Postgres host"},"port":{"index":2,"kind":"path","displayName":"Port","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5432","description":"Postgres port"},"database":{"index":3,"kind":"path","displayName":"Database","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Postgres database name"},"outputPlugin":{"index":4,"kind":"path","displayName":"Output Plugin","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Output plugin name"},"password":{"index":5,"kind":"parameter","displayName":"Password","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Postgres password"},"user":{"index":6,"kind":"parameter","displayName":"User","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"postgres","description":"Postgres user"},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"autoCreateSlot":{"index":12,"kind":"parameter","displayName":"Auto Create Slot","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","description":"Auto create slot if it does not exist"},"slotOptions":{"index":13,"kind":"parameter","displayName":"Slot Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"slotOptions.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Slot options to be passed to the output plugin."},"statusInterval":{"index":14,"kind":"parameter","displayName":"Status Interval","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10","description":"Specifies the number of seconds between status packets sent back to Postgres server."},"backoffErrorThreshold":{"index":15,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":17,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":18,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":19,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":20,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":21,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":22,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":23,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":24,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":25,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":26,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":27,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":28,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} , -{"component":{"kind":"component","name":"pgevent","title":"PostgresSQL Event","description":"Send and receive PostgreSQL events via LISTEN and NOTIFY commands.","deprecated":false,"firstVersion":"2.15.0","label":"database","javaType":"org.apache.camel.component.pgevent.PgEventComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-pgevent","version":"4.8.1","scheme":"pgevent","extendsScheme":"","syntax":"pgevent:host:port/database/channel","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"channel":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the channel.","constantName":"org.apache.camel.component.pgevent.PgEventConstants#HEADER_CHANNEL"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost","description":"To connect using hostname and port to the database."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5432","description":"To connect using hostname and port to the database."},"database":{"index":2,"kind":"path","displayName":"Database","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The database name. The database name can take any characters because it is sent as a quoted identifier. It is part of the endpoint URI, so diacritical marks and non-Latin letters have to be URL encoded."},"channel":{"index":3,"kind":"path","displayName":"Channel","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channel name"},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":7,"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."},"datasource":{"index":8,"kind":"parameter","displayName":"Datasource","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.sql.DataSource","deprecated":false,"autowired":false,"secret":false,"description":"To connect using the given javax.sql.DataSource instead of using hostname and port."},"pass":{"index":9,"kind":"parameter","displayName":"Pass","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Password for login"},"user":{"index":10,"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"defaultValue":"postgres","description":"Username for login"}}} +{"component":{"kind":"component","name":"pgevent","title":"PostgresSQL Event","description":"Send and receive PostgreSQL events via LISTEN and NOTIFY commands.","deprecated":false,"firstVersion":"2.15.0","label":"database","javaType":"org.apache.camel.component.pgevent.PgEventComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-pgevent","version":"4.8.2","scheme":"pgevent","extendsScheme":"","syntax":"pgevent:host:port/database/channel","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"channel":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the channel.","constantName":"org.apache.camel.component.pgevent.PgEventConstants#HEADER_CHANNEL"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost","description":"To connect using hostname and port to the database."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5432","description":"To connect using hostname and port to the database."},"database":{"index":2,"kind":"path","displayName":"Database","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The database name. The database name can take any characters because it is sent as a quoted identifier. It is part of the endpoint URI, so diacritical marks and non-Latin letters have to be URL encoded."},"channel":{"index":3,"kind":"path","displayName":"Channel","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channel name"},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":7,"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."},"datasource":{"index":8,"kind":"parameter","displayName":"Datasource","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.sql.DataSource","deprecated":false,"autowired":false,"secret":false,"description":"To connect using the given javax.sql.DataSource instead of using hostname and port."},"pass":{"index":9,"kind":"parameter","displayName":"Pass","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Password for login"},"user":{"index":10,"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"defaultValue":"postgres","description":"Username for login"}}} , -{"component":{"kind":"component","name":"pinecone","title":"Pinecone","description":"Perform operations on the Pinecone Vector Database.","deprecated":false,"firstVersion":"4.6.0","label":"database,ai","javaType":"org.apache.camel.component.pinecone.PineconeVectorDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-pinecone","version":"4.8.1","scheme":"pinecone","extendsScheme":"","syntax":"pinecone:collection","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelPineconeAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","enum":["CREATE_COLLECTION","CREATE_INDEX","UPSERT","INSERT","SEARCH","DELETE","UPDATE","QUERY","QUERY_BY_ID"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to be performed.","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#ACTION"},"CamelPineconeTextFieldName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Text Field Name for Insert/Upsert operation","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#TEXT_FIELD_NAME"},"CamelPineconeVectorFieldName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Vector Field Name for Insert/Upsert operation","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#VECTOR_FIELD_NAME"},"CamelPineconeIndexName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Index Name","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#INDEX_NAME"},"CamelPineconeIndexPodType":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Index Pod Type","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#INDEX_POD_TYPE"},"CamelPineconeIndexPodEnvironment":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Index Pod Environment","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#INDEX_POD_ENVIRONMENT"},"CamelPineconeCollectionName":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Collection Name for Insert/Upsert operation","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#COLLECTION_NAME"},"CamelPineconeCollectionSimilarityMetric":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","enum":["cosine","euclidean","dotproduct"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Collection Similarity Metric","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#COLLECTION_SIMILARITY_METRIC"},"CamelPineconeCollectionDimension":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Collection Dimension","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#COLLECTION_DIMENSION"},"CamelPineconeCollectionCloud":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","enum":["aws","gcp","azure"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Collection Cloud Vendor","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#COLLECTION_CLOUD"},"CamelPineconeCollectionCloudRegion":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","enum":["aws","gcp","azure"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Collection Cloud Vendor Region","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#COLLECTION_CLOUD_REGION"},"CamelPineconeIndexId":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Index Upsert Id","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#INDEX_ID"},"CamelPineconeQueryTopK":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Query Top K","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#QUERY_TOP_K"}},"properties":{"collection":{"index":0,"kind":"path","displayName":"Collection","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection Name"},"token":{"index":1,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.pinecone.PineconeVectorDbConfiguration","configurationField":"configuration","description":"Sets the API key to use for authentication"},"lazyStartProducer":{"index":2,"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."}}} +{"component":{"kind":"component","name":"pinecone","title":"Pinecone","description":"Perform operations on the Pinecone Vector Database.","deprecated":false,"firstVersion":"4.6.0","label":"database,ai","javaType":"org.apache.camel.component.pinecone.PineconeVectorDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-pinecone","version":"4.8.2","scheme":"pinecone","extendsScheme":"","syntax":"pinecone:collection","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelPineconeAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","enum":["CREATE_COLLECTION","CREATE_INDEX","UPSERT","INSERT","SEARCH","DELETE","UPDATE","QUERY","QUERY_BY_ID"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to be performed.","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#ACTION"},"CamelPineconeTextFieldName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Text Field Name for Insert/Upsert operation","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#TEXT_FIELD_NAME"},"CamelPineconeVectorFieldName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Vector Field Name for Insert/Upsert operation","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#VECTOR_FIELD_NAME"},"CamelPineconeIndexName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Index Name","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#INDEX_NAME"},"CamelPineconeIndexPodType":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Index Pod Type","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#INDEX_POD_TYPE"},"CamelPineconeIndexPodEnvironment":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Index Pod Environment","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#INDEX_POD_ENVIRONMENT"},"CamelPineconeCollectionName":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Collection Name for Insert/Upsert operation","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#COLLECTION_NAME"},"CamelPineconeCollectionSimilarityMetric":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","enum":["cosine","euclidean","dotproduct"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Collection Similarity Metric","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#COLLECTION_SIMILARITY_METRIC"},"CamelPineconeCollectionDimension":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Collection Dimension","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#COLLECTION_DIMENSION"},"CamelPineconeCollectionCloud":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","enum":["aws","gcp","azure"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Collection Cloud Vendor","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#COLLECTION_CLOUD"},"CamelPineconeCollectionCloudRegion":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","enum":["aws","gcp","azure"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Collection Cloud Vendor Region","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#COLLECTION_CLOUD_REGION"},"CamelPineconeIndexId":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Index Upsert Id","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#INDEX_ID"},"CamelPineconeQueryTopK":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Query Top K","constantName":"org.apache.camel.component.pinecone.PineconeVectorDb$Headers#QUERY_TOP_K"}},"properties":{"collection":{"index":0,"kind":"path","displayName":"Collection","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection Name"},"token":{"index":1,"kind":"parameter","displayName":"Token","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.pinecone.PineconeVectorDbConfiguration","configurationField":"configuration","description":"Sets the API key to use for authentication"},"lazyStartProducer":{"index":2,"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."}}} , -{"component":{"kind":"component","name":"platform-http","title":"Platform HTTP","description":"Expose HTTP endpoints using the HTTP server available in the current platform.","deprecated":false,"firstVersion":"3.0.0","label":"http","javaType":"org.apache.camel.component.platform.http.PlatformHttpComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-platform-http","version":"4.8.1","scheme":"platform-http","extendsScheme":"","syntax":"platform-http:path","async":true,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"path":{"index":0,"kind":"path","displayName":"Path","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The path under which this endpoint serves the HTTP requests, for proxy use 'proxy'"},"consumes":{"index":1,"kind":"parameter","displayName":"Consumes","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The content type this endpoint accepts as an input, such as application/xml or application/json. null or */* mean no restriction."},"cookieDomain":{"index":2,"kind":"parameter","displayName":"Cookie Domain","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.platform.http.cookie.CookieConfiguration","configurationField":"cookieConfiguration","description":"Sets which server can receive cookies."},"cookieHttpOnly":{"index":3,"kind":"parameter","displayName":"Cookie Http Only","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.platform.http.cookie.CookieConfiguration","configurationField":"cookieConfiguration","description":"Sets whether to prevent client side scripts from accessing created cookies."},"cookieMaxAge":{"index":4,"kind":"parameter","displayName":"Cookie Max Age","group":"consumer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.platform.http.cookie.CookieConfiguration","configurationField":"cookieConfiguration","description":"Sets the maximum cookie age in seconds."},"cookiePath":{"index":5,"kind":"parameter","displayName":"Cookie Path","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"/","configurationClass":"org.apache.camel.component.platform.http.cookie.CookieConfiguration","configurationField":"cookieConfiguration","description":"Sets the URL path that must exist in the requested URL in order to send the Cookie."},"cookieSameSite":{"index":6,"kind":"parameter","displayName":"Cookie Same Site","group":"consumer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.platform.http.cookie.CookieConfiguration.CookieSameSite","enum":["STRICT","LAX","NONE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Lax","configurationClass":"org.apache.camel.component.platform.http.cookie.CookieConfiguration","configurationField":"cookieConfiguration","description":"Sets whether to prevent the browser from sending cookies along with cross-site requests."},"cookieSecure":{"index":7,"kind":"parameter","displayName":"Cookie Secure","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.platform.http.cookie.CookieConfiguration","configurationField":"cookieConfiguration","description":"Sets whether the cookie is only sent to the server with an encrypted request over HTTPS."},"handleWriteResponseError":{"index":8,"kind":"parameter","displayName":"Handle Write Response Error","group":"consumer","label":"advanced,consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When Camel is complete processing the message, and the HTTP server is writing response. This option controls whether Camel should catch any failure during writing response and store this on the Exchange, which allows onCompletion/UnitOfWork to regard the Exchange as failed and have access to the caused exception from the HTTP server."},"httpMethodRestrict":{"index":9,"kind":"parameter","displayName":"Http Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"A comma separated list of HTTP methods to serve, e.g. GET,POST . If no methods are specified, all methods will be served."},"matchOnUriPrefix":{"index":10,"kind":"parameter","displayName":"Match On Uri Prefix","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found."},"muteException":{"index":11,"kind":"parameter","displayName":"Mute Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace."},"produces":{"index":12,"kind":"parameter","displayName":"Produces","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The content type this endpoint produces, such as application/xml or application/json."},"returnHttpRequestHeaders":{"index":13,"kind":"parameter","displayName":"Return Http Request Headers","group":"consumer","label":"advanced,consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to include HTTP request headers (Accept, User-Agent, etc.) into HTTP response produced by this endpoint."},"useCookieHandler":{"index":14,"kind":"parameter","displayName":"Use Cookie Handler","group":"consumer","label":"advanced,consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to enable the Cookie Handler that allows Cookie addition, expiry, and retrieval (currently only supported by camel-platform-http-vertx)"},"useStreaming":{"index":15,"kind":"parameter","displayName":"Use Streaming","group":"consumer","label":"advanced,consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to use streaming for large requests and responses (currently only supported by camel-platform-http-vertx)"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"fileNameExtWhitelist":{"index":19,"kind":"parameter","displayName":"File Name Ext Whitelist","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"A comma or whitespace separated list of file extensions. Uploads having these extensions will be stored locally. Null value or asterisk () will allow all files."},"headerFilterStrategy":{"index":20,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter headers to and from Camel message."},"platformHttpEngine":{"index":21,"kind":"parameter","displayName":"Platform Http Engine","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.platform.http.spi.PlatformHttpEngine","deprecated":false,"autowired":false,"secret":false,"description":"An HTTP Server engine implementation to serve the requests of this endpoint."}}} +{"component":{"kind":"component","name":"platform-http","title":"Platform HTTP","description":"Expose HTTP endpoints using the HTTP server available in the current platform.","deprecated":false,"firstVersion":"3.0.0","label":"http","javaType":"org.apache.camel.component.platform.http.PlatformHttpComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-platform-http","version":"4.8.2","scheme":"platform-http","extendsScheme":"","syntax":"platform-http:path","async":true,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"path":{"index":0,"kind":"path","displayName":"Path","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The path under which this endpoint serves the HTTP requests, for proxy use 'proxy'"},"consumes":{"index":1,"kind":"parameter","displayName":"Consumes","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The content type this endpoint accepts as an input, such as application/xml or application/json. null or */* mean no restriction."},"cookieDomain":{"index":2,"kind":"parameter","displayName":"Cookie Domain","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.platform.http.cookie.CookieConfiguration","configurationField":"cookieConfiguration","description":"Sets which server can receive cookies."},"cookieHttpOnly":{"index":3,"kind":"parameter","displayName":"Cookie Http Only","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.platform.http.cookie.CookieConfiguration","configurationField":"cookieConfiguration","description":"Sets whether to prevent client side scripts from accessing created cookies."},"cookieMaxAge":{"index":4,"kind":"parameter","displayName":"Cookie Max Age","group":"consumer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.platform.http.cookie.CookieConfiguration","configurationField":"cookieConfiguration","description":"Sets the maximum cookie age in seconds."},"cookiePath":{"index":5,"kind":"parameter","displayName":"Cookie Path","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"/","configurationClass":"org.apache.camel.component.platform.http.cookie.CookieConfiguration","configurationField":"cookieConfiguration","description":"Sets the URL path that must exist in the requested URL in order to send the Cookie."},"cookieSameSite":{"index":6,"kind":"parameter","displayName":"Cookie Same Site","group":"consumer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.platform.http.cookie.CookieConfiguration.CookieSameSite","enum":["STRICT","LAX","NONE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Lax","configurationClass":"org.apache.camel.component.platform.http.cookie.CookieConfiguration","configurationField":"cookieConfiguration","description":"Sets whether to prevent the browser from sending cookies along with cross-site requests."},"cookieSecure":{"index":7,"kind":"parameter","displayName":"Cookie Secure","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.platform.http.cookie.CookieConfiguration","configurationField":"cookieConfiguration","description":"Sets whether the cookie is only sent to the server with an encrypted request over HTTPS."},"handleWriteResponseError":{"index":8,"kind":"parameter","displayName":"Handle Write Response Error","group":"consumer","label":"advanced,consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When Camel is complete processing the message, and the HTTP server is writing response. This option controls whether Camel should catch any failure during writing response and store this on the Exchange, which allows onCompletion/UnitOfWork to regard the Exchange as failed and have access to the caused exception from the HTTP server."},"httpMethodRestrict":{"index":9,"kind":"parameter","displayName":"Http Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"A comma separated list of HTTP methods to serve, e.g. GET,POST . If no methods are specified, all methods will be served."},"matchOnUriPrefix":{"index":10,"kind":"parameter","displayName":"Match On Uri Prefix","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found."},"muteException":{"index":11,"kind":"parameter","displayName":"Mute Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace."},"produces":{"index":12,"kind":"parameter","displayName":"Produces","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The content type this endpoint produces, such as application/xml or application/json."},"returnHttpRequestHeaders":{"index":13,"kind":"parameter","displayName":"Return Http Request Headers","group":"consumer","label":"advanced,consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to include HTTP request headers (Accept, User-Agent, etc.) into HTTP response produced by this endpoint."},"useCookieHandler":{"index":14,"kind":"parameter","displayName":"Use Cookie Handler","group":"consumer","label":"advanced,consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to enable the Cookie Handler that allows Cookie addition, expiry, and retrieval (currently only supported by camel-platform-http-vertx)"},"useStreaming":{"index":15,"kind":"parameter","displayName":"Use Streaming","group":"consumer","label":"advanced,consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to use streaming for large requests and responses (currently only supported by camel-platform-http-vertx)"},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":17,"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":{"index":18,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"fileNameExtWhitelist":{"index":19,"kind":"parameter","displayName":"File Name Ext Whitelist","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"A comma or whitespace separated list of file extensions. Uploads having these extensions will be stored locally. Null value or asterisk () will allow all files."},"headerFilterStrategy":{"index":20,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter headers to and from Camel message."},"platformHttpEngine":{"index":21,"kind":"parameter","displayName":"Platform Http Engine","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.platform.http.spi.PlatformHttpEngine","deprecated":false,"autowired":false,"secret":false,"description":"An HTTP Server engine implementation to serve the requests of this endpoint."}}} , -{"component":{"kind":"component","name":"plc4x","title":"PLC4X","description":"Read and write to PLC devices","deprecated":false,"firstVersion":"3.20.0","label":"iot","javaType":"org.apache.camel.component.plc4x.Plc4XComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-plc4x","version":"4.8.1","scheme":"plc4x","extendsScheme":"","syntax":"plc4x:driver","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"driver":{"index":0,"kind":"path","displayName":"Driver","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"PLC4X connection string for the connection to the target"},"autoReconnect":{"index":1,"kind":"parameter","displayName":"Auto Reconnect","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Whether to reconnect when no connection is present upon doing a request"},"period":{"index":2,"kind":"parameter","displayName":"Period","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Interval on which the Trigger should be checked"},"tags":{"index":3,"kind":"parameter","displayName":"Tags","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"java.util.Map","prefix":"tag.","multiValue":true,"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tags as key/values from the Map to use in query"},"trigger":{"index":4,"kind":"parameter","displayName":"Trigger","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Query to a trigger. On a rising edge of the trigger, the tags will be read once"},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."}}} +{"component":{"kind":"component","name":"plc4x","title":"PLC4X","description":"Read and write to PLC devices","deprecated":false,"firstVersion":"3.20.0","label":"iot","javaType":"org.apache.camel.component.plc4x.Plc4XComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-plc4x","version":"4.8.2","scheme":"plc4x","extendsScheme":"","syntax":"plc4x:driver","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"driver":{"index":0,"kind":"path","displayName":"Driver","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"PLC4X connection string for the connection to the target"},"autoReconnect":{"index":1,"kind":"parameter","displayName":"Auto Reconnect","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Whether to reconnect when no connection is present upon doing a request"},"period":{"index":2,"kind":"parameter","displayName":"Period","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Interval on which the Trigger should be checked"},"tags":{"index":3,"kind":"parameter","displayName":"Tags","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"java.util.Map","prefix":"tag.","multiValue":true,"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tags as key/values from the Map to use in query"},"trigger":{"index":4,"kind":"parameter","displayName":"Trigger","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Query to a trigger. On a rising edge of the trigger, the tags will be read once"},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."}}} , -{"component":{"kind":"component","name":"pop3","title":"POP3","description":"Send and receive emails using imap, pop3 and smtp protocols.","deprecated":false,"firstVersion":"1.0.0","label":"mail","javaType":"org.apache.camel.component.mail.MailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mail","version":"4.8.1","scheme":"pop3","extendsScheme":"","alternativeSchemes":"imap,imaps,pop3,pop3s,smtp,smtps","syntax":"pop3:host:port","alternativeSyntax":"pop3:username:password@host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"Subject":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Subject","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_SUBJECT"},"From":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"From","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_FROM"},"To":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_TO"},"Cc":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CC"},"Bcc":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Bcc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_BCC"},"Reply-To":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reply to","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_REPLY_TO"},"contentType":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CONTENT_TYPE"},"copyTo":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be copied to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_COPY_TO"},"moveTo":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be moved to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MOVE_TO"},"delete":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Deletes the messages after they have been processed.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_DELETE"},"CamelMailMessageId":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message ID.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MESSAGE_ID"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail server host name"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The port number of the mail server"},"closeFolder":{"index":2,"kind":"parameter","displayName":"Close Folder","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keeps the folder open between polls."},"copyTo":{"index":3,"kind":"parameter","displayName":"Copy To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime."},"decodeFilename":{"index":4,"kind":"parameter","displayName":"Decode Filename","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If set to true, the MimeUtility.decodeText method will be used to decode the filename. This is similar to setting JVM system property mail.mime.encodefilename."},"delete":{"index":5,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. You can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not."},"disconnect":{"index":6,"kind":"parameter","displayName":"Disconnect","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should disconnect after polling. If enabled, this forces Camel to connect on each poll."},"handleFailedMessage":{"index":7,"kind":"parameter","displayName":"Handle Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows handling the caused exception by the consumer's error handler. By enabling the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"maxMessagesPerPoll":{"index":8,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option."},"mimeDecodeHeaders":{"index":9,"kind":"parameter","displayName":"Mime Decode Headers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"This option enables transparent MIME decoding and unfolding for mail headers."},"moveTo":{"index":10,"kind":"parameter","displayName":"Move To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be moved to a mail folder with the given name. You can override this configuration value with a header with the key moveTo, allowing you to move messages to folder names configured at runtime."},"peek":{"index":11,"kind":"parameter","displayName":"Peek","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Will mark the jakarta.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek, the mail will not be eagerly marked as SEEN on the mail server, which allows us to roll back the mail message if there is a processing error in Camel."},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skipFailedMessage":{"index":13,"kind":"parameter","displayName":"Skip Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows skipping the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"unseen":{"index":14,"kind":"parameter","displayName":"Unseen","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to limit by unseen mails only."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"failOnDuplicateFileAttachment":{"index":18,"kind":"parameter","displayName":"Fail On Duplicate File Attachment","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to fail processing the mail if the mail message contains attachments with duplicate file names. If set to false, then the duplicate attachment is skipped and a WARN is logged. If set to true, then an exception is thrown failing to process the mail message."},"fetchSize":{"index":19,"kind":"parameter","displayName":"Fetch Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. The default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all."},"folderName":{"index":20,"kind":"parameter","displayName":"Folder Name","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INBOX","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The folder to poll."},"generateMissingAttachmentNames":{"index":21,"kind":"parameter","displayName":"Generate Missing Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set this to 'uuid' to set a UUID for the filename of the attachment if no filename was set"},"handleDuplicateAttachmentNames":{"index":22,"kind":"parameter","displayName":"Handle Duplicate Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set the strategy to handle duplicate filenames of attachments never: attachments that have a filename which is already present in the attachments will be ignored unless failOnDuplicateFileAttachment is set to true. uuidPrefix: this will prefix the duplicate attachment filenames each with an uuid and underscore (uuid_filename.fileextension). uuidSuffix: this will suffix the duplicate attachment filenames each with an underscore and uuid (filename_uuid.fileextension)."},"mailUidGenerator":{"index":23,"kind":"parameter","displayName":"Mail Uid Generator","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailUidGenerator","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message."},"mapMailMessage":{"index":24,"kind":"parameter","displayName":"Map Mail Message","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. If this option is set to false, then the IN message contains a raw jakarta.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(jakarta.mail.Message.class)."},"pollStrategy":{"index":25,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"postProcessAction":{"index":26,"kind":"parameter","displayName":"Post Process Action","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBoxPostProcessAction","deprecated":false,"autowired":false,"secret":false,"description":"Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended."},"bcc":{"index":27,"kind":"parameter","displayName":"Bcc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the BCC email address. Separate multiple email addresses with comma."},"cc":{"index":28,"kind":"parameter","displayName":"Cc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the CC email address. Separate multiple email addresses with comma."},"from":{"index":29,"kind":"parameter","displayName":"From","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel@localhost","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The from email address"},"replyTo":{"index":30,"kind":"parameter","displayName":"Reply To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma."},"subject":{"index":31,"kind":"parameter","displayName":"Subject","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option."},"to":{"index":32,"kind":"parameter","displayName":"To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the destination email address. Separate multiple email addresses with comma."},"javaMailSender":{"index":33,"kind":"parameter","displayName":"Java Mail Sender","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.JavaMailSender","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails."},"lazyStartProducer":{"index":34,"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."},"additionalJavaMailProperties":{"index":35,"kind":"parameter","displayName":"Additional Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","prefix":"mail.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets additional java mail properties, that will append/override any default properties that are set based on all the other options. This is useful if you need to add some special options but want to keep the others as is."},"alternativeBodyHeader":{"index":36,"kind":"parameter","displayName":"Alternative Body Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelMailAlternativeBody","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header."},"attachmentsContentTransferEncodingResolver":{"index":37,"kind":"parameter","displayName":"Attachments Content Transfer Encoding Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments."},"authenticator":{"index":38,"kind":"parameter","displayName":"Authenticator","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailAuthenticator","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The authenticator for login. If set then the password and username are ignored. It can be used for tokens which can expire and therefore must be read dynamically."},"binding":{"index":39,"kind":"parameter","displayName":"Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBinding","deprecated":false,"autowired":false,"secret":false,"description":"Sets the binding used to convert from a Camel message to and from a Mail message"},"connectionTimeout":{"index":40,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The connection timeout in milliseconds."},"contentType":{"index":41,"kind":"parameter","displayName":"Content Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"text/plain","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail message content type. Use text/html for HTML mails."},"contentTypeResolver":{"index":42,"kind":"parameter","displayName":"Content Type Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.ContentTypeResolver","deprecated":false,"autowired":false,"secret":false,"description":"Resolver to determine Content-Type for file attachments."},"debugMode":{"index":43,"kind":"parameter","displayName":"Debug Mode","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default."},"headerFilterStrategy":{"index":44,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."},"ignoreUnsupportedCharset":{"index":45,"kind":"parameter","displayName":"Ignore Unsupported Charset","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"ignoreUriScheme":{"index":46,"kind":"parameter","displayName":"Ignore Uri Scheme","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"javaMailProperties":{"index":47,"kind":"parameter","displayName":"Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the java mail options. Will clear any default properties and only use the properties provided for this method."},"session":{"index":48,"kind":"parameter","displayName":"Session","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.mail.Session","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session)."},"useInlineAttachments":{"index":49,"kind":"parameter","displayName":"Use Inline Attachments","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to use disposition inline or attachment."},"idempotentRepository":{"index":50,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use."},"idempotentRepositoryRemoveOnCommit":{"index":51,"kind":"parameter","displayName":"Idempotent Repository Remove On Commit","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have."},"searchTerm":{"index":52,"kind":"parameter","displayName":"Search Term","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"jakarta.mail.search.SearchTerm","prefix":"searchTerm.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Refers to a jakarta.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc."},"backoffErrorThreshold":{"index":53,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":54,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":55,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":56,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Milliseconds before the next poll."},"greedy":{"index":57,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":58,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":59,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":60,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":61,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":62,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":63,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":64,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":65,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":66,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":67,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The password for login. See also setAuthenticator(MailAuthenticator)."},"sslContextParameters":{"index":68,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters."},"username":{"index":69,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The username for login. See also setAuthenticator(MailAuthenticator)."},"sortTerm":{"index":70,"kind":"parameter","displayName":"Sort Term","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"org.eclipse.angus.mail.imap.SortTerm[]","deprecated":false,"autowired":false,"secret":false,"description":"Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability."}}} +{"component":{"kind":"component","name":"pop3","title":"POP3","description":"Send and receive emails using imap, pop3 and smtp protocols.","deprecated":false,"firstVersion":"1.0.0","label":"mail","javaType":"org.apache.camel.component.mail.MailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mail","version":"4.8.2","scheme":"pop3","extendsScheme":"","alternativeSchemes":"imap,imaps,pop3,pop3s,smtp,smtps","syntax":"pop3:host:port","alternativeSyntax":"pop3:username:password@host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"Subject":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Subject","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_SUBJECT"},"From":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"From","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_FROM"},"To":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_TO"},"Cc":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CC"},"Bcc":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Bcc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_BCC"},"Reply-To":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reply to","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_REPLY_TO"},"contentType":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CONTENT_TYPE"},"copyTo":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be copied to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_COPY_TO"},"moveTo":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be moved to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MOVE_TO"},"delete":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Deletes the messages after they have been processed.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_DELETE"},"CamelMailMessageId":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message ID.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MESSAGE_ID"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail server host name"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The port number of the mail server"},"closeFolder":{"index":2,"kind":"parameter","displayName":"Close Folder","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keeps the folder open between polls."},"copyTo":{"index":3,"kind":"parameter","displayName":"Copy To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime."},"decodeFilename":{"index":4,"kind":"parameter","displayName":"Decode Filename","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If set to true, the MimeUtility.decodeText method will be used to decode the filename. This is similar to setting JVM system property mail.mime.encodefilename."},"delete":{"index":5,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. You can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not."},"disconnect":{"index":6,"kind":"parameter","displayName":"Disconnect","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should disconnect after polling. If enabled, this forces Camel to connect on each poll."},"handleFailedMessage":{"index":7,"kind":"parameter","displayName":"Handle Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows handling the caused exception by the consumer's error handler. By enabling the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"maxMessagesPerPoll":{"index":8,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option."},"mimeDecodeHeaders":{"index":9,"kind":"parameter","displayName":"Mime Decode Headers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"This option enables transparent MIME decoding and unfolding for mail headers."},"moveTo":{"index":10,"kind":"parameter","displayName":"Move To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be moved to a mail folder with the given name. You can override this configuration value with a header with the key moveTo, allowing you to move messages to folder names configured at runtime."},"peek":{"index":11,"kind":"parameter","displayName":"Peek","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Will mark the jakarta.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek, the mail will not be eagerly marked as SEEN on the mail server, which allows us to roll back the mail message if there is a processing error in Camel."},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skipFailedMessage":{"index":13,"kind":"parameter","displayName":"Skip Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows skipping the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"unseen":{"index":14,"kind":"parameter","displayName":"Unseen","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to limit by unseen mails only."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"failOnDuplicateFileAttachment":{"index":18,"kind":"parameter","displayName":"Fail On Duplicate File Attachment","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to fail processing the mail if the mail message contains attachments with duplicate file names. If set to false, then the duplicate attachment is skipped and a WARN is logged. If set to true, then an exception is thrown failing to process the mail message."},"fetchSize":{"index":19,"kind":"parameter","displayName":"Fetch Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. The default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all."},"folderName":{"index":20,"kind":"parameter","displayName":"Folder Name","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INBOX","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The folder to poll."},"generateMissingAttachmentNames":{"index":21,"kind":"parameter","displayName":"Generate Missing Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set this to 'uuid' to set a UUID for the filename of the attachment if no filename was set"},"handleDuplicateAttachmentNames":{"index":22,"kind":"parameter","displayName":"Handle Duplicate Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set the strategy to handle duplicate filenames of attachments never: attachments that have a filename which is already present in the attachments will be ignored unless failOnDuplicateFileAttachment is set to true. uuidPrefix: this will prefix the duplicate attachment filenames each with an uuid and underscore (uuid_filename.fileextension). uuidSuffix: this will suffix the duplicate attachment filenames each with an underscore and uuid (filename_uuid.fileextension)."},"mailUidGenerator":{"index":23,"kind":"parameter","displayName":"Mail Uid Generator","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailUidGenerator","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message."},"mapMailMessage":{"index":24,"kind":"parameter","displayName":"Map Mail Message","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. If this option is set to false, then the IN message contains a raw jakarta.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(jakarta.mail.Message.class)."},"pollStrategy":{"index":25,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"postProcessAction":{"index":26,"kind":"parameter","displayName":"Post Process Action","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBoxPostProcessAction","deprecated":false,"autowired":false,"secret":false,"description":"Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended."},"bcc":{"index":27,"kind":"parameter","displayName":"Bcc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the BCC email address. Separate multiple email addresses with comma."},"cc":{"index":28,"kind":"parameter","displayName":"Cc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the CC email address. Separate multiple email addresses with comma."},"from":{"index":29,"kind":"parameter","displayName":"From","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel@localhost","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The from email address"},"replyTo":{"index":30,"kind":"parameter","displayName":"Reply To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma."},"subject":{"index":31,"kind":"parameter","displayName":"Subject","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option."},"to":{"index":32,"kind":"parameter","displayName":"To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the destination email address. Separate multiple email addresses with comma."},"javaMailSender":{"index":33,"kind":"parameter","displayName":"Java Mail Sender","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.JavaMailSender","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails."},"lazyStartProducer":{"index":34,"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."},"additionalJavaMailProperties":{"index":35,"kind":"parameter","displayName":"Additional Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","prefix":"mail.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets additional java mail properties, that will append/override any default properties that are set based on all the other options. This is useful if you need to add some special options but want to keep the others as is."},"alternativeBodyHeader":{"index":36,"kind":"parameter","displayName":"Alternative Body Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelMailAlternativeBody","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header."},"attachmentsContentTransferEncodingResolver":{"index":37,"kind":"parameter","displayName":"Attachments Content Transfer Encoding Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments."},"authenticator":{"index":38,"kind":"parameter","displayName":"Authenticator","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailAuthenticator","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The authenticator for login. If set then the password and username are ignored. It can be used for tokens which can expire and therefore must be read dynamically."},"binding":{"index":39,"kind":"parameter","displayName":"Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBinding","deprecated":false,"autowired":false,"secret":false,"description":"Sets the binding used to convert from a Camel message to and from a Mail message"},"connectionTimeout":{"index":40,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The connection timeout in milliseconds."},"contentType":{"index":41,"kind":"parameter","displayName":"Content Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"text/plain","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail message content type. Use text/html for HTML mails."},"contentTypeResolver":{"index":42,"kind":"parameter","displayName":"Content Type Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.ContentTypeResolver","deprecated":false,"autowired":false,"secret":false,"description":"Resolver to determine Content-Type for file attachments."},"debugMode":{"index":43,"kind":"parameter","displayName":"Debug Mode","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default."},"headerFilterStrategy":{"index":44,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."},"ignoreUnsupportedCharset":{"index":45,"kind":"parameter","displayName":"Ignore Unsupported Charset","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"ignoreUriScheme":{"index":46,"kind":"parameter","displayName":"Ignore Uri Scheme","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"javaMailProperties":{"index":47,"kind":"parameter","displayName":"Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the java mail options. Will clear any default properties and only use the properties provided for this method."},"session":{"index":48,"kind":"parameter","displayName":"Session","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.mail.Session","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session)."},"useInlineAttachments":{"index":49,"kind":"parameter","displayName":"Use Inline Attachments","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to use disposition inline or attachment."},"idempotentRepository":{"index":50,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use."},"idempotentRepositoryRemoveOnCommit":{"index":51,"kind":"parameter","displayName":"Idempotent Repository Remove On Commit","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have."},"searchTerm":{"index":52,"kind":"parameter","displayName":"Search Term","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"jakarta.mail.search.SearchTerm","prefix":"searchTerm.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Refers to a jakarta.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc."},"backoffErrorThreshold":{"index":53,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":54,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":55,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":56,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Milliseconds before the next poll."},"greedy":{"index":57,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":58,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":59,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":60,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":61,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":62,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":63,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":64,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":65,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":66,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":67,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The password for login. See also setAuthenticator(MailAuthenticator)."},"sslContextParameters":{"index":68,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters."},"username":{"index":69,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The username for login. See also setAuthenticator(MailAuthenticator)."},"sortTerm":{"index":70,"kind":"parameter","displayName":"Sort Term","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"org.eclipse.angus.mail.imap.SortTerm[]","deprecated":false,"autowired":false,"secret":false,"description":"Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability."}}} , -{"component":{"kind":"component","name":"pop3s","title":"POP3S","description":"Send and receive emails using imap, pop3 and smtp protocols.","deprecated":false,"firstVersion":"1.0.0","label":"mail","javaType":"org.apache.camel.component.mail.MailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mail","version":"4.8.1","scheme":"pop3s","extendsScheme":"","alternativeSchemes":"imap,imaps,pop3,pop3s,smtp,smtps","syntax":"pop3s:host:port","alternativeSyntax":"pop3s:username:password@host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"Subject":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Subject","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_SUBJECT"},"From":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"From","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_FROM"},"To":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_TO"},"Cc":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CC"},"Bcc":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Bcc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_BCC"},"Reply-To":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reply to","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_REPLY_TO"},"contentType":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CONTENT_TYPE"},"copyTo":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be copied to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_COPY_TO"},"moveTo":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be moved to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MOVE_TO"},"delete":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Deletes the messages after they have been processed.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_DELETE"},"CamelMailMessageId":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message ID.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MESSAGE_ID"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail server host name"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The port number of the mail server"},"closeFolder":{"index":2,"kind":"parameter","displayName":"Close Folder","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keeps the folder open between polls."},"copyTo":{"index":3,"kind":"parameter","displayName":"Copy To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime."},"decodeFilename":{"index":4,"kind":"parameter","displayName":"Decode Filename","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If set to true, the MimeUtility.decodeText method will be used to decode the filename. This is similar to setting JVM system property mail.mime.encodefilename."},"delete":{"index":5,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. You can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not."},"disconnect":{"index":6,"kind":"parameter","displayName":"Disconnect","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should disconnect after polling. If enabled, this forces Camel to connect on each poll."},"handleFailedMessage":{"index":7,"kind":"parameter","displayName":"Handle Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows handling the caused exception by the consumer's error handler. By enabling the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"maxMessagesPerPoll":{"index":8,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option."},"mimeDecodeHeaders":{"index":9,"kind":"parameter","displayName":"Mime Decode Headers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"This option enables transparent MIME decoding and unfolding for mail headers."},"moveTo":{"index":10,"kind":"parameter","displayName":"Move To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be moved to a mail folder with the given name. You can override this configuration value with a header with the key moveTo, allowing you to move messages to folder names configured at runtime."},"peek":{"index":11,"kind":"parameter","displayName":"Peek","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Will mark the jakarta.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek, the mail will not be eagerly marked as SEEN on the mail server, which allows us to roll back the mail message if there is a processing error in Camel."},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skipFailedMessage":{"index":13,"kind":"parameter","displayName":"Skip Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows skipping the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"unseen":{"index":14,"kind":"parameter","displayName":"Unseen","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to limit by unseen mails only."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"failOnDuplicateFileAttachment":{"index":18,"kind":"parameter","displayName":"Fail On Duplicate File Attachment","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to fail processing the mail if the mail message contains attachments with duplicate file names. If set to false, then the duplicate attachment is skipped and a WARN is logged. If set to true, then an exception is thrown failing to process the mail message."},"fetchSize":{"index":19,"kind":"parameter","displayName":"Fetch Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. The default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all."},"folderName":{"index":20,"kind":"parameter","displayName":"Folder Name","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INBOX","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The folder to poll."},"generateMissingAttachmentNames":{"index":21,"kind":"parameter","displayName":"Generate Missing Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set this to 'uuid' to set a UUID for the filename of the attachment if no filename was set"},"handleDuplicateAttachmentNames":{"index":22,"kind":"parameter","displayName":"Handle Duplicate Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set the strategy to handle duplicate filenames of attachments never: attachments that have a filename which is already present in the attachments will be ignored unless failOnDuplicateFileAttachment is set to true. uuidPrefix: this will prefix the duplicate attachment filenames each with an uuid and underscore (uuid_filename.fileextension). uuidSuffix: this will suffix the duplicate attachment filenames each with an underscore and uuid (filename_uuid.fileextension)."},"mailUidGenerator":{"index":23,"kind":"parameter","displayName":"Mail Uid Generator","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailUidGenerator","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message."},"mapMailMessage":{"index":24,"kind":"parameter","displayName":"Map Mail Message","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. If this option is set to false, then the IN message contains a raw jakarta.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(jakarta.mail.Message.class)."},"pollStrategy":{"index":25,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"postProcessAction":{"index":26,"kind":"parameter","displayName":"Post Process Action","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBoxPostProcessAction","deprecated":false,"autowired":false,"secret":false,"description":"Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended."},"bcc":{"index":27,"kind":"parameter","displayName":"Bcc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the BCC email address. Separate multiple email addresses with comma."},"cc":{"index":28,"kind":"parameter","displayName":"Cc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the CC email address. Separate multiple email addresses with comma."},"from":{"index":29,"kind":"parameter","displayName":"From","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel@localhost","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The from email address"},"replyTo":{"index":30,"kind":"parameter","displayName":"Reply To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma."},"subject":{"index":31,"kind":"parameter","displayName":"Subject","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option."},"to":{"index":32,"kind":"parameter","displayName":"To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the destination email address. Separate multiple email addresses with comma."},"javaMailSender":{"index":33,"kind":"parameter","displayName":"Java Mail Sender","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.JavaMailSender","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails."},"lazyStartProducer":{"index":34,"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."},"additionalJavaMailProperties":{"index":35,"kind":"parameter","displayName":"Additional Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","prefix":"mail.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets additional java mail properties, that will append/override any default properties that are set based on all the other options. This is useful if you need to add some special options but want to keep the others as is."},"alternativeBodyHeader":{"index":36,"kind":"parameter","displayName":"Alternative Body Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelMailAlternativeBody","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header."},"attachmentsContentTransferEncodingResolver":{"index":37,"kind":"parameter","displayName":"Attachments Content Transfer Encoding Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments."},"authenticator":{"index":38,"kind":"parameter","displayName":"Authenticator","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailAuthenticator","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The authenticator for login. If set then the password and username are ignored. It can be used for tokens which can expire and therefore must be read dynamically."},"binding":{"index":39,"kind":"parameter","displayName":"Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBinding","deprecated":false,"autowired":false,"secret":false,"description":"Sets the binding used to convert from a Camel message to and from a Mail message"},"connectionTimeout":{"index":40,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The connection timeout in milliseconds."},"contentType":{"index":41,"kind":"parameter","displayName":"Content Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"text/plain","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail message content type. Use text/html for HTML mails."},"contentTypeResolver":{"index":42,"kind":"parameter","displayName":"Content Type Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.ContentTypeResolver","deprecated":false,"autowired":false,"secret":false,"description":"Resolver to determine Content-Type for file attachments."},"debugMode":{"index":43,"kind":"parameter","displayName":"Debug Mode","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default."},"headerFilterStrategy":{"index":44,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."},"ignoreUnsupportedCharset":{"index":45,"kind":"parameter","displayName":"Ignore Unsupported Charset","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"ignoreUriScheme":{"index":46,"kind":"parameter","displayName":"Ignore Uri Scheme","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"javaMailProperties":{"index":47,"kind":"parameter","displayName":"Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the java mail options. Will clear any default properties and only use the properties provided for this method."},"session":{"index":48,"kind":"parameter","displayName":"Session","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.mail.Session","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session)."},"useInlineAttachments":{"index":49,"kind":"parameter","displayName":"Use Inline Attachments","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to use disposition inline or attachment."},"idempotentRepository":{"index":50,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use."},"idempotentRepositoryRemoveOnCommit":{"index":51,"kind":"parameter","displayName":"Idempotent Repository Remove On Commit","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have."},"searchTerm":{"index":52,"kind":"parameter","displayName":"Search Term","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"jakarta.mail.search.SearchTerm","prefix":"searchTerm.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Refers to a jakarta.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc."},"backoffErrorThreshold":{"index":53,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":54,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":55,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":56,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Milliseconds before the next poll."},"greedy":{"index":57,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":58,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":59,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":60,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":61,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":62,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":63,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":64,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":65,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":66,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":67,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The password for login. See also setAuthenticator(MailAuthenticator)."},"sslContextParameters":{"index":68,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters."},"username":{"index":69,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The username for login. See also setAuthenticator(MailAuthenticator)."},"sortTerm":{"index":70,"kind":"parameter","displayName":"Sort Term","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"org.eclipse.angus.mail.imap.SortTerm[]","deprecated":false,"autowired":false,"secret":false,"description":"Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability."}}} +{"component":{"kind":"component","name":"pop3s","title":"POP3S","description":"Send and receive emails using imap, pop3 and smtp protocols.","deprecated":false,"firstVersion":"1.0.0","label":"mail","javaType":"org.apache.camel.component.mail.MailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mail","version":"4.8.2","scheme":"pop3s","extendsScheme":"","alternativeSchemes":"imap,imaps,pop3,pop3s,smtp,smtps","syntax":"pop3s:host:port","alternativeSyntax":"pop3s:username:password@host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"Subject":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Subject","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_SUBJECT"},"From":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"From","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_FROM"},"To":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_TO"},"Cc":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CC"},"Bcc":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Bcc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_BCC"},"Reply-To":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reply to","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_REPLY_TO"},"contentType":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CONTENT_TYPE"},"copyTo":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be copied to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_COPY_TO"},"moveTo":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be moved to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MOVE_TO"},"delete":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Deletes the messages after they have been processed.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_DELETE"},"CamelMailMessageId":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message ID.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MESSAGE_ID"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail server host name"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The port number of the mail server"},"closeFolder":{"index":2,"kind":"parameter","displayName":"Close Folder","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keeps the folder open between polls."},"copyTo":{"index":3,"kind":"parameter","displayName":"Copy To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime."},"decodeFilename":{"index":4,"kind":"parameter","displayName":"Decode Filename","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If set to true, the MimeUtility.decodeText method will be used to decode the filename. This is similar to setting JVM system property mail.mime.encodefilename."},"delete":{"index":5,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. You can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not."},"disconnect":{"index":6,"kind":"parameter","displayName":"Disconnect","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should disconnect after polling. If enabled, this forces Camel to connect on each poll."},"handleFailedMessage":{"index":7,"kind":"parameter","displayName":"Handle Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows handling the caused exception by the consumer's error handler. By enabling the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"maxMessagesPerPoll":{"index":8,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option."},"mimeDecodeHeaders":{"index":9,"kind":"parameter","displayName":"Mime Decode Headers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"This option enables transparent MIME decoding and unfolding for mail headers."},"moveTo":{"index":10,"kind":"parameter","displayName":"Move To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be moved to a mail folder with the given name. You can override this configuration value with a header with the key moveTo, allowing you to move messages to folder names configured at runtime."},"peek":{"index":11,"kind":"parameter","displayName":"Peek","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Will mark the jakarta.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek, the mail will not be eagerly marked as SEEN on the mail server, which allows us to roll back the mail message if there is a processing error in Camel."},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skipFailedMessage":{"index":13,"kind":"parameter","displayName":"Skip Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows skipping the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"unseen":{"index":14,"kind":"parameter","displayName":"Unseen","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to limit by unseen mails only."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"failOnDuplicateFileAttachment":{"index":18,"kind":"parameter","displayName":"Fail On Duplicate File Attachment","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to fail processing the mail if the mail message contains attachments with duplicate file names. If set to false, then the duplicate attachment is skipped and a WARN is logged. If set to true, then an exception is thrown failing to process the mail message."},"fetchSize":{"index":19,"kind":"parameter","displayName":"Fetch Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. The default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all."},"folderName":{"index":20,"kind":"parameter","displayName":"Folder Name","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INBOX","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The folder to poll."},"generateMissingAttachmentNames":{"index":21,"kind":"parameter","displayName":"Generate Missing Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set this to 'uuid' to set a UUID for the filename of the attachment if no filename was set"},"handleDuplicateAttachmentNames":{"index":22,"kind":"parameter","displayName":"Handle Duplicate Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set the strategy to handle duplicate filenames of attachments never: attachments that have a filename which is already present in the attachments will be ignored unless failOnDuplicateFileAttachment is set to true. uuidPrefix: this will prefix the duplicate attachment filenames each with an uuid and underscore (uuid_filename.fileextension). uuidSuffix: this will suffix the duplicate attachment filenames each with an underscore and uuid (filename_uuid.fileextension)."},"mailUidGenerator":{"index":23,"kind":"parameter","displayName":"Mail Uid Generator","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailUidGenerator","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message."},"mapMailMessage":{"index":24,"kind":"parameter","displayName":"Map Mail Message","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. If this option is set to false, then the IN message contains a raw jakarta.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(jakarta.mail.Message.class)."},"pollStrategy":{"index":25,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"postProcessAction":{"index":26,"kind":"parameter","displayName":"Post Process Action","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBoxPostProcessAction","deprecated":false,"autowired":false,"secret":false,"description":"Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended."},"bcc":{"index":27,"kind":"parameter","displayName":"Bcc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the BCC email address. Separate multiple email addresses with comma."},"cc":{"index":28,"kind":"parameter","displayName":"Cc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the CC email address. Separate multiple email addresses with comma."},"from":{"index":29,"kind":"parameter","displayName":"From","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel@localhost","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The from email address"},"replyTo":{"index":30,"kind":"parameter","displayName":"Reply To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma."},"subject":{"index":31,"kind":"parameter","displayName":"Subject","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option."},"to":{"index":32,"kind":"parameter","displayName":"To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the destination email address. Separate multiple email addresses with comma."},"javaMailSender":{"index":33,"kind":"parameter","displayName":"Java Mail Sender","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.JavaMailSender","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails."},"lazyStartProducer":{"index":34,"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."},"additionalJavaMailProperties":{"index":35,"kind":"parameter","displayName":"Additional Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","prefix":"mail.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets additional java mail properties, that will append/override any default properties that are set based on all the other options. This is useful if you need to add some special options but want to keep the others as is."},"alternativeBodyHeader":{"index":36,"kind":"parameter","displayName":"Alternative Body Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelMailAlternativeBody","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header."},"attachmentsContentTransferEncodingResolver":{"index":37,"kind":"parameter","displayName":"Attachments Content Transfer Encoding Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments."},"authenticator":{"index":38,"kind":"parameter","displayName":"Authenticator","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailAuthenticator","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The authenticator for login. If set then the password and username are ignored. It can be used for tokens which can expire and therefore must be read dynamically."},"binding":{"index":39,"kind":"parameter","displayName":"Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBinding","deprecated":false,"autowired":false,"secret":false,"description":"Sets the binding used to convert from a Camel message to and from a Mail message"},"connectionTimeout":{"index":40,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The connection timeout in milliseconds."},"contentType":{"index":41,"kind":"parameter","displayName":"Content Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"text/plain","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail message content type. Use text/html for HTML mails."},"contentTypeResolver":{"index":42,"kind":"parameter","displayName":"Content Type Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.ContentTypeResolver","deprecated":false,"autowired":false,"secret":false,"description":"Resolver to determine Content-Type for file attachments."},"debugMode":{"index":43,"kind":"parameter","displayName":"Debug Mode","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default."},"headerFilterStrategy":{"index":44,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."},"ignoreUnsupportedCharset":{"index":45,"kind":"parameter","displayName":"Ignore Unsupported Charset","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"ignoreUriScheme":{"index":46,"kind":"parameter","displayName":"Ignore Uri Scheme","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"javaMailProperties":{"index":47,"kind":"parameter","displayName":"Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the java mail options. Will clear any default properties and only use the properties provided for this method."},"session":{"index":48,"kind":"parameter","displayName":"Session","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.mail.Session","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session)."},"useInlineAttachments":{"index":49,"kind":"parameter","displayName":"Use Inline Attachments","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to use disposition inline or attachment."},"idempotentRepository":{"index":50,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use."},"idempotentRepositoryRemoveOnCommit":{"index":51,"kind":"parameter","displayName":"Idempotent Repository Remove On Commit","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have."},"searchTerm":{"index":52,"kind":"parameter","displayName":"Search Term","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"jakarta.mail.search.SearchTerm","prefix":"searchTerm.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Refers to a jakarta.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc."},"backoffErrorThreshold":{"index":53,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":54,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":55,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":56,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Milliseconds before the next poll."},"greedy":{"index":57,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":58,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":59,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":60,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":61,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":62,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":63,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":64,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":65,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":66,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":67,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The password for login. See also setAuthenticator(MailAuthenticator)."},"sslContextParameters":{"index":68,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters."},"username":{"index":69,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The username for login. See also setAuthenticator(MailAuthenticator)."},"sortTerm":{"index":70,"kind":"parameter","displayName":"Sort Term","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"org.eclipse.angus.mail.imap.SortTerm[]","deprecated":false,"autowired":false,"secret":false,"description":"Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability."}}} , -{"component":{"kind":"component","name":"pubnub","title":"PubNub","description":"Send and receive messages to/from PubNub data stream network for connected devices.","deprecated":false,"firstVersion":"2.19.0","label":"cloud,iot,messaging","javaType":"org.apache.camel.component.pubnub.PubNubComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-pubnub","version":"4.8.1","scheme":"pubnub","extendsScheme":"","syntax":"pubnub:channel","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelPubNubOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.pubnub.PubNubConstants#OPERATION"},"CamelPubNubTimeToken":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Timestamp for the event.","constantName":"org.apache.camel.component.pubnub.PubNubConstants#TIMETOKEN"},"CamelPubNubChannel":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channel for which the message belongs.","constantName":"org.apache.camel.component.pubnub.PubNubConstants#CHANNEL"},"CamelPubNubUUID":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"UUID to be used as a device identifier.","constantName":"org.apache.camel.component.pubnub.PubNubConstants#UUID"}},"properties":{"channel":{"index":0,"kind":"path","displayName":"Channel","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"The channel used for subscribing/publishing events"},"uuid":{"index":1,"kind":"parameter","displayName":"Uuid","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"UUID to be used as a device identifier, a default UUID is generated if not passed."},"withPresence":{"index":2,"kind":"parameter","displayName":"With Presence","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"Also subscribe to related presence information"},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":6,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["HERENOW","GETSTATE","SETSTATE","GETHISTORY","PUBLISH","FIRE"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"The operation to perform. PUBLISH: Default. Send a message to all subscribers of a channel. FIRE: allows the client to send a message to BLOCKS Event Handlers. These messages will go directly to any Event Handlers registered on the channel. HERENOW: Obtain information about the current state of a channel including a list of unique user-ids currently subscribed to the channel and the total occupancy count. GETSTATE: Used to get key/value pairs specific to a subscriber uuid. State information is supplied as a JSON object of key/value pairs SETSTATE: Used to set key/value pairs specific to a subscriber uuid GETHISTORY: Fetches historical messages of a channel."},"lazyStartProducer":{"index":7,"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."},"pubnub":{"index":8,"kind":"parameter","displayName":"Pubnub","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.pubnub.api.PubNub","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"description":"Reference to a Pubnub client in the registry."},"authKey":{"index":9,"kind":"parameter","displayName":"Auth Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"If Access Manager is utilized, client will use this authKey in all restricted requests."},"cipherKey":{"index":10,"kind":"parameter","displayName":"Cipher Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"If cipher is passed, all communications to/from PubNub will be encrypted."},"publishKey":{"index":11,"kind":"parameter","displayName":"Publish Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"The publish key obtained from your PubNub account. Required when publishing messages."},"secretKey":{"index":12,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"The secret key used for message signing."},"secure":{"index":13,"kind":"parameter","displayName":"Secure","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"Use SSL for secure transmission."},"subscribeKey":{"index":14,"kind":"parameter","displayName":"Subscribe Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening for presence events"}}} +{"component":{"kind":"component","name":"pubnub","title":"PubNub","description":"Send and receive messages to/from PubNub data stream network for connected devices.","deprecated":false,"firstVersion":"2.19.0","label":"cloud,iot,messaging","javaType":"org.apache.camel.component.pubnub.PubNubComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-pubnub","version":"4.8.2","scheme":"pubnub","extendsScheme":"","syntax":"pubnub:channel","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelPubNubOperation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.pubnub.PubNubConstants#OPERATION"},"CamelPubNubTimeToken":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Timestamp for the event.","constantName":"org.apache.camel.component.pubnub.PubNubConstants#TIMETOKEN"},"CamelPubNubChannel":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channel for which the message belongs.","constantName":"org.apache.camel.component.pubnub.PubNubConstants#CHANNEL"},"CamelPubNubUUID":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"UUID to be used as a device identifier.","constantName":"org.apache.camel.component.pubnub.PubNubConstants#UUID"}},"properties":{"channel":{"index":0,"kind":"path","displayName":"Channel","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"The channel used for subscribing/publishing events"},"uuid":{"index":1,"kind":"parameter","displayName":"Uuid","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"UUID to be used as a device identifier, a default UUID is generated if not passed."},"withPresence":{"index":2,"kind":"parameter","displayName":"With Presence","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"Also subscribe to related presence information"},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"operation":{"index":6,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["HERENOW","GETSTATE","SETSTATE","GETHISTORY","PUBLISH","FIRE"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"The operation to perform. PUBLISH: Default. Send a message to all subscribers of a channel. FIRE: allows the client to send a message to BLOCKS Event Handlers. These messages will go directly to any Event Handlers registered on the channel. HERENOW: Obtain information about the current state of a channel including a list of unique user-ids currently subscribed to the channel and the total occupancy count. GETSTATE: Used to get key/value pairs specific to a subscriber uuid. State information is supplied as a JSON object of key/value pairs SETSTATE: Used to set key/value pairs specific to a subscriber uuid GETHISTORY: Fetches historical messages of a channel."},"lazyStartProducer":{"index":7,"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."},"pubnub":{"index":8,"kind":"parameter","displayName":"Pubnub","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.pubnub.api.PubNub","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"description":"Reference to a Pubnub client in the registry."},"authKey":{"index":9,"kind":"parameter","displayName":"Auth Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"If Access Manager is utilized, client will use this authKey in all restricted requests."},"cipherKey":{"index":10,"kind":"parameter","displayName":"Cipher Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"If cipher is passed, all communications to/from PubNub will be encrypted."},"publishKey":{"index":11,"kind":"parameter","displayName":"Publish Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"The publish key obtained from your PubNub account. Required when publishing messages."},"secretKey":{"index":12,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"The secret key used for message signing."},"secure":{"index":13,"kind":"parameter","displayName":"Secure","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"Use SSL for secure transmission."},"subscribeKey":{"index":14,"kind":"parameter","displayName":"Subscribe Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.pubnub.PubNubConfiguration","configurationField":"configuration","description":"The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening for presence events"}}} , -{"component":{"kind":"component","name":"pulsar","title":"Pulsar","description":"Send and receive messages from/to Apache Pulsar messaging system.","deprecated":false,"firstVersion":"2.24.0","label":"messaging","javaType":"org.apache.camel.component.pulsar.PulsarComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-pulsar","version":"4.8.1","scheme":"pulsar","extendsScheme":"","syntax":"pulsar:persistence://tenant/namespace/topic","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"properties":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The properties attached to the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PROPERTIES"},"producer_name":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The producer name who produced the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PRODUCER_NAME"},"sequence_id":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sequence id associated with the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#SEQUENCE_ID"},"publish_time":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The publish time of the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PUBLISH_TIME"},"message_id":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.pulsar.client.api.MessageId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The unique message ID associated with the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#MESSAGE_ID"},"event_time":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event time associated with the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#EVENT_TIME"},"key":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#KEY"},"key_bytes":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bytes in key.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#KEY_BYTES"},"topic_name":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The topic the message was published to.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#TOPIC_NAME"},"message_receipt":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.pulsar.PulsarMessageReceipt","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message receipt.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#MESSAGE_RECEIPT"},"CamelPulsarProducerMessageKey":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the message for routing policy.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#KEY_OUT"},"CamelPulsarProducerMessageProperties":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The properties of the message to add.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PROPERTIES_OUT"},"CamelPulsarProducerMessageEventTime":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event time of the message message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#EVENT_TIME_OUT"},"CamelPulsarProducerMessageDeliverAt":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Deliver the message only at or after the specified absolute timestamp. The timestamp is milliseconds and based on UTC (eg: System.currentTimeMillis) Note: messages are only delivered with delay when a consumer is consuming through a Shared subscription. With other subscription types, the messages will still be delivered immediately.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#DELIVER_AT_OUT"},"CamelPulsarRedeliveryCount":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message redelivery count, redelivery count maintain in pulsar broker.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PULSAR_REDELIVERY_COUNT"}},"properties":{"persistence":{"index":0,"kind":"path","displayName":"Persistence","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["persistent","non-persistent"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Whether the topic is persistent or non-persistent"},"tenant":{"index":1,"kind":"path","displayName":"Tenant","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tenant"},"namespace":{"index":2,"kind":"path","displayName":"Namespace","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace"},"topic":{"index":3,"kind":"path","displayName":"Topic","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The topic"},"authenticationClass":{"index":4,"kind":"parameter","displayName":"Authentication Class","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The Authentication FQCN to be used while creating the client from URI"},"authenticationParams":{"index":5,"kind":"parameter","displayName":"Authentication Params","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The Authentication Parameters to be used while creating the client from URI"},"serviceUrl":{"index":6,"kind":"parameter","displayName":"Service Url","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The Pulsar Service URL to point while creating the client from URI"},"ackGroupTimeMillis":{"index":7,"kind":"parameter","displayName":"Ack Group Time Millis","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Group the consumer acknowledgments for the specified time in milliseconds - defaults to 100"},"ackTimeoutMillis":{"index":8,"kind":"parameter","displayName":"Ack Timeout Millis","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Timeout for unacknowledged messages in milliseconds - defaults to 10000"},"ackTimeoutRedeliveryBackoff":{"index":9,"kind":"parameter","displayName":"Ack Timeout Redelivery Backoff","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.RedeliveryBackoff","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"RedeliveryBackoff to use for ack timeout redelivery backoff."},"allowManualAcknowledgement":{"index":10,"kind":"parameter","displayName":"Allow Manual Acknowledgement","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Whether to allow manual message acknowledgements. If this option is enabled, then messages are not acknowledged automatically after successful route completion. Instead, an instance of PulsarMessageReceipt is stored as a header on the org.apache.camel.Exchange. Messages can then be acknowledged using PulsarMessageReceipt at any time before the ackTimeout occurs."},"consumerName":{"index":11,"kind":"parameter","displayName":"Consumer Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"sole-consumer","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Name of the consumer when subscription is EXCLUSIVE"},"consumerNamePrefix":{"index":12,"kind":"parameter","displayName":"Consumer Name Prefix","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"cons","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Prefix to add to consumer names when a SHARED or FAILOVER subscription is used"},"consumerQueueSize":{"index":13,"kind":"parameter","displayName":"Consumer Queue Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Size of the consumer queue - defaults to 10"},"deadLetterTopic":{"index":14,"kind":"parameter","displayName":"Dead Letter Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Name of the topic where the messages which fail maxRedeliverCount times will be sent. Note: if not set, default topic name will be topicName-subscriptionName-DLQ"},"enableRetry":{"index":15,"kind":"parameter","displayName":"Enable Retry","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"To enable retry letter topic mode. The default retry letter topic uses this format: topicname-subscriptionname-RETRY"},"keySharedPolicy":{"index":16,"kind":"parameter","displayName":"Key Shared Policy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["AUTO_SPLIT","STICKY"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Policy to use by consumer when using key-shared subscription type."},"maxRedeliverCount":{"index":17,"kind":"parameter","displayName":"Max Redeliver Count","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Maximum number of times that a message will be redelivered before being sent to the dead letter queue. If this value is not set, no Dead Letter Policy will be created"},"messageListener":{"index":18,"kind":"parameter","displayName":"Message Listener","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Whether to use the messageListener interface, or to receive messages using a separate thread pool"},"negativeAckRedeliveryBackoff":{"index":19,"kind":"parameter","displayName":"Negative Ack Redelivery Backoff","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.RedeliveryBackoff","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"RedeliveryBackoff to use for negative ack redelivery backoff."},"negativeAckRedeliveryDelayMicros":{"index":20,"kind":"parameter","displayName":"Negative Ack Redelivery Delay Micros","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Set the negative acknowledgement delay"},"numberOfConsumers":{"index":21,"kind":"parameter","displayName":"Number Of Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Number of consumers - defaults to 1"},"numberOfConsumerThreads":{"index":22,"kind":"parameter","displayName":"Number Of Consumer Threads","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Number of threads to receive and handle messages when using a separate thread pool"},"readCompacted":{"index":23,"kind":"parameter","displayName":"Read Compacted","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Enable compacted topic reading."},"retryLetterTopic":{"index":24,"kind":"parameter","displayName":"Retry Letter Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Name of the topic to use in retry mode. Note: if not set, default topic name will be topicName-subscriptionName-RETRY"},"subscriptionInitialPosition":{"index":25,"kind":"parameter","displayName":"Subscription Initial Position","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.pulsar.utils.consumers.SubscriptionInitialPosition","enum":["EARLIEST","LATEST"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"LATEST","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Control the initial position in the topic of a newly created subscription. Default is latest message."},"subscriptionName":{"index":26,"kind":"parameter","displayName":"Subscription Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"subs","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Name of the subscription to use"},"subscriptionTopicsMode":{"index":27,"kind":"parameter","displayName":"Subscription Topics Mode","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.RegexSubscriptionMode","enum":["PersistentOnly","NonPersistentOnly","AllTopics"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PersistentOnly","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both. Only used with pattern subscriptions."},"subscriptionType":{"index":28,"kind":"parameter","displayName":"Subscription Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.pulsar.utils.consumers.SubscriptionType","enum":["EXCLUSIVE","SHARED","FAILOVER","KEY_SHARED"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"EXCLUSIVE","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Type of the subscription EXCLUSIVESHAREDFAILOVERKEY_SHARED, defaults to EXCLUSIVE"},"topicsPattern":{"index":29,"kind":"parameter","displayName":"Topics Pattern","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Whether the topic is a pattern (regular expression) that allows the consumer to subscribe to all matching topics in the namespace"},"bridgeErrorHandler":{"index":30,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":31,"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":{"index":32,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"batcherBuilder":{"index":33,"kind":"parameter","displayName":"Batcher Builder","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.BatcherBuilder","deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEFAULT","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Control batching method used by the producer."},"batchingEnabled":{"index":34,"kind":"parameter","displayName":"Batching Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Control whether automatic batching of messages is enabled for the producer."},"batchingMaxMessages":{"index":35,"kind":"parameter","displayName":"Batching Max Messages","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The maximum size to batch messages."},"batchingMaxPublishDelayMicros":{"index":36,"kind":"parameter","displayName":"Batching Max Publish Delay Micros","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The maximum time period within which the messages sent will be batched if batchingEnabled is true."},"blockIfQueueFull":{"index":37,"kind":"parameter","displayName":"Block If Queue Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Whether to block the producing thread if pending messages queue is full or to throw a ProducerQueueIsFullError"},"chunkingEnabled":{"index":38,"kind":"parameter","displayName":"Chunking Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Control whether chunking of messages is enabled for the producer."},"compressionType":{"index":39,"kind":"parameter","displayName":"Compression Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.CompressionType","enum":["NONE","LZ4","ZLIB","ZSTD","SNAPPY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"NONE","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Compression type to use"},"hashingScheme":{"index":40,"kind":"parameter","displayName":"Hashing Scheme","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["JavaStringHash","Murmur3_32Hash"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"JavaStringHash","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Hashing function to use when choosing the partition to use for a particular message"},"initialSequenceId":{"index":41,"kind":"parameter","displayName":"Initial Sequence Id","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The first message published will have a sequence Id of initialSequenceId 1."},"maxPendingMessages":{"index":42,"kind":"parameter","displayName":"Max Pending Messages","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Size of the pending massages queue. When the queue is full, by default, any further sends will fail unless blockIfQueueFull=true"},"maxPendingMessagesAcrossPartitions":{"index":43,"kind":"parameter","displayName":"Max Pending Messages Across Partitions","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":true,"autowired":false,"secret":false,"defaultValue":50000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The maximum number of pending messages for partitioned topics. The maxPendingMessages value will be reduced if (number of partitions maxPendingMessages) exceeds this value. Partitioned topics have a pending message queue for each partition."},"messageRouter":{"index":44,"kind":"parameter","displayName":"Message Router","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.MessageRouter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Custom Message Router to use"},"messageRoutingMode":{"index":45,"kind":"parameter","displayName":"Message Routing Mode","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.MessageRoutingMode","enum":["SinglePartition","RoundRobinPartition","CustomPartition"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"RoundRobinPartition","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Message Routing Mode to use"},"producerName":{"index":46,"kind":"parameter","displayName":"Producer Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Name of the producer. If unset, lets Pulsar select a unique identifier."},"sendTimeoutMs":{"index":47,"kind":"parameter","displayName":"Send Timeout Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Send timeout in milliseconds"},"lazyStartProducer":{"index":48,"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."}}} +{"component":{"kind":"component","name":"pulsar","title":"Pulsar","description":"Send and receive messages from/to Apache Pulsar messaging system.","deprecated":false,"firstVersion":"2.24.0","label":"messaging","javaType":"org.apache.camel.component.pulsar.PulsarComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-pulsar","version":"4.8.2","scheme":"pulsar","extendsScheme":"","syntax":"pulsar:persistence://tenant/namespace/topic","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"properties":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The properties attached to the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PROPERTIES"},"producer_name":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The producer name who produced the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PRODUCER_NAME"},"sequence_id":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sequence id associated with the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#SEQUENCE_ID"},"publish_time":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The publish time of the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PUBLISH_TIME"},"message_id":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.pulsar.client.api.MessageId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The unique message ID associated with the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#MESSAGE_ID"},"event_time":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event time associated with the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#EVENT_TIME"},"key":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#KEY"},"key_bytes":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bytes in key.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#KEY_BYTES"},"topic_name":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The topic the message was published to.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#TOPIC_NAME"},"message_receipt":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.pulsar.PulsarMessageReceipt","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message receipt.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#MESSAGE_RECEIPT"},"CamelPulsarProducerMessageKey":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the message for routing policy.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#KEY_OUT"},"CamelPulsarProducerMessageProperties":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The properties of the message to add.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PROPERTIES_OUT"},"CamelPulsarProducerMessageEventTime":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event time of the message message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#EVENT_TIME_OUT"},"CamelPulsarProducerMessageDeliverAt":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Deliver the message only at or after the specified absolute timestamp. The timestamp is milliseconds and based on UTC (eg: System.currentTimeMillis) Note: messages are only delivered with delay when a consumer is consuming through a Shared subscription. With other subscription types, the messages will still be delivered immediately.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#DELIVER_AT_OUT"},"CamelPulsarRedeliveryCount":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message redelivery count, redelivery count maintain in pulsar broker.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PULSAR_REDELIVERY_COUNT"}},"properties":{"persistence":{"index":0,"kind":"path","displayName":"Persistence","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["persistent","non-persistent"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Whether the topic is persistent or non-persistent"},"tenant":{"index":1,"kind":"path","displayName":"Tenant","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tenant"},"namespace":{"index":2,"kind":"path","displayName":"Namespace","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace"},"topic":{"index":3,"kind":"path","displayName":"Topic","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The topic"},"authenticationClass":{"index":4,"kind":"parameter","displayName":"Authentication Class","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The Authentication FQCN to be used while creating the client from URI"},"authenticationParams":{"index":5,"kind":"parameter","displayName":"Authentication Params","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The Authentication Parameters to be used while creating the client from URI"},"serviceUrl":{"index":6,"kind":"parameter","displayName":"Service Url","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The Pulsar Service URL to point while creating the client from URI"},"ackGroupTimeMillis":{"index":7,"kind":"parameter","displayName":"Ack Group Time Millis","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Group the consumer acknowledgments for the specified time in milliseconds - defaults to 100"},"ackTimeoutMillis":{"index":8,"kind":"parameter","displayName":"Ack Timeout Millis","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Timeout for unacknowledged messages in milliseconds - defaults to 10000"},"ackTimeoutRedeliveryBackoff":{"index":9,"kind":"parameter","displayName":"Ack Timeout Redelivery Backoff","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.RedeliveryBackoff","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"RedeliveryBackoff to use for ack timeout redelivery backoff."},"allowManualAcknowledgement":{"index":10,"kind":"parameter","displayName":"Allow Manual Acknowledgement","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Whether to allow manual message acknowledgements. If this option is enabled, then messages are not acknowledged automatically after successful route completion. Instead, an instance of PulsarMessageReceipt is stored as a header on the org.apache.camel.Exchange. Messages can then be acknowledged using PulsarMessageReceipt at any time before the ackTimeout occurs."},"consumerName":{"index":11,"kind":"parameter","displayName":"Consumer Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"sole-consumer","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Name of the consumer when subscription is EXCLUSIVE"},"consumerNamePrefix":{"index":12,"kind":"parameter","displayName":"Consumer Name Prefix","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"cons","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Prefix to add to consumer names when a SHARED or FAILOVER subscription is used"},"consumerQueueSize":{"index":13,"kind":"parameter","displayName":"Consumer Queue Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Size of the consumer queue - defaults to 10"},"deadLetterTopic":{"index":14,"kind":"parameter","displayName":"Dead Letter Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Name of the topic where the messages which fail maxRedeliverCount times will be sent. Note: if not set, default topic name will be topicName-subscriptionName-DLQ"},"enableRetry":{"index":15,"kind":"parameter","displayName":"Enable Retry","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"To enable retry letter topic mode. The default retry letter topic uses this format: topicname-subscriptionname-RETRY"},"keySharedPolicy":{"index":16,"kind":"parameter","displayName":"Key Shared Policy","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["AUTO_SPLIT","STICKY"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Policy to use by consumer when using key-shared subscription type."},"maxRedeliverCount":{"index":17,"kind":"parameter","displayName":"Max Redeliver Count","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Maximum number of times that a message will be redelivered before being sent to the dead letter queue. If this value is not set, no Dead Letter Policy will be created"},"messageListener":{"index":18,"kind":"parameter","displayName":"Message Listener","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Whether to use the messageListener interface, or to receive messages using a separate thread pool"},"negativeAckRedeliveryBackoff":{"index":19,"kind":"parameter","displayName":"Negative Ack Redelivery Backoff","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.RedeliveryBackoff","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"RedeliveryBackoff to use for negative ack redelivery backoff."},"negativeAckRedeliveryDelayMicros":{"index":20,"kind":"parameter","displayName":"Negative Ack Redelivery Delay Micros","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Set the negative acknowledgement delay"},"numberOfConsumers":{"index":21,"kind":"parameter","displayName":"Number Of Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Number of consumers - defaults to 1"},"numberOfConsumerThreads":{"index":22,"kind":"parameter","displayName":"Number Of Consumer Threads","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Number of threads to receive and handle messages when using a separate thread pool"},"readCompacted":{"index":23,"kind":"parameter","displayName":"Read Compacted","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Enable compacted topic reading."},"retryLetterTopic":{"index":24,"kind":"parameter","displayName":"Retry Letter Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Name of the topic to use in retry mode. Note: if not set, default topic name will be topicName-subscriptionName-RETRY"},"subscriptionInitialPosition":{"index":25,"kind":"parameter","displayName":"Subscription Initial Position","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.pulsar.utils.consumers.SubscriptionInitialPosition","enum":["EARLIEST","LATEST"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"LATEST","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Control the initial position in the topic of a newly created subscription. Default is latest message."},"subscriptionName":{"index":26,"kind":"parameter","displayName":"Subscription Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"subs","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Name of the subscription to use"},"subscriptionTopicsMode":{"index":27,"kind":"parameter","displayName":"Subscription Topics Mode","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.RegexSubscriptionMode","enum":["PersistentOnly","NonPersistentOnly","AllTopics"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PersistentOnly","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both. Only used with pattern subscriptions."},"subscriptionType":{"index":28,"kind":"parameter","displayName":"Subscription Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.pulsar.utils.consumers.SubscriptionType","enum":["EXCLUSIVE","SHARED","FAILOVER","KEY_SHARED"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"EXCLUSIVE","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Type of the subscription EXCLUSIVESHAREDFAILOVERKEY_SHARED, defaults to EXCLUSIVE"},"topicsPattern":{"index":29,"kind":"parameter","displayName":"Topics Pattern","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Whether the topic is a pattern (regular expression) that allows the consumer to subscribe to all matching topics in the namespace"},"bridgeErrorHandler":{"index":30,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":31,"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":{"index":32,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"batcherBuilder":{"index":33,"kind":"parameter","displayName":"Batcher Builder","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.BatcherBuilder","deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEFAULT","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Control batching method used by the producer."},"batchingEnabled":{"index":34,"kind":"parameter","displayName":"Batching Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Control whether automatic batching of messages is enabled for the producer."},"batchingMaxMessages":{"index":35,"kind":"parameter","displayName":"Batching Max Messages","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The maximum size to batch messages."},"batchingMaxPublishDelayMicros":{"index":36,"kind":"parameter","displayName":"Batching Max Publish Delay Micros","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The maximum time period within which the messages sent will be batched if batchingEnabled is true."},"blockIfQueueFull":{"index":37,"kind":"parameter","displayName":"Block If Queue Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Whether to block the producing thread if pending messages queue is full or to throw a ProducerQueueIsFullError"},"chunkingEnabled":{"index":38,"kind":"parameter","displayName":"Chunking Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Control whether chunking of messages is enabled for the producer."},"compressionType":{"index":39,"kind":"parameter","displayName":"Compression Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.CompressionType","enum":["NONE","LZ4","ZLIB","ZSTD","SNAPPY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"NONE","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Compression type to use"},"hashingScheme":{"index":40,"kind":"parameter","displayName":"Hashing Scheme","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["JavaStringHash","Murmur3_32Hash"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"JavaStringHash","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Hashing function to use when choosing the partition to use for a particular message"},"initialSequenceId":{"index":41,"kind":"parameter","displayName":"Initial Sequence Id","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The first message published will have a sequence Id of initialSequenceId 1."},"maxPendingMessages":{"index":42,"kind":"parameter","displayName":"Max Pending Messages","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Size of the pending massages queue. When the queue is full, by default, any further sends will fail unless blockIfQueueFull=true"},"maxPendingMessagesAcrossPartitions":{"index":43,"kind":"parameter","displayName":"Max Pending Messages Across Partitions","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":true,"autowired":false,"secret":false,"defaultValue":50000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The maximum number of pending messages for partitioned topics. The maxPendingMessages value will be reduced if (number of partitions maxPendingMessages) exceeds this value. Partitioned topics have a pending message queue for each partition."},"messageRouter":{"index":44,"kind":"parameter","displayName":"Message Router","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.MessageRouter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Custom Message Router to use"},"messageRoutingMode":{"index":45,"kind":"parameter","displayName":"Message Routing Mode","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.MessageRoutingMode","enum":["SinglePartition","RoundRobinPartition","CustomPartition"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"RoundRobinPartition","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Message Routing Mode to use"},"producerName":{"index":46,"kind":"parameter","displayName":"Producer Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Name of the producer. If unset, lets Pulsar select a unique identifier."},"sendTimeoutMs":{"index":47,"kind":"parameter","displayName":"Send Timeout Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Send timeout in milliseconds"},"lazyStartProducer":{"index":48,"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."}}} , -{"component":{"kind":"component","name":"qdrant","title":"Qdrant","description":"Perform operations on the Qdrant Vector Database.","deprecated":false,"firstVersion":"4.5.0","label":"database,ai","javaType":"org.apache.camel.component.qdrant.QdrantComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-qdrant","version":"4.8.1","scheme":"qdrant","extendsScheme":"","syntax":"qdrant:collection","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelQdrantAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","enum":["CREATE_COLLECTION","DELETE_COLLECTION","UPSERT","RETRIEVE","DELETE","COLLECTION_INFO"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to be performed.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#ACTION"},"CamelQdrantPointsPayloadSelector":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"io.qdrant.client.grpc.Points$WithPayloadSelector","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Payload Selector.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#PAYLOAD_SELECTOR"},"CamelQdrantOperationID":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation ID.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#OPERATION_ID"},"CamelQdrantOperationStatus":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation Status.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#OPERATION_STATUS"},"CamelQdrantOperationStatusValue":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation Status Value.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#OPERATION_STATUS_VALUE"},"CamelQdrantReadConsistency":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"io.qdrant.client.grpc.Points$ReadConsistency","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Read Consistency.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#READ_CONSISTENCY"},"CamelQdrantWithPayload":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"true","description":"Include Payload.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#INCLUDE_PAYLOAD"},"CamelQdrantWithVectors":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Include Vectors.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#INCLUDE_VECTORS"},"CamelQdrantSize":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of elements.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#SIZE"},"CamelQdrantPointId":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The point id to use for operation.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#POINT_ID"}},"properties":{"collection":{"index":0,"kind":"path","displayName":"Collection","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection Name"},"apiKey":{"index":1,"kind":"parameter","displayName":"Api Key","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.qdrant.QdrantConfiguration","configurationField":"configuration","description":"Sets the API key to use for authentication"},"host":{"index":2,"kind":"parameter","displayName":"Host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.qdrant.QdrantConfiguration","configurationField":"configuration","description":"The host to connect to."},"port":{"index":3,"kind":"parameter","displayName":"Port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":6334,"configurationClass":"org.apache.camel.component.qdrant.QdrantConfiguration","configurationField":"configuration","description":"The port to connect to."},"timeout":{"index":4,"kind":"parameter","displayName":"Timeout","group":"producer","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.qdrant.QdrantConfiguration","configurationField":"configuration","description":"Sets a default timeout for all requests"},"tls":{"index":5,"kind":"parameter","displayName":"Tls","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.qdrant.QdrantConfiguration","configurationField":"configuration","description":"Whether the client uses Transport Layer Security (TLS) to secure communications"},"lazyStartProducer":{"index":6,"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."}}} +{"component":{"kind":"component","name":"qdrant","title":"Qdrant","description":"Perform operations on the Qdrant Vector Database.","deprecated":false,"firstVersion":"4.5.0","label":"database,ai","javaType":"org.apache.camel.component.qdrant.QdrantComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-qdrant","version":"4.8.2","scheme":"qdrant","extendsScheme":"","syntax":"qdrant:collection","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelQdrantAction":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","enum":["CREATE_COLLECTION","DELETE_COLLECTION","UPSERT","RETRIEVE","DELETE","COLLECTION_INFO"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to be performed.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#ACTION"},"CamelQdrantPointsPayloadSelector":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"io.qdrant.client.grpc.Points$WithPayloadSelector","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Payload Selector.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#PAYLOAD_SELECTOR"},"CamelQdrantOperationID":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation ID.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#OPERATION_ID"},"CamelQdrantOperationStatus":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation Status.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#OPERATION_STATUS"},"CamelQdrantOperationStatusValue":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation Status Value.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#OPERATION_STATUS_VALUE"},"CamelQdrantReadConsistency":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"io.qdrant.client.grpc.Points$ReadConsistency","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Read Consistency.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#READ_CONSISTENCY"},"CamelQdrantWithPayload":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"true","description":"Include Payload.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#INCLUDE_PAYLOAD"},"CamelQdrantWithVectors":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Include Vectors.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#INCLUDE_VECTORS"},"CamelQdrantSize":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of elements.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#SIZE"},"CamelQdrantPointId":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The point id to use for operation.","constantName":"org.apache.camel.component.qdrant.Qdrant$Headers#POINT_ID"}},"properties":{"collection":{"index":0,"kind":"path","displayName":"Collection","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection Name"},"apiKey":{"index":1,"kind":"parameter","displayName":"Api Key","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.qdrant.QdrantConfiguration","configurationField":"configuration","description":"Sets the API key to use for authentication"},"host":{"index":2,"kind":"parameter","displayName":"Host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.qdrant.QdrantConfiguration","configurationField":"configuration","description":"The host to connect to."},"port":{"index":3,"kind":"parameter","displayName":"Port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":6334,"configurationClass":"org.apache.camel.component.qdrant.QdrantConfiguration","configurationField":"configuration","description":"The port to connect to."},"timeout":{"index":4,"kind":"parameter","displayName":"Timeout","group":"producer","label":"","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.qdrant.QdrantConfiguration","configurationField":"configuration","description":"Sets a default timeout for all requests"},"tls":{"index":5,"kind":"parameter","displayName":"Tls","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.qdrant.QdrantConfiguration","configurationField":"configuration","description":"Whether the client uses Transport Layer Security (TLS) to secure communications"},"lazyStartProducer":{"index":6,"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."}}} , -{"component":{"kind":"component","name":"quartz","title":"Quartz","description":"Schedule sending of messages using the Quartz 2.x scheduler.","deprecated":false,"firstVersion":"2.12.0","label":"scheduling","javaType":"org.apache.camel.component.quartz.QuartzComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-quartz","version":"4.8.1","scheme":"quartz","extendsScheme":"","syntax":"quartz:groupName/triggerName","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"groupName":{"index":0,"kind":"path","displayName":"Group Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Camel","description":"The quartz group name to use. The combination of group name and trigger name should be unique."},"triggerName":{"index":1,"kind":"path","displayName":"Trigger Name","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The quartz trigger name to use. The combination of group name and trigger name should be unique."},"cron":{"index":2,"kind":"parameter","displayName":"Cron","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies a cron expression to define when to trigger."},"deleteJob":{"index":3,"kind":"parameter","displayName":"Delete Job","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If set to true, then the trigger automatically delete when route stop. Else if set to false, it will remain in scheduler. When set to false, it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true."},"durableJob":{"index":4,"kind":"parameter","displayName":"Durable Job","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not the job should remain stored after it is orphaned (no triggers point to it)."},"pauseJob":{"index":5,"kind":"parameter","displayName":"Pause Job","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set to true, then the trigger automatically pauses when route stop. Else if set to false, it will remain in scheduler. When set to false, it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true."},"recoverableJob":{"index":6,"kind":"parameter","displayName":"Recoverable Job","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Instructs the scheduler whether or not the job should be re-executed if a 'recovery' or 'fail-over' situation is encountered."},"stateful":{"index":7,"kind":"parameter","displayName":"Stateful","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Uses a Quartz PersistJobDataAfterExecution and DisallowConcurrentExecution instead of the default job."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"customCalendar":{"index":11,"kind":"parameter","displayName":"Custom Calendar","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.quartz.Calendar","deprecated":false,"autowired":false,"secret":false,"description":"Specifies a custom calendar to avoid specific range of date"},"ignoreExpiredNextFireTime":{"index":12,"kind":"parameter","displayName":"Ignore Expired Next Fire Time","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to ignore quartz cannot schedule a trigger because the trigger will never fire in the future. This can happen when using a cron trigger that are configured to only run in the past. By default, Quartz will fail to schedule the trigger and therefore fail to start the Camel route. You can set this to true which then logs a WARN and then ignore the problem, meaning that the route will never fire in the future."},"jobParameters":{"index":13,"kind":"parameter","displayName":"Job Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"job.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional options on the job."},"prefixJobNameWithEndpointId":{"index":14,"kind":"parameter","displayName":"Prefix Job Name With Endpoint Id","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the job name should be prefixed with endpoint id"},"triggerParameters":{"index":15,"kind":"parameter","displayName":"Trigger Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"trigger.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional options on the trigger. The parameter timeZone is supported if the cron option is present. Otherwise the parameters repeatInterval and repeatCount are supported. Note: When using repeatInterval values of 1000 or less, the first few events after starting the camel context may be fired more rapidly than expected."},"usingFixedCamelContextName":{"index":16,"kind":"parameter","displayName":"Using Fixed Camel Context Name","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If it is true, JobDataMap uses the CamelContext name directly to reference the CamelContext, if it is false, JobDataMap uses use the CamelContext management name which could be changed during the deploy time."},"autoStartScheduler":{"index":17,"kind":"parameter","displayName":"Auto Start Scheduler","group":"scheduler","label":"scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not the scheduler should be auto started."},"triggerStartDelay":{"index":18,"kind":"parameter","displayName":"Trigger Start Delay","group":"scheduler","label":"scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500","description":"In case of scheduler has already started, we want the trigger start slightly after current time to ensure endpoint is fully started before the job kicks in. Negative value shifts trigger start time in the past."}}} +{"component":{"kind":"component","name":"quartz","title":"Quartz","description":"Schedule sending of messages using the Quartz 2.x scheduler.","deprecated":false,"firstVersion":"2.12.0","label":"scheduling","javaType":"org.apache.camel.component.quartz.QuartzComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-quartz","version":"4.8.2","scheme":"quartz","extendsScheme":"","syntax":"quartz:groupName/triggerName","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"groupName":{"index":0,"kind":"path","displayName":"Group Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Camel","description":"The quartz group name to use. The combination of group name and trigger name should be unique."},"triggerName":{"index":1,"kind":"path","displayName":"Trigger Name","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The quartz trigger name to use. The combination of group name and trigger name should be unique."},"cron":{"index":2,"kind":"parameter","displayName":"Cron","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies a cron expression to define when to trigger."},"deleteJob":{"index":3,"kind":"parameter","displayName":"Delete Job","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If set to true, then the trigger automatically delete when route stop. Else if set to false, it will remain in scheduler. When set to false, it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true."},"durableJob":{"index":4,"kind":"parameter","displayName":"Durable Job","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not the job should remain stored after it is orphaned (no triggers point to it)."},"pauseJob":{"index":5,"kind":"parameter","displayName":"Pause Job","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set to true, then the trigger automatically pauses when route stop. Else if set to false, it will remain in scheduler. When set to false, it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true."},"recoverableJob":{"index":6,"kind":"parameter","displayName":"Recoverable Job","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Instructs the scheduler whether or not the job should be re-executed if a 'recovery' or 'fail-over' situation is encountered."},"stateful":{"index":7,"kind":"parameter","displayName":"Stateful","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Uses a Quartz PersistJobDataAfterExecution and DisallowConcurrentExecution instead of the default job."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"customCalendar":{"index":11,"kind":"parameter","displayName":"Custom Calendar","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.quartz.Calendar","deprecated":false,"autowired":false,"secret":false,"description":"Specifies a custom calendar to avoid specific range of date"},"ignoreExpiredNextFireTime":{"index":12,"kind":"parameter","displayName":"Ignore Expired Next Fire Time","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to ignore quartz cannot schedule a trigger because the trigger will never fire in the future. This can happen when using a cron trigger that are configured to only run in the past. By default, Quartz will fail to schedule the trigger and therefore fail to start the Camel route. You can set this to true which then logs a WARN and then ignore the problem, meaning that the route will never fire in the future."},"jobParameters":{"index":13,"kind":"parameter","displayName":"Job Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"job.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional options on the job."},"prefixJobNameWithEndpointId":{"index":14,"kind":"parameter","displayName":"Prefix Job Name With Endpoint Id","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the job name should be prefixed with endpoint id"},"triggerParameters":{"index":15,"kind":"parameter","displayName":"Trigger Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"trigger.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional options on the trigger. The parameter timeZone is supported if the cron option is present. Otherwise the parameters repeatInterval and repeatCount are supported. Note: When using repeatInterval values of 1000 or less, the first few events after starting the camel context may be fired more rapidly than expected."},"usingFixedCamelContextName":{"index":16,"kind":"parameter","displayName":"Using Fixed Camel Context Name","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If it is true, JobDataMap uses the CamelContext name directly to reference the CamelContext, if it is false, JobDataMap uses use the CamelContext management name which could be changed during the deploy time."},"autoStartScheduler":{"index":17,"kind":"parameter","displayName":"Auto Start Scheduler","group":"scheduler","label":"scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not the scheduler should be auto started."},"triggerStartDelay":{"index":18,"kind":"parameter","displayName":"Trigger Start Delay","group":"scheduler","label":"scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"500","description":"In case of scheduler has already started, we want the trigger start slightly after current time to ensure endpoint is fully started before the job kicks in. Negative value shifts trigger start time in the past."}}} , -{"component":{"kind":"component","name":"quickfix","title":"QuickFix","description":"Open a Financial Interchange (FIX) session using an embedded QuickFix/J engine.","deprecated":false,"firstVersion":"2.1.0","label":"messaging","javaType":"org.apache.camel.component.quickfixj.QuickfixjComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-quickfix","version":"4.8.1","scheme":"quickfix","extendsScheme":"","syntax":"quickfix:configurationName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"EventCategory":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.quickfixj.QuickfixjEventCategory","enum":["AppMessageReceived","AppMessageSent","AdminMessageReceived","AdminMessageSent","SessionCreated","SessionLogon","SessionLogoff"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event category.","constantName":"org.apache.camel.component.quickfixj.QuickfixjEndpoint#EVENT_CATEGORY_KEY"},"SessionID":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"quickfix.SessionID","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FIX message SessionID.","constantName":"org.apache.camel.component.quickfixj.QuickfixjEndpoint#SESSION_ID_KEY"},"MessageType":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FIX MsgType tag value.","constantName":"org.apache.camel.component.quickfixj.QuickfixjEndpoint#MESSAGE_TYPE_KEY"}},"properties":{"configurationName":{"index":0,"kind":"path","displayName":"Configuration Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the quickfix configuration file. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the configuration file using these protocols (classpath is default). ref will lookup the configuration file in the registry. bean will call a method on a bean to be used as the configuration. For bean you can specify the method name after dot, eg bean:myBean.myMethod"},"lazyCreateEngine":{"index":1,"kind":"parameter","displayName":"Lazy Create Engine","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option allows creating QuickFIX/J engine on demand. Value true means the engine is started when first message is send or there's consumer configured in route definition. When false value is used, the engine is started at the endpoint creation. When this parameter is missing, the value of component's property lazyCreateEngines is being used."},"sessionID":{"index":2,"kind":"parameter","displayName":"Session ID","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The optional sessionID identifies a specific FIX session. The format of the sessionID is: (BeginString):(SenderCompID)/(SenderSubID)/(SenderLocationID)-(TargetCompID)/(TargetSubID)/(TargetLocationID)"},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":6,"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."}}} +{"component":{"kind":"component","name":"quickfix","title":"QuickFix","description":"Open a Financial Interchange (FIX) session using an embedded QuickFix/J engine.","deprecated":false,"firstVersion":"2.1.0","label":"messaging","javaType":"org.apache.camel.component.quickfixj.QuickfixjComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-quickfix","version":"4.8.2","scheme":"quickfix","extendsScheme":"","syntax":"quickfix:configurationName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"EventCategory":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.quickfixj.QuickfixjEventCategory","enum":["AppMessageReceived","AppMessageSent","AdminMessageReceived","AdminMessageSent","SessionCreated","SessionLogon","SessionLogoff"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event category.","constantName":"org.apache.camel.component.quickfixj.QuickfixjEndpoint#EVENT_CATEGORY_KEY"},"SessionID":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"quickfix.SessionID","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FIX message SessionID.","constantName":"org.apache.camel.component.quickfixj.QuickfixjEndpoint#SESSION_ID_KEY"},"MessageType":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FIX MsgType tag value.","constantName":"org.apache.camel.component.quickfixj.QuickfixjEndpoint#MESSAGE_TYPE_KEY"}},"properties":{"configurationName":{"index":0,"kind":"path","displayName":"Configuration Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the quickfix configuration file. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the configuration file using these protocols (classpath is default). ref will lookup the configuration file in the registry. bean will call a method on a bean to be used as the configuration. For bean you can specify the method name after dot, eg bean:myBean.myMethod"},"lazyCreateEngine":{"index":1,"kind":"parameter","displayName":"Lazy Create Engine","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option allows creating QuickFIX/J engine on demand. Value true means the engine is started when first message is send or there's consumer configured in route definition. When false value is used, the engine is started at the endpoint creation. When this parameter is missing, the value of component's property lazyCreateEngines is being used."},"sessionID":{"index":2,"kind":"parameter","displayName":"Session ID","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The optional sessionID identifies a specific FIX session. The format of the sessionID is: (BeginString):(SenderCompID)/(SenderSubID)/(SenderLocationID)-(TargetCompID)/(TargetSubID)/(TargetLocationID)"},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":6,"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."}}} , -{"component":{"kind":"component","name":"reactive-streams","title":"Reactive Streams","description":"Exchange messages with reactive stream processing libraries compatible with the reactive streams standard.","deprecated":false,"firstVersion":"2.19.0","label":"messaging","javaType":"org.apache.camel.component.reactive.streams.ReactiveStreamsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-reactive-streams","version":"4.8.1","scheme":"reactive-streams","extendsScheme":"","syntax":"reactive-streams:stream","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"headers":{"CamelReactiveStreamsEventType":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Every exchange consumed by Camel has this header set to indicate if the exchange contains an item (value=onNext), an error (value=onError) or a completion event (value=onComplete). Errors and completion notification are not forwarded by default.","constantName":"org.apache.camel.component.reactive.streams.ReactiveStreamsConstants#REACTIVE_STREAMS_EVENT_TYPE"},"CamelReactiveStreamsCallback":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.reactive.streams.api.DispatchCallback","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The callback.","constantName":"org.apache.camel.component.reactive.streams.ReactiveStreamsConstants#REACTIVE_STREAMS_CALLBACK"}},"properties":{"stream":{"index":0,"kind":"path","displayName":"Stream","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Name of the stream channel used by the endpoint to exchange messages."},"concurrentConsumers":{"index":1,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Number of threads used to process exchanges in the Camel route."},"exchangesRefillLowWatermark":{"index":2,"kind":"parameter","displayName":"Exchanges Refill Low Watermark","group":"consumer","label":"consumer","required":false,"type":"number","javaType":"double","deprecated":false,"autowired":false,"secret":false,"defaultValue":0.25,"description":"Set the low watermark of requested exchanges to the active subscription as percentage of the maxInflightExchanges. When the number of pending items from the upstream source is lower than the watermark, new items can be requested to the subscription. If set to 0, the subscriber will request items in batches of maxInflightExchanges, only after all items of the previous batch have been processed. If set to 1, the subscriber can request a new item each time an exchange is processed (chatty). Any intermediate value can be used."},"forwardOnComplete":{"index":3,"kind":"parameter","displayName":"Forward On Complete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines if onComplete events should be pushed to the Camel route."},"forwardOnError":{"index":4,"kind":"parameter","displayName":"Forward On Error","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body."},"maxInflightExchanges":{"index":5,"kind":"parameter","displayName":"Max Inflight Exchanges","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"128","description":"Maximum number of exchanges concurrently being processed by Camel. This parameter controls backpressure on the stream. Setting a non-positive value will disable backpressure."},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"backpressureStrategy":{"index":9,"kind":"parameter","displayName":"Backpressure Strategy","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.reactive.streams.ReactiveStreamsBackpressureStrategy","enum":["BUFFER","OLDEST","LATEST"],"deprecated":false,"autowired":false,"secret":false,"description":"The backpressure strategy to use when pushing events to a slow subscriber."},"lazyStartProducer":{"index":10,"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."}}} +{"component":{"kind":"component","name":"reactive-streams","title":"Reactive Streams","description":"Exchange messages with reactive stream processing libraries compatible with the reactive streams standard.","deprecated":false,"firstVersion":"2.19.0","label":"messaging","javaType":"org.apache.camel.component.reactive.streams.ReactiveStreamsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-reactive-streams","version":"4.8.2","scheme":"reactive-streams","extendsScheme":"","syntax":"reactive-streams:stream","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"headers":{"CamelReactiveStreamsEventType":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Every exchange consumed by Camel has this header set to indicate if the exchange contains an item (value=onNext), an error (value=onError) or a completion event (value=onComplete). Errors and completion notification are not forwarded by default.","constantName":"org.apache.camel.component.reactive.streams.ReactiveStreamsConstants#REACTIVE_STREAMS_EVENT_TYPE"},"CamelReactiveStreamsCallback":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.reactive.streams.api.DispatchCallback","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The callback.","constantName":"org.apache.camel.component.reactive.streams.ReactiveStreamsConstants#REACTIVE_STREAMS_CALLBACK"}},"properties":{"stream":{"index":0,"kind":"path","displayName":"Stream","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Name of the stream channel used by the endpoint to exchange messages."},"concurrentConsumers":{"index":1,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Number of threads used to process exchanges in the Camel route."},"exchangesRefillLowWatermark":{"index":2,"kind":"parameter","displayName":"Exchanges Refill Low Watermark","group":"consumer","label":"consumer","required":false,"type":"number","javaType":"double","deprecated":false,"autowired":false,"secret":false,"defaultValue":0.25,"description":"Set the low watermark of requested exchanges to the active subscription as percentage of the maxInflightExchanges. When the number of pending items from the upstream source is lower than the watermark, new items can be requested to the subscription. If set to 0, the subscriber will request items in batches of maxInflightExchanges, only after all items of the previous batch have been processed. If set to 1, the subscriber can request a new item each time an exchange is processed (chatty). Any intermediate value can be used."},"forwardOnComplete":{"index":3,"kind":"parameter","displayName":"Forward On Complete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines if onComplete events should be pushed to the Camel route."},"forwardOnError":{"index":4,"kind":"parameter","displayName":"Forward On Error","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body."},"maxInflightExchanges":{"index":5,"kind":"parameter","displayName":"Max Inflight Exchanges","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"128","description":"Maximum number of exchanges concurrently being processed by Camel. This parameter controls backpressure on the stream. Setting a non-positive value will disable backpressure."},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"backpressureStrategy":{"index":9,"kind":"parameter","displayName":"Backpressure Strategy","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.reactive.streams.ReactiveStreamsBackpressureStrategy","enum":["BUFFER","OLDEST","LATEST"],"deprecated":false,"autowired":false,"secret":false,"description":"The backpressure strategy to use when pushing events to a slow subscriber."},"lazyStartProducer":{"index":10,"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."}}} , -{"component":{"kind":"component","name":"ref","title":"Ref","description":"Route messages to an endpoint looked up dynamically by name in the Camel Registry.","deprecated":false,"firstVersion":"1.2.0","label":"core","javaType":"org.apache.camel.component.ref.RefComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ref","version":"4.8.1","scheme":"ref","extendsScheme":"","syntax":"ref:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of endpoint to lookup in the registry."},"bridgeErrorHandler":{"index":1,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":2,"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":{"index":3,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":4,"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."}}} +{"component":{"kind":"component","name":"ref","title":"Ref","description":"Route messages to an endpoint looked up dynamically by name in the Camel Registry.","deprecated":false,"firstVersion":"1.2.0","label":"core","javaType":"org.apache.camel.component.ref.RefComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ref","version":"4.8.2","scheme":"ref","extendsScheme":"","syntax":"ref:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of endpoint to lookup in the registry."},"bridgeErrorHandler":{"index":1,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":2,"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":{"index":3,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":4,"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."}}} , -{"component":{"kind":"component","name":"rest","title":"REST","description":"Expose REST services or call external REST services.","deprecated":false,"firstVersion":"2.14.0","label":"core,rest","javaType":"org.apache.camel.component.rest.RestComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-rest","version":"4.8.1","scheme":"rest","extendsScheme":"","syntax":"rest:method:path:uriTemplate","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"CamelRestHttpQuery":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query parameters for the rest call to be used","constantName":"org.apache.camel.component.rest.RestConstants#REST_HTTP_QUERY"},"CamelRestHttpUri":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http uri for the rest call to be used","constantName":"org.apache.camel.component.rest.RestConstants#REST_HTTP_URI"},"CamelHttpMethod":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The method should be in upper case","constantName":"org.apache.camel.component.rest.RestConstants#HTTP_METHOD"},"Content-Type":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The media type such as: 'text/xml', or 'application/json' this REST service returns.","constantName":"org.apache.camel.component.rest.RestConstants#CONTENT_TYPE"},"Accept":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The media type such as: 'text/xml', or 'application/json' this REST service accepts.","constantName":"org.apache.camel.component.rest.RestConstants#ACCEPT"},"CamelHttpResponseCode":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http response code","constantName":"org.apache.camel.component.rest.RestConstants#HTTP_RESPONSE_CODE"}},"properties":{"method":{"index":0,"kind":"path","displayName":"Method","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","enum":["get","post","put","delete","patch","head","trace","connect","options"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"HTTP method to use."},"path":{"index":1,"kind":"path","displayName":"Path","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The base path, can use * as path suffix to support wildcard HTTP route matching."},"uriTemplate":{"index":2,"kind":"path","displayName":"Uri Template","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The uri template"},"consumes":{"index":3,"kind":"parameter","displayName":"Consumes","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Media type such as: 'text/xml', or 'application/json' this REST service accepts. By default we accept all kinds of types."},"inType":{"index":4,"kind":"parameter","displayName":"In Type","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To declare the incoming POJO binding type as a FQN class name"},"outType":{"index":5,"kind":"parameter","displayName":"Out Type","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To declare the outgoing POJO binding type as a FQN class name"},"produces":{"index":6,"kind":"parameter","displayName":"Produces","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Media type such as: 'text/xml', or 'application/json' this REST service returns."},"routeId":{"index":7,"kind":"parameter","displayName":"Route Id","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Name of the route this REST services creates"},"consumerComponentName":{"index":8,"kind":"parameter","displayName":"Consumer Component Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Camel Rest component to use for the consumer REST transport, such as jetty, servlet, undertow. If no component has been explicitly configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found, then that is being used."},"description":{"index":9,"kind":"parameter","displayName":"Description","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Human description to document this REST service"},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"apiDoc":{"index":13,"kind":"parameter","displayName":"Api Doc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The openapi api doc resource to use. The resource is loaded from classpath by default and must be in JSON format."},"bindingMode":{"index":14,"kind":"parameter","displayName":"Binding Mode","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.spi.RestConfiguration.RestBindingMode","enum":["auto","off","json","xml","json_xml"],"deprecated":false,"autowired":false,"secret":false,"description":"Configures the binding mode for the producer. If set to anything other than 'off' the producer will try to convert the body of the incoming message from inType to the json or xml, and the response from json or xml to outType."},"host":{"index":15,"kind":"parameter","displayName":"Host","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Host and port of HTTP service to use (override host in openapi schema)"},"producerComponentName":{"index":16,"kind":"parameter","displayName":"Producer Component Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Camel Rest component to use for the producer REST transport, such as http, undertow. If no component has been explicitly configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestProducerFactory is registered in the registry. If either one is found, then that is being used."},"queryParameters":{"index":17,"kind":"parameter","displayName":"Query Parameters","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Query parameters for the HTTP service to call. The query parameters can contain multiple parameters separated by ampersand such such as foo=123&bar=456."},"lazyStartProducer":{"index":18,"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."}}} +{"component":{"kind":"component","name":"rest","title":"REST","description":"Expose REST services or call external REST services.","deprecated":false,"firstVersion":"2.14.0","label":"core,rest","javaType":"org.apache.camel.component.rest.RestComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-rest","version":"4.8.2","scheme":"rest","extendsScheme":"","syntax":"rest:method:path:uriTemplate","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"CamelRestHttpQuery":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query parameters for the rest call to be used","constantName":"org.apache.camel.component.rest.RestConstants#REST_HTTP_QUERY"},"CamelRestHttpUri":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http uri for the rest call to be used","constantName":"org.apache.camel.component.rest.RestConstants#REST_HTTP_URI"},"CamelHttpMethod":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The method should be in upper case","constantName":"org.apache.camel.component.rest.RestConstants#HTTP_METHOD"},"Content-Type":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The media type such as: 'text/xml', or 'application/json' this REST service returns.","constantName":"org.apache.camel.component.rest.RestConstants#CONTENT_TYPE"},"Accept":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The media type such as: 'text/xml', or 'application/json' this REST service accepts.","constantName":"org.apache.camel.component.rest.RestConstants#ACCEPT"},"CamelHttpResponseCode":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http response code","constantName":"org.apache.camel.component.rest.RestConstants#HTTP_RESPONSE_CODE"}},"properties":{"method":{"index":0,"kind":"path","displayName":"Method","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","enum":["get","post","put","delete","patch","head","trace","connect","options"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"HTTP method to use."},"path":{"index":1,"kind":"path","displayName":"Path","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The base path, can use * as path suffix to support wildcard HTTP route matching."},"uriTemplate":{"index":2,"kind":"path","displayName":"Uri Template","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The uri template"},"consumes":{"index":3,"kind":"parameter","displayName":"Consumes","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Media type such as: 'text/xml', or 'application/json' this REST service accepts. By default we accept all kinds of types."},"inType":{"index":4,"kind":"parameter","displayName":"In Type","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To declare the incoming POJO binding type as a FQN class name"},"outType":{"index":5,"kind":"parameter","displayName":"Out Type","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To declare the outgoing POJO binding type as a FQN class name"},"produces":{"index":6,"kind":"parameter","displayName":"Produces","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Media type such as: 'text/xml', or 'application/json' this REST service returns."},"routeId":{"index":7,"kind":"parameter","displayName":"Route Id","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Name of the route this REST services creates"},"consumerComponentName":{"index":8,"kind":"parameter","displayName":"Consumer Component Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Camel Rest component to use for the consumer REST transport, such as jetty, servlet, undertow. If no component has been explicitly configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found, then that is being used."},"description":{"index":9,"kind":"parameter","displayName":"Description","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Human description to document this REST service"},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"apiDoc":{"index":13,"kind":"parameter","displayName":"Api Doc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The openapi api doc resource to use. The resource is loaded from classpath by default and must be in JSON format."},"bindingMode":{"index":14,"kind":"parameter","displayName":"Binding Mode","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.spi.RestConfiguration.RestBindingMode","enum":["auto","off","json","xml","json_xml"],"deprecated":false,"autowired":false,"secret":false,"description":"Configures the binding mode for the producer. If set to anything other than 'off' the producer will try to convert the body of the incoming message from inType to the json or xml, and the response from json or xml to outType."},"host":{"index":15,"kind":"parameter","displayName":"Host","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Host and port of HTTP service to use (override host in openapi schema)"},"producerComponentName":{"index":16,"kind":"parameter","displayName":"Producer Component Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Camel Rest component to use for the producer REST transport, such as http, undertow. If no component has been explicitly configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestProducerFactory is registered in the registry. If either one is found, then that is being used."},"queryParameters":{"index":17,"kind":"parameter","displayName":"Query Parameters","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Query parameters for the HTTP service to call. The query parameters can contain multiple parameters separated by ampersand such such as foo=123&bar=456."},"lazyStartProducer":{"index":18,"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."}}} , -{"component":{"kind":"component","name":"rest-api","title":"REST API","description":"Expose OpenAPI Specification of the REST services defined using Camel REST DSL.","deprecated":false,"firstVersion":"2.16.0","label":"core,rest","javaType":"org.apache.camel.component.rest.RestApiComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-rest","version":"4.8.1","scheme":"rest-api","extendsScheme":"","syntax":"rest-api:path","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":false},"properties":{"path":{"index":0,"kind":"path","displayName":"Path","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The base path"},"apiComponentName":{"index":1,"kind":"parameter","displayName":"Api Component Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Camel Rest API component to use for generating the API of the REST services, such as openapi."},"consumerComponentName":{"index":2,"kind":"parameter","displayName":"Consumer Component Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Camel Rest component to use for the consumer REST transport, such as jetty, servlet, undertow. If no component has been explicitly configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found, then that is being used."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} +{"component":{"kind":"component","name":"rest-api","title":"REST API","description":"Expose OpenAPI Specification of the REST services defined using Camel REST DSL.","deprecated":false,"firstVersion":"2.16.0","label":"core,rest","javaType":"org.apache.camel.component.rest.RestApiComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-rest","version":"4.8.2","scheme":"rest-api","extendsScheme":"","syntax":"rest-api:path","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":false},"properties":{"path":{"index":0,"kind":"path","displayName":"Path","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The base path"},"apiComponentName":{"index":1,"kind":"parameter","displayName":"Api Component Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Camel Rest API component to use for generating the API of the REST services, such as openapi."},"consumerComponentName":{"index":2,"kind":"parameter","displayName":"Consumer Component Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Camel Rest component to use for the consumer REST transport, such as jetty, servlet, undertow. If no component has been explicitly configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found, then that is being used."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} , -{"component":{"kind":"component","name":"rest-openapi","title":"REST OpenApi","description":"To call REST services using OpenAPI specification as contract.","deprecated":false,"firstVersion":"3.1.0","label":"rest,api","javaType":"org.apache.camel.component.rest.openapi.RestOpenApiComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-rest-openapi","version":"4.8.1","scheme":"rest-openapi","extendsScheme":"","syntax":"rest-openapi:specificationUri#operationId","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"specificationUri":{"index":0,"kind":"path","displayName":"Specification Uri","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"openapi.json","description":"Path to the OpenApi specification file. The scheme, host base path are taken from this specification, but these can be overridden with properties on the component or endpoint level. If not given the component tries to load openapi.json resource from the classpath. Note that the host defined on the component and endpoint of this Component should contain the scheme, hostname and optionally the port in the URI syntax (i.e. http://api.example.com:8080). Overrides component configuration. The OpenApi specification can be loaded from different sources by prefixing with file: classpath: http: https:. Support for https is limited to using the JDK installed UrlHandler, and as such it can be cumbersome to setup TLS/SSL certificates for https (such as setting a number of javax.net.ssl JVM system properties). How to do that consult the JDK documentation for UrlHandler. Default value notice: By default loads openapi.json file"},"operationId":{"index":1,"kind":"path","displayName":"Operation Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"ID of the operation from the OpenApi specification. This is required when using producer"},"apiContextPath":{"index":2,"kind":"parameter","displayName":"Api Context Path","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the context-path to use for servicing the OpenAPI specification"},"clientRequestValidation":{"index":3,"kind":"parameter","displayName":"Client Request Validation","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to enable validation of the client request to check if the incoming request is valid according to the OpenAPI specification"},"consumes":{"index":4,"kind":"parameter","displayName":"Consumes","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"What payload type this component capable of consuming. Could be one type, like application/json or multiple types as application/json, application/xml; q=0.5 according to the RFC7231. This equates or multiple types as application/json, application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the OpenApi specification and. in the component configuration"},"missingOperation":{"index":5,"kind":"parameter","displayName":"Missing Operation","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["fail","ignore","mock"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","description":"Whether the consumer should fail,ignore or return a mock response for OpenAPI operations that are not mapped to a corresponding route."},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"consumerComponentName":{"index":7,"kind":"parameter","displayName":"Consumer Component Name","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Name of the Camel component that will service the requests. The component must be present in Camel registry and it must implement RestOpenApiConsumerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestOpenApiConsumerFactory SPI. Overrides component configuration."},"exceptionHandler":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"mockIncludePattern":{"index":10,"kind":"parameter","displayName":"Mock Include Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"classpath:camel-mock/**","description":"Used for inclusive filtering of mock data from directories. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma."},"restOpenapiProcessorStrategy":{"index":11,"kind":"parameter","displayName":"Rest Openapi Processor Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.rest.openapi.RestOpenapiProcessorStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom strategy for how to process Rest DSL requests"},"basePath":{"index":12,"kind":"parameter","displayName":"Base Path","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"API basePath, for example /v3. Default is unset, if set overrides the value present in OpenApi specification and in the component configuration."},"host":{"index":13,"kind":"parameter","displayName":"Host","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint, component or in the corresponding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first, rest-openapi next, and global configuration last. If set overrides any value found in the OpenApi specification, RestConfiguration. Overrides all other configuration."},"produces":{"index":14,"kind":"parameter","displayName":"Produces","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the OpenApi specification. Overrides all other configuration."},"requestValidationEnabled":{"index":15,"kind":"parameter","displayName":"Request Validation Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enable validation of requests against the configured OpenAPI specification"},"componentName":{"index":16,"kind":"parameter","displayName":"Component Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Name of the Camel component that will perform the requests. The component must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Overrides component configuration."},"lazyStartProducer":{"index":17,"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."}}} +{"component":{"kind":"component","name":"rest-openapi","title":"REST OpenApi","description":"To call REST services using OpenAPI specification as contract.","deprecated":false,"firstVersion":"3.1.0","label":"rest,api","javaType":"org.apache.camel.component.rest.openapi.RestOpenApiComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-rest-openapi","version":"4.8.2","scheme":"rest-openapi","extendsScheme":"","syntax":"rest-openapi:specificationUri#operationId","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"specificationUri":{"index":0,"kind":"path","displayName":"Specification Uri","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"openapi.json","description":"Path to the OpenApi specification file. The scheme, host base path are taken from this specification, but these can be overridden with properties on the component or endpoint level. If not given the component tries to load openapi.json resource from the classpath. Note that the host defined on the component and endpoint of this Component should contain the scheme, hostname and optionally the port in the URI syntax (i.e. http://api.example.com:8080). Overrides component configuration. The OpenApi specification can be loaded from different sources by prefixing with file: classpath: http: https:. Support for https is limited to using the JDK installed UrlHandler, and as such it can be cumbersome to setup TLS/SSL certificates for https (such as setting a number of javax.net.ssl JVM system properties). How to do that consult the JDK documentation for UrlHandler. Default value notice: By default loads openapi.json file"},"operationId":{"index":1,"kind":"path","displayName":"Operation Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"ID of the operation from the OpenApi specification. This is required when using producer"},"apiContextPath":{"index":2,"kind":"parameter","displayName":"Api Context Path","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the context-path to use for servicing the OpenAPI specification"},"clientRequestValidation":{"index":3,"kind":"parameter","displayName":"Client Request Validation","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to enable validation of the client request to check if the incoming request is valid according to the OpenAPI specification"},"consumes":{"index":4,"kind":"parameter","displayName":"Consumes","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"What payload type this component capable of consuming. Could be one type, like application/json or multiple types as application/json, application/xml; q=0.5 according to the RFC7231. This equates or multiple types as application/json, application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the OpenApi specification and. in the component configuration"},"missingOperation":{"index":5,"kind":"parameter","displayName":"Missing Operation","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["fail","ignore","mock"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"fail","description":"Whether the consumer should fail,ignore or return a mock response for OpenAPI operations that are not mapped to a corresponding route."},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"consumerComponentName":{"index":7,"kind":"parameter","displayName":"Consumer Component Name","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Name of the Camel component that will service the requests. The component must be present in Camel registry and it must implement RestOpenApiConsumerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestOpenApiConsumerFactory SPI. Overrides component configuration."},"exceptionHandler":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"mockIncludePattern":{"index":10,"kind":"parameter","displayName":"Mock Include Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"classpath:camel-mock/**","description":"Used for inclusive filtering of mock data from directories. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma."},"restOpenapiProcessorStrategy":{"index":11,"kind":"parameter","displayName":"Rest Openapi Processor Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.rest.openapi.RestOpenapiProcessorStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom strategy for how to process Rest DSL requests"},"basePath":{"index":12,"kind":"parameter","displayName":"Base Path","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"API basePath, for example /v3. Default is unset, if set overrides the value present in OpenApi specification and in the component configuration."},"host":{"index":13,"kind":"parameter","displayName":"Host","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint, component or in the corresponding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first, rest-openapi next, and global configuration last. If set overrides any value found in the OpenApi specification, RestConfiguration. Overrides all other configuration."},"produces":{"index":14,"kind":"parameter","displayName":"Produces","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the OpenApi specification. Overrides all other configuration."},"requestValidationEnabled":{"index":15,"kind":"parameter","displayName":"Request Validation Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enable validation of requests against the configured OpenAPI specification"},"componentName":{"index":16,"kind":"parameter","displayName":"Component Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Name of the Camel component that will perform the requests. The component must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Overrides component configuration."},"lazyStartProducer":{"index":17,"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."}}} , -{"component":{"kind":"component","name":"robotframework","title":"Robot Framework","description":"Pass camel exchanges to acceptance test written in Robot DSL.","deprecated":false,"firstVersion":"3.0.0","label":"testing","javaType":"org.apache.camel.component.robotframework.RobotFrameworkComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-robotframework","version":"4.8.1","scheme":"robotframework","extendsScheme":"","syntax":"robotframework:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"headers":{"CamelRobotVariables":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The robot variables.","constantName":"org.apache.camel.component.robotframework.RobotFrameworkCamelConstants#CAMEL_ROBOT_VARIABLES"},"CamelRobotReturnCode":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The return code.","constantName":"org.apache.camel.component.robotframework.RobotFrameworkCamelConstants#CAMEL_ROBOT_RETURN_CODE"},"CamelRobotResourceUri":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The new resource URI.","constantName":"org.apache.camel.component.robotframework.RobotFrameworkCamelConstants#CAMEL_ROBOT_RESOURCE_URI"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"argumentFiles":{"index":3,"kind":"parameter","displayName":"Argument Files","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"A text String to read more arguments from."},"combinedTagStats":{"index":4,"kind":"parameter","displayName":"Combined Tag Stats","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Creates combined statistics based on tags. Use the format tags:title List"},"contentCache":{"index":5,"kind":"parameter","displayName":"Content Cache","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"criticalTags":{"index":6,"kind":"parameter","displayName":"Critical Tags","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Tests that have the given tags are considered critical. List"},"debugFile":{"index":7,"kind":"parameter","displayName":"Debug File","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"A debug String that is written during execution."},"document":{"index":8,"kind":"parameter","displayName":"Document","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the documentation of the top-level tests suites."},"dryrun":{"index":9,"kind":"parameter","displayName":"Dryrun","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets dryrun mode on use. In the dry run mode tests are run without executing keywords originating from test libraries. Useful for validating test data syntax."},"excludes":{"index":10,"kind":"parameter","displayName":"Excludes","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Selects the tests cases by tags. List"},"exitOnFailure":{"index":11,"kind":"parameter","displayName":"Exit On Failure","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets robot to stop execution immediately if a critical test fails."},"includes":{"index":12,"kind":"parameter","displayName":"Includes","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Selects the tests cases by tags. List"},"listener":{"index":13,"kind":"parameter","displayName":"Listener","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets a single listener for monitoring tests execution"},"listeners":{"index":14,"kind":"parameter","displayName":"Listeners","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets multiple listeners for monitoring tests execution. Use the format ListenerWithArgs:arg1:arg2 or simply ListenerWithoutArgs List"},"log":{"index":15,"kind":"parameter","displayName":"Log","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the path to the generated log String."},"logLevel":{"index":16,"kind":"parameter","displayName":"Log Level","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the threshold level for logging."},"logTitle":{"index":17,"kind":"parameter","displayName":"Log Title","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets a title for the generated tests log."},"metadata":{"index":18,"kind":"parameter","displayName":"Metadata","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets free metadata for the top level tests suites. comma seperated list of string resulting as List"},"monitorColors":{"index":19,"kind":"parameter","displayName":"Monitor Colors","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Using ANSI colors in console. Normally colors work in unixes but not in Windows. Default is 'on'. 'on' - use colors in unixes but not in Windows 'off' - never use colors 'force' - always use colors (also in Windows)"},"monitorWidth":{"index":20,"kind":"parameter","displayName":"Monitor Width","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"78","configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Width of the monitor output. Default is 78."},"name":{"index":21,"kind":"parameter","displayName":"Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the name of the top-level tests suites."},"nonCriticalTags":{"index":22,"kind":"parameter","displayName":"Non Critical Tags","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Tests that have the given tags are not critical. List"},"noStatusReturnCode":{"index":23,"kind":"parameter","displayName":"No Status Return Code","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"If true, sets the return code to zero regardless of failures in test cases. Error codes are returned normally."},"output":{"index":24,"kind":"parameter","displayName":"Output","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the path to the generated output String."},"outputDirectory":{"index":25,"kind":"parameter","displayName":"Output Directory","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Configures where generated reports are to be placed."},"randomize":{"index":26,"kind":"parameter","displayName":"Randomize","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the test execution order to be randomized. Valid values are all, suite, and test"},"report":{"index":27,"kind":"parameter","displayName":"Report","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the path to the generated report String."},"reportBackground":{"index":28,"kind":"parameter","displayName":"Report Background","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets background colors for the generated report and summary."},"reportTitle":{"index":29,"kind":"parameter","displayName":"Report Title","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets a title for the generated tests report."},"runEmptySuite":{"index":30,"kind":"parameter","displayName":"Run Empty Suite","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Executes tests also if the top level test suite is empty. Useful e.g. with --include/--exclude when it is not an error that no test matches the condition."},"runFailed":{"index":31,"kind":"parameter","displayName":"Run Failed","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Re-run failed tests, based on output.xml String."},"runMode":{"index":32,"kind":"parameter","displayName":"Run Mode","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the execution mode for this tests run. Note that this setting has been deprecated in Robot Framework 2.8. Use separate dryryn, skipTeardownOnExit, exitOnFailure, and randomize settings instead."},"skipTeardownOnExit":{"index":33,"kind":"parameter","displayName":"Skip Teardown On Exit","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets whether the teardowns are skipped if the test execution is prematurely stopped."},"splitOutputs":{"index":34,"kind":"parameter","displayName":"Split Outputs","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Splits output and log files."},"suites":{"index":35,"kind":"parameter","displayName":"Suites","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Selects the tests suites by name. List"},"suiteStatLevel":{"index":36,"kind":"parameter","displayName":"Suite Stat Level","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Defines how many levels to show in the Statistics by Suite table in outputs."},"summaryTitle":{"index":37,"kind":"parameter","displayName":"Summary Title","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets a title for the generated summary report."},"tagDocs":{"index":38,"kind":"parameter","displayName":"Tag Docs","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Adds documentation to the specified tags. List"},"tags":{"index":39,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the tags(s) to all executed tests cases. List"},"tagStatExcludes":{"index":40,"kind":"parameter","displayName":"Tag Stat Excludes","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Excludes these tags from the Statistics by Tag and Test Details by Tag tables in outputs. List"},"tagStatIncludes":{"index":41,"kind":"parameter","displayName":"Tag Stat Includes","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Includes only these tags in the Statistics by Tag and Test Details by Tag tables in outputs. List"},"tagStatLinks":{"index":42,"kind":"parameter","displayName":"Tag Stat Links","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Adds external links to the Statistics by Tag table in outputs. Use the format pattern:link:title List"},"tests":{"index":43,"kind":"parameter","displayName":"Tests","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Selects the tests cases by name. List"},"timestampOutputs":{"index":44,"kind":"parameter","displayName":"Timestamp Outputs","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Adds a timestamp to all output files."},"variableFiles":{"index":45,"kind":"parameter","displayName":"Variable Files","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets variables using variables files. Use the format path:args List"},"variables":{"index":46,"kind":"parameter","displayName":"Variables","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets individual variables. Use the format name:value List"},"warnOnSkippedFiles":{"index":47,"kind":"parameter","displayName":"Warn On Skipped Files","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Show a warning when an invalid String is skipped."},"xunitFile":{"index":48,"kind":"parameter","displayName":"Xunit File","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the path to the generated XUnit compatible result String, relative to outputDirectory. The String is in xml format. By default, the String name is derived from the testCasesDirectory parameter, replacing blanks in the directory name by underscores."},"sendEmptyMessageWhenIdle":{"index":49,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":50,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":51,"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":{"index":52,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":53,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":54,"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."},"backoffErrorThreshold":{"index":55,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":56,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":57,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":58,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":59,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":60,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":61,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":62,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":63,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":64,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":65,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":66,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":67,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":68,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} +{"component":{"kind":"component","name":"robotframework","title":"Robot Framework","description":"Pass camel exchanges to acceptance test written in Robot DSL.","deprecated":false,"firstVersion":"3.0.0","label":"testing","javaType":"org.apache.camel.component.robotframework.RobotFrameworkComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-robotframework","version":"4.8.2","scheme":"robotframework","extendsScheme":"","syntax":"robotframework:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"headers":{"CamelRobotVariables":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The robot variables.","constantName":"org.apache.camel.component.robotframework.RobotFrameworkCamelConstants#CAMEL_ROBOT_VARIABLES"},"CamelRobotReturnCode":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The return code.","constantName":"org.apache.camel.component.robotframework.RobotFrameworkCamelConstants#CAMEL_ROBOT_RETURN_CODE"},"CamelRobotResourceUri":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The new resource URI.","constantName":"org.apache.camel.component.robotframework.RobotFrameworkCamelConstants#CAMEL_ROBOT_RESOURCE_URI"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"argumentFiles":{"index":3,"kind":"parameter","displayName":"Argument Files","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"A text String to read more arguments from."},"combinedTagStats":{"index":4,"kind":"parameter","displayName":"Combined Tag Stats","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Creates combined statistics based on tags. Use the format tags:title List"},"contentCache":{"index":5,"kind":"parameter","displayName":"Content Cache","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"criticalTags":{"index":6,"kind":"parameter","displayName":"Critical Tags","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Tests that have the given tags are considered critical. List"},"debugFile":{"index":7,"kind":"parameter","displayName":"Debug File","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"A debug String that is written during execution."},"document":{"index":8,"kind":"parameter","displayName":"Document","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the documentation of the top-level tests suites."},"dryrun":{"index":9,"kind":"parameter","displayName":"Dryrun","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets dryrun mode on use. In the dry run mode tests are run without executing keywords originating from test libraries. Useful for validating test data syntax."},"excludes":{"index":10,"kind":"parameter","displayName":"Excludes","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Selects the tests cases by tags. List"},"exitOnFailure":{"index":11,"kind":"parameter","displayName":"Exit On Failure","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets robot to stop execution immediately if a critical test fails."},"includes":{"index":12,"kind":"parameter","displayName":"Includes","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Selects the tests cases by tags. List"},"listener":{"index":13,"kind":"parameter","displayName":"Listener","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets a single listener for monitoring tests execution"},"listeners":{"index":14,"kind":"parameter","displayName":"Listeners","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets multiple listeners for monitoring tests execution. Use the format ListenerWithArgs:arg1:arg2 or simply ListenerWithoutArgs List"},"log":{"index":15,"kind":"parameter","displayName":"Log","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the path to the generated log String."},"logLevel":{"index":16,"kind":"parameter","displayName":"Log Level","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the threshold level for logging."},"logTitle":{"index":17,"kind":"parameter","displayName":"Log Title","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets a title for the generated tests log."},"metadata":{"index":18,"kind":"parameter","displayName":"Metadata","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets free metadata for the top level tests suites. comma seperated list of string resulting as List"},"monitorColors":{"index":19,"kind":"parameter","displayName":"Monitor Colors","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Using ANSI colors in console. Normally colors work in unixes but not in Windows. Default is 'on'. 'on' - use colors in unixes but not in Windows 'off' - never use colors 'force' - always use colors (also in Windows)"},"monitorWidth":{"index":20,"kind":"parameter","displayName":"Monitor Width","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"78","configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Width of the monitor output. Default is 78."},"name":{"index":21,"kind":"parameter","displayName":"Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the name of the top-level tests suites."},"nonCriticalTags":{"index":22,"kind":"parameter","displayName":"Non Critical Tags","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Tests that have the given tags are not critical. List"},"noStatusReturnCode":{"index":23,"kind":"parameter","displayName":"No Status Return Code","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"If true, sets the return code to zero regardless of failures in test cases. Error codes are returned normally."},"output":{"index":24,"kind":"parameter","displayName":"Output","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the path to the generated output String."},"outputDirectory":{"index":25,"kind":"parameter","displayName":"Output Directory","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Configures where generated reports are to be placed."},"randomize":{"index":26,"kind":"parameter","displayName":"Randomize","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the test execution order to be randomized. Valid values are all, suite, and test"},"report":{"index":27,"kind":"parameter","displayName":"Report","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the path to the generated report String."},"reportBackground":{"index":28,"kind":"parameter","displayName":"Report Background","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets background colors for the generated report and summary."},"reportTitle":{"index":29,"kind":"parameter","displayName":"Report Title","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets a title for the generated tests report."},"runEmptySuite":{"index":30,"kind":"parameter","displayName":"Run Empty Suite","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Executes tests also if the top level test suite is empty. Useful e.g. with --include/--exclude when it is not an error that no test matches the condition."},"runFailed":{"index":31,"kind":"parameter","displayName":"Run Failed","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Re-run failed tests, based on output.xml String."},"runMode":{"index":32,"kind":"parameter","displayName":"Run Mode","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the execution mode for this tests run. Note that this setting has been deprecated in Robot Framework 2.8. Use separate dryryn, skipTeardownOnExit, exitOnFailure, and randomize settings instead."},"skipTeardownOnExit":{"index":33,"kind":"parameter","displayName":"Skip Teardown On Exit","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets whether the teardowns are skipped if the test execution is prematurely stopped."},"splitOutputs":{"index":34,"kind":"parameter","displayName":"Split Outputs","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Splits output and log files."},"suites":{"index":35,"kind":"parameter","displayName":"Suites","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Selects the tests suites by name. List"},"suiteStatLevel":{"index":36,"kind":"parameter","displayName":"Suite Stat Level","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Defines how many levels to show in the Statistics by Suite table in outputs."},"summaryTitle":{"index":37,"kind":"parameter","displayName":"Summary Title","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets a title for the generated summary report."},"tagDocs":{"index":38,"kind":"parameter","displayName":"Tag Docs","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Adds documentation to the specified tags. List"},"tags":{"index":39,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the tags(s) to all executed tests cases. List"},"tagStatExcludes":{"index":40,"kind":"parameter","displayName":"Tag Stat Excludes","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Excludes these tags from the Statistics by Tag and Test Details by Tag tables in outputs. List"},"tagStatIncludes":{"index":41,"kind":"parameter","displayName":"Tag Stat Includes","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Includes only these tags in the Statistics by Tag and Test Details by Tag tables in outputs. List"},"tagStatLinks":{"index":42,"kind":"parameter","displayName":"Tag Stat Links","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Adds external links to the Statistics by Tag table in outputs. Use the format pattern:link:title List"},"tests":{"index":43,"kind":"parameter","displayName":"Tests","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Selects the tests cases by name. List"},"timestampOutputs":{"index":44,"kind":"parameter","displayName":"Timestamp Outputs","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Adds a timestamp to all output files."},"variableFiles":{"index":45,"kind":"parameter","displayName":"Variable Files","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets variables using variables files. Use the format path:args List"},"variables":{"index":46,"kind":"parameter","displayName":"Variables","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets individual variables. Use the format name:value List"},"warnOnSkippedFiles":{"index":47,"kind":"parameter","displayName":"Warn On Skipped Files","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Show a warning when an invalid String is skipped."},"xunitFile":{"index":48,"kind":"parameter","displayName":"Xunit File","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration","configurationField":"configuration","description":"Sets the path to the generated XUnit compatible result String, relative to outputDirectory. The String is in xml format. By default, the String name is derived from the testCasesDirectory parameter, replacing blanks in the directory name by underscores."},"sendEmptyMessageWhenIdle":{"index":49,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":50,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":51,"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":{"index":52,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":53,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":54,"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."},"backoffErrorThreshold":{"index":55,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":56,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":57,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":58,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":59,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":60,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":61,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":62,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":63,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":64,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":65,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":66,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":67,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":68,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} , -{"component":{"kind":"component","name":"rocketmq","title":"RocketMQ","description":"Send and receive messages from RocketMQ cluster.","deprecated":false,"firstVersion":"3.20.0","label":"messaging","javaType":"org.apache.camel.component.rocketmq.RocketMQComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-rocketmq","version":"4.8.1","scheme":"rocketmq","extendsScheme":"","syntax":"rocketmq:topicName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelRockerMQTopic":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Topic of message","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#TOPIC"},"CamelRockerMQTag":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tag of message","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#TAG"},"CamelRockerMQKey":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Key of message","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#KEY"},"CamelRockerMQOverrideTopicName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If this header is set, the message will be routed to the topic specified by this header instead of the origin topic in endpoint.","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#OVERRIDE_TOPIC_NAME"},"CamelRockerMQOverrideTag":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If this header is set, the message's tag will be set to value specified by this header instead of the sendTag defined in endpoint.","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#OVERRIDE_TAG"},"CamelRockerMQOverrideMessageKey":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set keys for the message. When using in-out pattern, the value will be prepended to the generated keys","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#OVERRIDE_MESSAGE_KEY"},"CamelRockerMQBrokerName":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Broker name","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#BROKER_NAME"},"CamelRockerMQQueueId":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Queue ID","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#QUEUE_ID"},"CamelRockerMQStoreSize":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Store size","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#STORE_SIZE"},"CamelRockerMQQueueOffset":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Queue offset","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#QUEUE_OFFSET"},"CamelRockerMQSysFlag":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sys flag","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#SYS_FLAG"},"CamelRockerMQBornTimestamp":{"index":11,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Born timestamp","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#BORN_TIMESTAMP"},"CamelRockerMQBornHost":{"index":12,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Born host","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#BORN_HOST"},"CamelRockerMQStoreTimestamp":{"index":13,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Store timestamp","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#STORE_TIMESTAMP"},"CamelRockerMQStoreHost":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Store host","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#STORE_HOST"},"CamelRockerMQMsgId":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Msg ID","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#MSG_ID"},"CamelRockerMQCommitLogOffset":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Commit log offset","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#COMMIT_LOG_OFFSET"},"CamelRockerMQBodyCrc":{"index":17,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Body CRC","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#BODY_CRC"},"CamelRockerMQReconsumeTimes":{"index":18,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reconsume times","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#RECONSUME_TIMES"},"CamelRockerMQPreparedTransactionOffset":{"index":19,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Prepard transaction offset","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#PREPARED_TRANSACTION_OFFSET"}},"properties":{"topicName":{"index":0,"kind":"path","displayName":"Topic Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Topic name of this endpoint."},"namesrvAddr":{"index":1,"kind":"parameter","displayName":"Namesrv Addr","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost:9876","description":"Name server address of RocketMQ cluster."},"consumerGroup":{"index":2,"kind":"parameter","displayName":"Consumer Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Consumer group name."},"subscribeTags":{"index":3,"kind":"parameter","displayName":"Subscribe Tags","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"*","description":"Subscribe tags of consumer. Multiple tags could be split by , such as TagATagB"},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"producerGroup":{"index":7,"kind":"parameter","displayName":"Producer Group","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Producer group name."},"replyToConsumerGroup":{"index":8,"kind":"parameter","displayName":"Reply To Consumer Group","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Consumer group name used for receiving response."},"replyToTopic":{"index":9,"kind":"parameter","displayName":"Reply To Topic","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Topic used for receiving response when using in-out pattern."},"sendTag":{"index":10,"kind":"parameter","displayName":"Send Tag","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Each message would be sent with this tag."},"waitForSendResult":{"index":11,"kind":"parameter","displayName":"Wait For Send Result","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether waiting for send result before routing to next endpoint."},"lazyStartProducer":{"index":12,"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."},"requestTimeoutCheckerIntervalMillis":{"index":13,"kind":"parameter","displayName":"Request Timeout Checker Interval Millis","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Check interval milliseconds of request timeout."},"requestTimeoutMillis":{"index":14,"kind":"parameter","displayName":"Request Timeout Millis","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"description":"Timeout milliseconds of receiving response when using in-out pattern."},"accessKey":{"index":15,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Access key for RocketMQ ACL."},"secretKey":{"index":16,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Secret key for RocketMQ ACL."}}} +{"component":{"kind":"component","name":"rocketmq","title":"RocketMQ","description":"Send and receive messages from RocketMQ cluster.","deprecated":false,"firstVersion":"3.20.0","label":"messaging","javaType":"org.apache.camel.component.rocketmq.RocketMQComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-rocketmq","version":"4.8.2","scheme":"rocketmq","extendsScheme":"","syntax":"rocketmq:topicName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelRockerMQTopic":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Topic of message","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#TOPIC"},"CamelRockerMQTag":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tag of message","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#TAG"},"CamelRockerMQKey":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Key of message","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#KEY"},"CamelRockerMQOverrideTopicName":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If this header is set, the message will be routed to the topic specified by this header instead of the origin topic in endpoint.","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#OVERRIDE_TOPIC_NAME"},"CamelRockerMQOverrideTag":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If this header is set, the message's tag will be set to value specified by this header instead of the sendTag defined in endpoint.","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#OVERRIDE_TAG"},"CamelRockerMQOverrideMessageKey":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set keys for the message. When using in-out pattern, the value will be prepended to the generated keys","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#OVERRIDE_MESSAGE_KEY"},"CamelRockerMQBrokerName":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Broker name","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#BROKER_NAME"},"CamelRockerMQQueueId":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Queue ID","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#QUEUE_ID"},"CamelRockerMQStoreSize":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Store size","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#STORE_SIZE"},"CamelRockerMQQueueOffset":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Queue offset","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#QUEUE_OFFSET"},"CamelRockerMQSysFlag":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sys flag","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#SYS_FLAG"},"CamelRockerMQBornTimestamp":{"index":11,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Born timestamp","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#BORN_TIMESTAMP"},"CamelRockerMQBornHost":{"index":12,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Born host","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#BORN_HOST"},"CamelRockerMQStoreTimestamp":{"index":13,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Store timestamp","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#STORE_TIMESTAMP"},"CamelRockerMQStoreHost":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Store host","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#STORE_HOST"},"CamelRockerMQMsgId":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Msg ID","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#MSG_ID"},"CamelRockerMQCommitLogOffset":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Commit log offset","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#COMMIT_LOG_OFFSET"},"CamelRockerMQBodyCrc":{"index":17,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Body CRC","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#BODY_CRC"},"CamelRockerMQReconsumeTimes":{"index":18,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reconsume times","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#RECONSUME_TIMES"},"CamelRockerMQPreparedTransactionOffset":{"index":19,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Prepard transaction offset","constantName":"org.apache.camel.component.rocketmq.RocketMQConstants#PREPARED_TRANSACTION_OFFSET"}},"properties":{"topicName":{"index":0,"kind":"path","displayName":"Topic Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Topic name of this endpoint."},"namesrvAddr":{"index":1,"kind":"parameter","displayName":"Namesrv Addr","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost:9876","description":"Name server address of RocketMQ cluster."},"consumerGroup":{"index":2,"kind":"parameter","displayName":"Consumer Group","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Consumer group name."},"subscribeTags":{"index":3,"kind":"parameter","displayName":"Subscribe Tags","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"*","description":"Subscribe tags of consumer. Multiple tags could be split by , such as TagATagB"},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"producerGroup":{"index":7,"kind":"parameter","displayName":"Producer Group","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Producer group name."},"replyToConsumerGroup":{"index":8,"kind":"parameter","displayName":"Reply To Consumer Group","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Consumer group name used for receiving response."},"replyToTopic":{"index":9,"kind":"parameter","displayName":"Reply To Topic","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Topic used for receiving response when using in-out pattern."},"sendTag":{"index":10,"kind":"parameter","displayName":"Send Tag","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Each message would be sent with this tag."},"waitForSendResult":{"index":11,"kind":"parameter","displayName":"Wait For Send Result","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether waiting for send result before routing to next endpoint."},"lazyStartProducer":{"index":12,"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."},"requestTimeoutCheckerIntervalMillis":{"index":13,"kind":"parameter","displayName":"Request Timeout Checker Interval Millis","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Check interval milliseconds of request timeout."},"requestTimeoutMillis":{"index":14,"kind":"parameter","displayName":"Request Timeout Millis","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"description":"Timeout milliseconds of receiving response when using in-out pattern."},"accessKey":{"index":15,"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Access key for RocketMQ ACL."},"secretKey":{"index":16,"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Secret key for RocketMQ ACL."}}} , -{"component":{"kind":"component","name":"rss","title":"RSS","description":"Poll RSS feeds.","deprecated":false,"firstVersion":"2.0.0","label":"document","javaType":"org.apache.camel.component.rss.RssComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-rss","version":"4.8.1","scheme":"rss","extendsScheme":"atom","syntax":"rss:feedUri","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelRssFeed":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The entire SyncFeed object.","constantName":"org.apache.camel.component.rss.RssConstants#RSS_FEED"}},"properties":{"feedUri":{"index":0,"kind":"path","displayName":"Feed Uri","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The URI to the feed to poll."},"sendEmptyMessageWhenIdle":{"index":1,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"sortEntries":{"index":2,"kind":"parameter","displayName":"Sort Entries","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to sort entries by published date. Only works when splitEntries = true."},"splitEntries":{"index":3,"kind":"parameter","displayName":"Split Entries","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message"},"throttleEntries":{"index":4,"kind":"parameter","displayName":"Throttle Entries","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether all entries identified in a single feed poll should be delivered immediately. If true, only one entry is processed per delay. Only applicable when splitEntries = true."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":8,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"feedHeader":{"index":9,"kind":"parameter","displayName":"Feed Header","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to add the feed object as a header."},"backoffErrorThreshold":{"index":10,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":11,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":12,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":13,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":14,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":15,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":16,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":17,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":18,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":19,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":20,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":21,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":22,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":23,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} +{"component":{"kind":"component","name":"rss","title":"RSS","description":"Poll RSS feeds.","deprecated":false,"firstVersion":"2.0.0","label":"document","javaType":"org.apache.camel.component.rss.RssComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-rss","version":"4.8.2","scheme":"rss","extendsScheme":"atom","syntax":"rss:feedUri","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelRssFeed":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The entire SyncFeed object.","constantName":"org.apache.camel.component.rss.RssConstants#RSS_FEED"}},"properties":{"feedUri":{"index":0,"kind":"path","displayName":"Feed Uri","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The URI to the feed to poll."},"sendEmptyMessageWhenIdle":{"index":1,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"sortEntries":{"index":2,"kind":"parameter","displayName":"Sort Entries","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to sort entries by published date. Only works when splitEntries = true."},"splitEntries":{"index":3,"kind":"parameter","displayName":"Split Entries","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message"},"throttleEntries":{"index":4,"kind":"parameter","displayName":"Throttle Entries","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether all entries identified in a single feed poll should be delivered immediately. If true, only one entry is processed per delay. Only applicable when splitEntries = true."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":8,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"feedHeader":{"index":9,"kind":"parameter","displayName":"Feed Header","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to add the feed object as a header."},"backoffErrorThreshold":{"index":10,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":11,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":12,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":13,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":14,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":15,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":16,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":17,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":18,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":19,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":20,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":21,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":22,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":23,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} , -{"component":{"kind":"component","name":"saga","title":"Saga","description":"Execute custom actions within a route using the Saga EIP.","deprecated":false,"firstVersion":"2.21.0","label":"clustering","javaType":"org.apache.camel.component.saga.SagaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-saga","version":"4.8.1","scheme":"saga","extendsScheme":"","syntax":"saga:action","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"Long-Running-Action":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The long running action","constantName":"org.apache.camel.component.saga.SagaConstants#SAGA_LONG_RUNNING_ACTION"}},"properties":{"action":{"index":0,"kind":"path","displayName":"Action","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.saga.SagaEndpoint.SagaEndpointAction","enum":["COMPLETE","COMPENSATE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action to execute (complete or compensate)"},"lazyStartProducer":{"index":1,"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."}}} +{"component":{"kind":"component","name":"saga","title":"Saga","description":"Execute custom actions within a route using the Saga EIP.","deprecated":false,"firstVersion":"2.21.0","label":"clustering","javaType":"org.apache.camel.component.saga.SagaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-saga","version":"4.8.2","scheme":"saga","extendsScheme":"","syntax":"saga:action","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"Long-Running-Action":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The long running action","constantName":"org.apache.camel.component.saga.SagaConstants#SAGA_LONG_RUNNING_ACTION"}},"properties":{"action":{"index":0,"kind":"path","displayName":"Action","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.saga.SagaEndpoint.SagaEndpointAction","enum":["COMPLETE","COMPENSATE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Action to execute (complete or compensate)"},"lazyStartProducer":{"index":1,"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."}}} , -{"component":{"kind":"component","name":"salesforce","title":"Salesforce","description":"Communicate with Salesforce using Java DTOs.","deprecated":false,"firstVersion":"2.12.0","label":"cloud,saas","javaType":"org.apache.camel.component.salesforce.SalesforceComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-salesforce","version":"4.8.1","scheme":"salesforce","extendsScheme":"","syntax":"salesforce:operationName:topicName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"CamelSalesforceReplayId":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Streaming API replayId.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_REPLAY_ID"},"CamelSalesforcePubSubReplayId":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Pub/Sub API replayId.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_PUBSUB_REPLAY_ID"},"CamelSalesforceChangeEventSchema":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The change event schema.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_EVENT_SCHEMA"},"CamelSalesforceEventType":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event type.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_EVENT_TYPE"},"CamelSalesforceCommitTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit timestamp.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_TIMESTAMP"},"CamelSalesforceCommitUser":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit user.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_USER"},"CamelSalesforceCommitNumber":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit number.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_NUMBER"},"CamelSalesforceRecordIds":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The record ids.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_RECORD_IDS"},"CamelSalesforceChangeType":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The change type.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_TYPE"},"CamelSalesforceChangeOrigin":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The change origin.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_ORIGIN"},"CamelSalesforceTransactionKey":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The transaction key.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_TRANSACTION_KEY"},"CamelSalesforceSequenceNumber":{"index":11,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sequence number.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_SEQUENCE_NUMBER"},"CamelSalesforceIsTransactionEnd":{"index":12,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is transaction end.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_IS_TRANSACTION_END"},"CamelSalesforceEntityName":{"index":13,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The entity name.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_ENTITY_NAME"},"CamelSalesforcePlatformEventSchema":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The platform event schema.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_PLATFORM_EVENT_SCHEMA"},"CamelSalesforceCreatedDate":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.time.ZonedDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The created date.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CREATED_DATE"},"CamelSalesforceTopicName":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The topic name.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_TOPIC_NAME"},"CamelSalesforceChannel":{"index":17,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channel.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANNEL"},"CamelSalesforceClientId":{"index":18,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The client id.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CLIENT_ID"},"CamelSalesforceQueryResultTotalSize":{"index":19,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Total number of records matching a query.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_QUERY_RESULT_TOTAL_SIZE"}},"properties":{"operationName":{"index":0,"kind":"path","displayName":"Operation Name","group":"common","label":"common","required":true,"type":"object","javaType":"org.apache.camel.component.salesforce.internal.OperationName","enum":["getVersions","getResources","getGlobalObjects","getBasicInfo","getDescription","getSObject","createSObject","updateSObject","deleteSObject","getSObjectWithId","upsertSObject","deleteSObjectWithId","getBlobField","query","queryMore","queryAll","search","apexCall","recent","getEventSchema","createJob","getJob","closeJob","abortJob","createBatch","getBatch","getAllBatches","getRequest","getResults","createBatchQuery","getQueryResultIds","getQueryResult","getRecentReports","getReportDescription","executeSyncReport","executeAsyncReport","getReportInstances","getReportResults","limits","approval","approvals","composite-tree","composite-batch","composite","compositeRetrieveSObjectCollections","compositeCreateSObjectCollections","compositeUpdateSObjectCollections","compositeUpsertSObjectCollections","compositeDeleteSObjectCollections","bulk2GetAllJobs","bulk2CreateJob","bulk2GetJob","bulk2CreateBatch","bulk2CloseJob","bulk2AbortJob","bulk2DeleteJob","bulk2GetSuccessfulResults","bulk2GetFailedResults","bulk2GetUnprocessedRecords","bulk2CreateQueryJob","bulk2GetQueryJob","bulk2GetAllQueryJobs","bulk2GetQueryJobResults","bulk2AbortQueryJob","bulk2DeleteQueryJob","raw","subscribe","pubSubSubscribe","pubSubPublish"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to use"},"topicName":{"index":1,"kind":"path","displayName":"Topic Name","group":"producer","label":"consumer,producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the topic/channel to use"},"apexMethod":{"index":2,"kind":"parameter","displayName":"Apex Method","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"APEX method name"},"apexQueryParams":{"index":3,"kind":"parameter","displayName":"Apex Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Query params for APEX method"},"apiVersion":{"index":4,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"56.0","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Salesforce API version."},"backoffIncrement":{"index":5,"kind":"parameter","displayName":"Backoff Increment","group":"common","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect."},"batchId":{"index":6,"kind":"parameter","displayName":"Batch Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Bulk API Batch ID"},"contentType":{"index":7,"kind":"parameter","displayName":"Content Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.api.dto.bulk.ContentType","enum":["XML","CSV","JSON","ZIP_XML","ZIP_CSV","ZIP_JSON"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV"},"defaultReplayId":{"index":8,"kind":"parameter","displayName":"Default Replay Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"-1","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Default replayId setting if no value is found in initialReplayIdMap"},"fallBackReplayId":{"index":9,"kind":"parameter","displayName":"Fall Back Replay Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"-1","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"ReplayId to fall back to after an Invalid Replay Id response"},"format":{"index":10,"kind":"parameter","displayName":"Format","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.internal.PayloadFormat","enum":["JSON","XML"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON. As of Camel 3.12, this option only applies to the Raw operation."},"httpClient":{"index":11,"kind":"parameter","displayName":"Http Client","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.SalesforceHttpClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Custom Jetty Http Client to use to connect to Salesforce."},"includeDetails":{"index":12,"kind":"parameter","displayName":"Include Details","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Include details in Salesforce1 Analytics report, defaults to false."},"initialReplayIdMap":{"index":13,"kind":"parameter","displayName":"Initial Replay Id Map","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Replay IDs to start from per channel name."},"instanceId":{"index":14,"kind":"parameter","displayName":"Instance Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Salesforce1 Analytics report execution instance ID"},"jobId":{"index":15,"kind":"parameter","displayName":"Job Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Bulk API Job ID"},"limit":{"index":16,"kind":"parameter","displayName":"Limit","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Limit on number of returned records. Applicable to some of the API, check the Salesforce documentation."},"locator":{"index":17,"kind":"parameter","displayName":"Locator","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Locator provided by salesforce Bulk 2.0 API for use in getting results for a Query job."},"maxBackoff":{"index":18,"kind":"parameter","displayName":"Max Backoff","group":"common","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect."},"maxRecords":{"index":19,"kind":"parameter","displayName":"Max Records","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"The maximum number of records to retrieve per set of results for a Bulk 2.0 Query. The request is still subject to the size limits. If you are working with a very large number of query results, you may experience a timeout before receiving all the data from Salesforce. To prevent a timeout, specify the maximum number of records your client is expecting to receive in the maxRecords parameter. This splits the results into smaller sets with this value as the maximum size."},"notFoundBehaviour":{"index":20,"kind":"parameter","displayName":"Not Found Behaviour","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.NotFoundBehaviour","enum":["EXCEPTION","NULL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"EXCEPTION","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Sets the behaviour of 404 not found status received from Salesforce API. Should the body be set to NULL NotFoundBehaviour#NULL or should a exception be signaled on the exchange NotFoundBehaviour#EXCEPTION - the default."},"notifyForFields":{"index":21,"kind":"parameter","displayName":"Notify For Fields","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.internal.dto.NotifyForFieldsEnum","enum":["ALL","REFERENCED","SELECT","WHERE"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Notify for fields, options are ALL, REFERENCED, SELECT, WHERE"},"notifyForOperationCreate":{"index":22,"kind":"parameter","displayName":"Notify For Operation Create","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Notify for create operation, defaults to false (API version >= 29.0)"},"notifyForOperationDelete":{"index":23,"kind":"parameter","displayName":"Notify For Operation Delete","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Notify for delete operation, defaults to false (API version >= 29.0)"},"notifyForOperations":{"index":24,"kind":"parameter","displayName":"Notify For Operations","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.internal.dto.NotifyForOperationsEnum","enum":["ALL","CREATE","EXTENDED","UPDATE"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version < 29.0)"},"notifyForOperationUndelete":{"index":25,"kind":"parameter","displayName":"Notify For Operation Undelete","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Notify for un-delete operation, defaults to false (API version >= 29.0)"},"notifyForOperationUpdate":{"index":26,"kind":"parameter","displayName":"Notify For Operation Update","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Notify for update operation, defaults to false (API version >= 29.0)"},"objectMapper":{"index":27,"kind":"parameter","displayName":"Object Mapper","group":"common","label":"","required":false,"type":"object","javaType":"com.fasterxml.jackson.databind.ObjectMapper","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects."},"pkChunking":{"index":28,"kind":"parameter","displayName":"Pk Chunking","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Use PK Chunking. Only for use in original Bulk API. Bulk 2.0 API performs PK chunking automatically, if necessary."},"pkChunkingChunkSize":{"index":29,"kind":"parameter","displayName":"Pk Chunking Chunk Size","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Chunk size for use with PK Chunking. If unspecified, salesforce default is 100,000. Maximum size is 250,000."},"pkChunkingParent":{"index":30,"kind":"parameter","displayName":"Pk Chunking Parent","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Specifies the parent object when you're enabling PK chunking for queries on sharing objects. The chunks are based on the parent object's records rather than the sharing object's records. For example, when querying on AccountShare, specify Account as the parent object. PK chunking is supported for sharing objects as long as the parent object is supported."},"pkChunkingStartRow":{"index":31,"kind":"parameter","displayName":"Pk Chunking Start Row","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Specifies the 15-character or 18-character record ID to be used as the lower boundary for the first chunk. Use this parameter to specify a starting ID when restarting a job that failed between batches."},"queryLocator":{"index":32,"kind":"parameter","displayName":"Query Locator","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Query Locator provided by salesforce for use when a query results in more records than can be retrieved in a single call. Use this value in a subsequent call to retrieve additional records."},"rawPayload":{"index":33,"kind":"parameter","displayName":"Raw Payload","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default"},"reportId":{"index":34,"kind":"parameter","displayName":"Report Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Salesforce1 Analytics report Id"},"reportMetadata":{"index":35,"kind":"parameter","displayName":"Report Metadata","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Salesforce1 Analytics report metadata for filtering"},"resultId":{"index":36,"kind":"parameter","displayName":"Result Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Bulk API Result ID"},"sObjectBlobFieldName":{"index":37,"kind":"parameter","displayName":"SObject Blob Field Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"SObject blob field name"},"sObjectClass":{"index":38,"kind":"parameter","displayName":"SObject Class","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin"},"sObjectFields":{"index":39,"kind":"parameter","displayName":"SObject Fields","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"SObject fields to retrieve"},"sObjectId":{"index":40,"kind":"parameter","displayName":"SObject Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"SObject ID if required by API"},"sObjectIdName":{"index":41,"kind":"parameter","displayName":"SObject Id Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"SObject external ID field name"},"sObjectIdValue":{"index":42,"kind":"parameter","displayName":"SObject Id Value","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"SObject external ID field value"},"sObjectName":{"index":43,"kind":"parameter","displayName":"SObject Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"SObject name if required or supported by API"},"sObjectQuery":{"index":44,"kind":"parameter","displayName":"SObject Query","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Salesforce SOQL query string"},"sObjectSearch":{"index":45,"kind":"parameter","displayName":"SObject Search","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Salesforce SOSL search string"},"streamQueryResult":{"index":46,"kind":"parameter","displayName":"Stream query result","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"If true, streams SOQL query result and transparently handles subsequent requests if there are multiple pages. Otherwise, results are returned one page at a time."},"updateTopic":{"index":47,"kind":"parameter","displayName":"Update Topic","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Whether to update an existing Push Topic when using the Streaming API, defaults to false"},"pubSubBatchSize":{"index":48,"kind":"parameter","displayName":"Pub Sub Batch Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Max number of events to receive in a batch from the Pub/Sub API."},"pubSubDeserializeType":{"index":49,"kind":"parameter","displayName":"Pub Sub Deserialize Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.PubSubDeserializeType","enum":["AVRO","SPECIFIC_RECORD","GENERIC_RECORD","POJO","JSON"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AVRO","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"How to deserialize events consume from the Pub/Sub API. AVRO will try a SpecificRecord subclass if found, otherwise GenericRecord."},"pubSubPojoClass":{"index":50,"kind":"parameter","displayName":"Pub Sub Pojo Class","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Fully qualified class name to deserialize Pub/Sub API event to."},"pubSubReplayId":{"index":51,"kind":"parameter","displayName":"Pub Sub Replay Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The replayId value to use when subscribing to the Pub/Sub API."},"replayId":{"index":52,"kind":"parameter","displayName":"Replay Id","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The replayId value to use when subscribing to the Streaming API."},"replayPreset":{"index":53,"kind":"parameter","displayName":"Replay Preset","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.salesforce.eventbus.protobuf.ReplayPreset","enum":["LATEST","EARLIEST","CUSTOM"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"LATEST","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Replay preset for Pub/Sub API."},"bridgeErrorHandler":{"index":54,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":55,"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":{"index":56,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"allOrNone":{"index":57,"kind":"parameter","displayName":"All Or None","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Composite API option to indicate to rollback all records if any are not successful."},"apexUrl":{"index":58,"kind":"parameter","displayName":"Apex Url","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"APEX method URL"},"compositeMethod":{"index":59,"kind":"parameter","displayName":"Composite Method","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Composite (raw) method."},"eventName":{"index":60,"kind":"parameter","displayName":"Event Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Name of Platform Event, Change Data Capture Event, custom event, etc."},"eventSchemaFormat":{"index":61,"kind":"parameter","displayName":"Event Schema Format","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.internal.dto.EventSchemaFormatEnum","enum":["EXPANDED","COMPACT"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"EXPANDED: Apache Avro format but doesn't strictly adhere to the record complex type. COMPACT: Apache Avro, adheres to the specification for the record complex type. This parameter is available in API version 43.0 and later."},"eventSchemaId":{"index":62,"kind":"parameter","displayName":"Event Schema Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"The ID of the event schema."},"rawHttpHeaders":{"index":63,"kind":"parameter","displayName":"Raw Http Headers","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Comma separated list of message headers to include as HTTP parameters for Raw operation."},"rawMethod":{"index":64,"kind":"parameter","displayName":"Raw Method","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"HTTP method to use for the Raw operation"},"rawPath":{"index":65,"kind":"parameter","displayName":"Raw Path","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"The portion of the endpoint URL after the domain name. E.g., '/services/data/v52.0/sobjects/Account/'"},"rawQueryParameters":{"index":66,"kind":"parameter","displayName":"Raw Query Parameters","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Comma separated list of message headers to include as query parameters for Raw operation. Do not url-encode values as this will be done automatically."},"lazyStartProducer":{"index":67,"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."}}} +{"component":{"kind":"component","name":"salesforce","title":"Salesforce","description":"Communicate with Salesforce using Java DTOs.","deprecated":false,"firstVersion":"2.12.0","label":"cloud,saas","javaType":"org.apache.camel.component.salesforce.SalesforceComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-salesforce","version":"4.8.2","scheme":"salesforce","extendsScheme":"","syntax":"salesforce:operationName:topicName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"CamelSalesforceReplayId":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Streaming API replayId.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_REPLAY_ID"},"CamelSalesforcePubSubReplayId":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Pub/Sub API replayId.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_PUBSUB_REPLAY_ID"},"CamelSalesforceChangeEventSchema":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The change event schema.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_EVENT_SCHEMA"},"CamelSalesforceEventType":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event type.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_EVENT_TYPE"},"CamelSalesforceCommitTimestamp":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit timestamp.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_TIMESTAMP"},"CamelSalesforceCommitUser":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit user.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_USER"},"CamelSalesforceCommitNumber":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The commit number.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_NUMBER"},"CamelSalesforceRecordIds":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The record ids.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_RECORD_IDS"},"CamelSalesforceChangeType":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The change type.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_TYPE"},"CamelSalesforceChangeOrigin":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The change origin.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_ORIGIN"},"CamelSalesforceTransactionKey":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The transaction key.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_TRANSACTION_KEY"},"CamelSalesforceSequenceNumber":{"index":11,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sequence number.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_SEQUENCE_NUMBER"},"CamelSalesforceIsTransactionEnd":{"index":12,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is transaction end.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_IS_TRANSACTION_END"},"CamelSalesforceEntityName":{"index":13,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The entity name.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_ENTITY_NAME"},"CamelSalesforcePlatformEventSchema":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The platform event schema.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_PLATFORM_EVENT_SCHEMA"},"CamelSalesforceCreatedDate":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.time.ZonedDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The created date.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CREATED_DATE"},"CamelSalesforceTopicName":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The topic name.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_TOPIC_NAME"},"CamelSalesforceChannel":{"index":17,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channel.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANNEL"},"CamelSalesforceClientId":{"index":18,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The client id.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CLIENT_ID"},"CamelSalesforceQueryResultTotalSize":{"index":19,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Total number of records matching a query.","constantName":"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_QUERY_RESULT_TOTAL_SIZE"}},"properties":{"operationName":{"index":0,"kind":"path","displayName":"Operation Name","group":"common","label":"common","required":true,"type":"object","javaType":"org.apache.camel.component.salesforce.internal.OperationName","enum":["getVersions","getResources","getGlobalObjects","getBasicInfo","getDescription","getSObject","createSObject","updateSObject","deleteSObject","getSObjectWithId","upsertSObject","deleteSObjectWithId","getBlobField","query","queryMore","queryAll","search","apexCall","recent","getEventSchema","createJob","getJob","closeJob","abortJob","createBatch","getBatch","getAllBatches","getRequest","getResults","createBatchQuery","getQueryResultIds","getQueryResult","getRecentReports","getReportDescription","executeSyncReport","executeAsyncReport","getReportInstances","getReportResults","limits","approval","approvals","composite-tree","composite-batch","composite","compositeRetrieveSObjectCollections","compositeCreateSObjectCollections","compositeUpdateSObjectCollections","compositeUpsertSObjectCollections","compositeDeleteSObjectCollections","bulk2GetAllJobs","bulk2CreateJob","bulk2GetJob","bulk2CreateBatch","bulk2CloseJob","bulk2AbortJob","bulk2DeleteJob","bulk2GetSuccessfulResults","bulk2GetFailedResults","bulk2GetUnprocessedRecords","bulk2CreateQueryJob","bulk2GetQueryJob","bulk2GetAllQueryJobs","bulk2GetQueryJobResults","bulk2AbortQueryJob","bulk2DeleteQueryJob","raw","subscribe","pubSubSubscribe","pubSubPublish"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to use"},"topicName":{"index":1,"kind":"path","displayName":"Topic Name","group":"producer","label":"consumer,producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the topic/channel to use"},"apexMethod":{"index":2,"kind":"parameter","displayName":"Apex Method","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"APEX method name"},"apexQueryParams":{"index":3,"kind":"parameter","displayName":"Apex Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Query params for APEX method"},"apiVersion":{"index":4,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"56.0","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Salesforce API version."},"backoffIncrement":{"index":5,"kind":"parameter","displayName":"Backoff Increment","group":"common","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect."},"batchId":{"index":6,"kind":"parameter","displayName":"Batch Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Bulk API Batch ID"},"contentType":{"index":7,"kind":"parameter","displayName":"Content Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.api.dto.bulk.ContentType","enum":["XML","CSV","JSON","ZIP_XML","ZIP_CSV","ZIP_JSON"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV"},"defaultReplayId":{"index":8,"kind":"parameter","displayName":"Default Replay Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"-1","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Default replayId setting if no value is found in initialReplayIdMap"},"fallBackReplayId":{"index":9,"kind":"parameter","displayName":"Fall Back Replay Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"-1","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"ReplayId to fall back to after an Invalid Replay Id response"},"format":{"index":10,"kind":"parameter","displayName":"Format","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.internal.PayloadFormat","enum":["JSON","XML"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON. As of Camel 3.12, this option only applies to the Raw operation."},"httpClient":{"index":11,"kind":"parameter","displayName":"Http Client","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.SalesforceHttpClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Custom Jetty Http Client to use to connect to Salesforce."},"includeDetails":{"index":12,"kind":"parameter","displayName":"Include Details","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Include details in Salesforce1 Analytics report, defaults to false."},"initialReplayIdMap":{"index":13,"kind":"parameter","displayName":"Initial Replay Id Map","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Replay IDs to start from per channel name."},"instanceId":{"index":14,"kind":"parameter","displayName":"Instance Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Salesforce1 Analytics report execution instance ID"},"jobId":{"index":15,"kind":"parameter","displayName":"Job Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Bulk API Job ID"},"limit":{"index":16,"kind":"parameter","displayName":"Limit","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Limit on number of returned records. Applicable to some of the API, check the Salesforce documentation."},"locator":{"index":17,"kind":"parameter","displayName":"Locator","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Locator provided by salesforce Bulk 2.0 API for use in getting results for a Query job."},"maxBackoff":{"index":18,"kind":"parameter","displayName":"Max Backoff","group":"common","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect."},"maxRecords":{"index":19,"kind":"parameter","displayName":"Max Records","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"The maximum number of records to retrieve per set of results for a Bulk 2.0 Query. The request is still subject to the size limits. If you are working with a very large number of query results, you may experience a timeout before receiving all the data from Salesforce. To prevent a timeout, specify the maximum number of records your client is expecting to receive in the maxRecords parameter. This splits the results into smaller sets with this value as the maximum size."},"notFoundBehaviour":{"index":20,"kind":"parameter","displayName":"Not Found Behaviour","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.NotFoundBehaviour","enum":["EXCEPTION","NULL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"EXCEPTION","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Sets the behaviour of 404 not found status received from Salesforce API. Should the body be set to NULL NotFoundBehaviour#NULL or should a exception be signaled on the exchange NotFoundBehaviour#EXCEPTION - the default."},"notifyForFields":{"index":21,"kind":"parameter","displayName":"Notify For Fields","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.internal.dto.NotifyForFieldsEnum","enum":["ALL","REFERENCED","SELECT","WHERE"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Notify for fields, options are ALL, REFERENCED, SELECT, WHERE"},"notifyForOperationCreate":{"index":22,"kind":"parameter","displayName":"Notify For Operation Create","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Notify for create operation, defaults to false (API version >= 29.0)"},"notifyForOperationDelete":{"index":23,"kind":"parameter","displayName":"Notify For Operation Delete","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Notify for delete operation, defaults to false (API version >= 29.0)"},"notifyForOperations":{"index":24,"kind":"parameter","displayName":"Notify For Operations","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.internal.dto.NotifyForOperationsEnum","enum":["ALL","CREATE","EXTENDED","UPDATE"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version < 29.0)"},"notifyForOperationUndelete":{"index":25,"kind":"parameter","displayName":"Notify For Operation Undelete","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Notify for un-delete operation, defaults to false (API version >= 29.0)"},"notifyForOperationUpdate":{"index":26,"kind":"parameter","displayName":"Notify For Operation Update","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Notify for update operation, defaults to false (API version >= 29.0)"},"objectMapper":{"index":27,"kind":"parameter","displayName":"Object Mapper","group":"common","label":"","required":false,"type":"object","javaType":"com.fasterxml.jackson.databind.ObjectMapper","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects."},"pkChunking":{"index":28,"kind":"parameter","displayName":"Pk Chunking","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Use PK Chunking. Only for use in original Bulk API. Bulk 2.0 API performs PK chunking automatically, if necessary."},"pkChunkingChunkSize":{"index":29,"kind":"parameter","displayName":"Pk Chunking Chunk Size","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Chunk size for use with PK Chunking. If unspecified, salesforce default is 100,000. Maximum size is 250,000."},"pkChunkingParent":{"index":30,"kind":"parameter","displayName":"Pk Chunking Parent","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Specifies the parent object when you're enabling PK chunking for queries on sharing objects. The chunks are based on the parent object's records rather than the sharing object's records. For example, when querying on AccountShare, specify Account as the parent object. PK chunking is supported for sharing objects as long as the parent object is supported."},"pkChunkingStartRow":{"index":31,"kind":"parameter","displayName":"Pk Chunking Start Row","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Specifies the 15-character or 18-character record ID to be used as the lower boundary for the first chunk. Use this parameter to specify a starting ID when restarting a job that failed between batches."},"queryLocator":{"index":32,"kind":"parameter","displayName":"Query Locator","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Query Locator provided by salesforce for use when a query results in more records than can be retrieved in a single call. Use this value in a subsequent call to retrieve additional records."},"rawPayload":{"index":33,"kind":"parameter","displayName":"Raw Payload","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default"},"reportId":{"index":34,"kind":"parameter","displayName":"Report Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Salesforce1 Analytics report Id"},"reportMetadata":{"index":35,"kind":"parameter","displayName":"Report Metadata","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Salesforce1 Analytics report metadata for filtering"},"resultId":{"index":36,"kind":"parameter","displayName":"Result Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Bulk API Result ID"},"sObjectBlobFieldName":{"index":37,"kind":"parameter","displayName":"SObject Blob Field Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"SObject blob field name"},"sObjectClass":{"index":38,"kind":"parameter","displayName":"SObject Class","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin"},"sObjectFields":{"index":39,"kind":"parameter","displayName":"SObject Fields","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"SObject fields to retrieve"},"sObjectId":{"index":40,"kind":"parameter","displayName":"SObject Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"SObject ID if required by API"},"sObjectIdName":{"index":41,"kind":"parameter","displayName":"SObject Id Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"SObject external ID field name"},"sObjectIdValue":{"index":42,"kind":"parameter","displayName":"SObject Id Value","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"SObject external ID field value"},"sObjectName":{"index":43,"kind":"parameter","displayName":"SObject Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"SObject name if required or supported by API"},"sObjectQuery":{"index":44,"kind":"parameter","displayName":"SObject Query","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Salesforce SOQL query string"},"sObjectSearch":{"index":45,"kind":"parameter","displayName":"SObject Search","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Salesforce SOSL search string"},"streamQueryResult":{"index":46,"kind":"parameter","displayName":"Stream query result","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"If true, streams SOQL query result and transparently handles subsequent requests if there are multiple pages. Otherwise, results are returned one page at a time."},"updateTopic":{"index":47,"kind":"parameter","displayName":"Update Topic","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Whether to update an existing Push Topic when using the Streaming API, defaults to false"},"pubSubBatchSize":{"index":48,"kind":"parameter","displayName":"Pub Sub Batch Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Max number of events to receive in a batch from the Pub/Sub API."},"pubSubDeserializeType":{"index":49,"kind":"parameter","displayName":"Pub Sub Deserialize Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.PubSubDeserializeType","enum":["AVRO","SPECIFIC_RECORD","GENERIC_RECORD","POJO","JSON"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AVRO","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"How to deserialize events consume from the Pub/Sub API. AVRO will try a SpecificRecord subclass if found, otherwise GenericRecord."},"pubSubPojoClass":{"index":50,"kind":"parameter","displayName":"Pub Sub Pojo Class","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Fully qualified class name to deserialize Pub/Sub API event to."},"pubSubReplayId":{"index":51,"kind":"parameter","displayName":"Pub Sub Replay Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The replayId value to use when subscribing to the Pub/Sub API."},"replayId":{"index":52,"kind":"parameter","displayName":"Replay Id","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The replayId value to use when subscribing to the Streaming API."},"replayPreset":{"index":53,"kind":"parameter","displayName":"Replay Preset","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.salesforce.eventbus.protobuf.ReplayPreset","enum":["LATEST","EARLIEST","CUSTOM"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"LATEST","configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Replay preset for Pub/Sub API."},"bridgeErrorHandler":{"index":54,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":55,"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":{"index":56,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"allOrNone":{"index":57,"kind":"parameter","displayName":"All Or None","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Composite API option to indicate to rollback all records if any are not successful."},"apexUrl":{"index":58,"kind":"parameter","displayName":"Apex Url","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"APEX method URL"},"compositeMethod":{"index":59,"kind":"parameter","displayName":"Composite Method","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Composite (raw) method."},"eventName":{"index":60,"kind":"parameter","displayName":"Event Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Name of Platform Event, Change Data Capture Event, custom event, etc."},"eventSchemaFormat":{"index":61,"kind":"parameter","displayName":"Event Schema Format","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.salesforce.internal.dto.EventSchemaFormatEnum","enum":["EXPANDED","COMPACT"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"EXPANDED: Apache Avro format but doesn't strictly adhere to the record complex type. COMPACT: Apache Avro, adheres to the specification for the record complex type. This parameter is available in API version 43.0 and later."},"eventSchemaId":{"index":62,"kind":"parameter","displayName":"Event Schema Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"The ID of the event schema."},"rawHttpHeaders":{"index":63,"kind":"parameter","displayName":"Raw Http Headers","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Comma separated list of message headers to include as HTTP parameters for Raw operation."},"rawMethod":{"index":64,"kind":"parameter","displayName":"Raw Method","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"HTTP method to use for the Raw operation"},"rawPath":{"index":65,"kind":"parameter","displayName":"Raw Path","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"The portion of the endpoint URL after the domain name. E.g., '/services/data/v52.0/sobjects/Account/'"},"rawQueryParameters":{"index":66,"kind":"parameter","displayName":"Raw Query Parameters","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.salesforce.SalesforceEndpointConfig","configurationField":"configuration","description":"Comma separated list of message headers to include as query parameters for Raw operation. Do not url-encode values as this will be done automatically."},"lazyStartProducer":{"index":67,"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."}}} , -{"component":{"kind":"component","name":"sap-netweaver","title":"SAP NetWeaver","description":"Send requests to SAP NetWeaver Gateway using HTTP.","deprecated":false,"firstVersion":"2.12.0","label":"saas","javaType":"org.apache.camel.component.sap.netweaver.NetWeaverComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-sap-netweaver","version":"4.8.1","scheme":"sap-netweaver","extendsScheme":"","syntax":"sap-netweaver:url","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelNetWeaverCommand":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The command to execute in http://msdn.microsoft.com/en-us/library/cc956153.aspxMS ADO.Net Data Service format.","constantName":"org.apache.camel.component.sap.netweaver.NetWeaverConstants#COMMAND"},"CamelHttpPath":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http path.","constantName":"org.apache.camel.component.sap.netweaver.NetWeaverConstants#HTTP_PATH"},"Accept":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The media type.","constantName":"org.apache.camel.component.sap.netweaver.NetWeaverConstants#ACCEPT"}},"properties":{"url":{"index":0,"kind":"path","displayName":"Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Url to the SAP net-weaver gateway server."},"flatternMap":{"index":1,"kind":"parameter","displayName":"Flattern Map","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If the JSON Map contains only a single entry, then flattern by storing that single entry value as the message body."},"json":{"index":2,"kind":"parameter","displayName":"Json","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to return data in JSON format. If this option is false, then XML is returned in Atom format."},"jsonAsMap":{"index":3,"kind":"parameter","displayName":"Json As Map","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"To transform the JSON from a String to a Map in the message body."},"password":{"index":4,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Password for account."},"username":{"index":5,"kind":"parameter","displayName":"Username","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Username for account."},"lazyStartProducer":{"index":6,"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."}}} +{"component":{"kind":"component","name":"sap-netweaver","title":"SAP NetWeaver","description":"Send requests to SAP NetWeaver Gateway using HTTP.","deprecated":false,"firstVersion":"2.12.0","label":"saas","javaType":"org.apache.camel.component.sap.netweaver.NetWeaverComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-sap-netweaver","version":"4.8.2","scheme":"sap-netweaver","extendsScheme":"","syntax":"sap-netweaver:url","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelNetWeaverCommand":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":true,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The command to execute in http://msdn.microsoft.com/en-us/library/cc956153.aspxMS ADO.Net Data Service format.","constantName":"org.apache.camel.component.sap.netweaver.NetWeaverConstants#COMMAND"},"CamelHttpPath":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http path.","constantName":"org.apache.camel.component.sap.netweaver.NetWeaverConstants#HTTP_PATH"},"Accept":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The media type.","constantName":"org.apache.camel.component.sap.netweaver.NetWeaverConstants#ACCEPT"}},"properties":{"url":{"index":0,"kind":"path","displayName":"Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Url to the SAP net-weaver gateway server."},"flatternMap":{"index":1,"kind":"parameter","displayName":"Flattern Map","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If the JSON Map contains only a single entry, then flattern by storing that single entry value as the message body."},"json":{"index":2,"kind":"parameter","displayName":"Json","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to return data in JSON format. If this option is false, then XML is returned in Atom format."},"jsonAsMap":{"index":3,"kind":"parameter","displayName":"Json As Map","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"To transform the JSON from a String to a Map in the message body."},"password":{"index":4,"kind":"parameter","displayName":"Password","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Password for account."},"username":{"index":5,"kind":"parameter","displayName":"Username","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Username for account."},"lazyStartProducer":{"index":6,"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."}}} , -{"component":{"kind":"component","name":"scheduler","title":"Scheduler","description":"Generate messages in specified intervals using java.util.concurrent.ScheduledExecutorService.","deprecated":false,"firstVersion":"2.15.0","label":"core,scheduling","javaType":"org.apache.camel.component.scheduler.SchedulerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-scheduler","version":"4.8.1","scheme":"scheduler","extendsScheme":"","syntax":"scheduler:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":false},"headers":{"CamelMessageTimestamp":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message","constantName":"org.apache.camel.component.scheduler.SchedulerConstants#MESSAGE_TIMESTAMP"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the scheduler"},"includeMetadata":{"index":1,"kind":"parameter","displayName":"Include Metadata","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to include metadata in the exchange such as fired time, timer name, timer count etc."},"sendEmptyMessageWhenIdle":{"index":2,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":6,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"synchronous":{"index":7,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"backoffErrorThreshold":{"index":8,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":9,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":10,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":11,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":12,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":13,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"scheduler","label":"scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Number of core threads in the thread pool used by the scheduling thread pool. Is by default using a single thread"},"repeatCount":{"index":15,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":16,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":17,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":18,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":19,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":20,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":21,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":22,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} +{"component":{"kind":"component","name":"scheduler","title":"Scheduler","description":"Generate messages in specified intervals using java.util.concurrent.ScheduledExecutorService.","deprecated":false,"firstVersion":"2.15.0","label":"core,scheduling","javaType":"org.apache.camel.component.scheduler.SchedulerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-scheduler","version":"4.8.2","scheme":"scheduler","extendsScheme":"","syntax":"scheduler:name","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":false},"headers":{"CamelMessageTimestamp":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message","constantName":"org.apache.camel.component.scheduler.SchedulerConstants#MESSAGE_TIMESTAMP"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the scheduler"},"includeMetadata":{"index":1,"kind":"parameter","displayName":"Include Metadata","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to include metadata in the exchange such as fired time, timer name, timer count etc."},"sendEmptyMessageWhenIdle":{"index":2,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":6,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"synchronous":{"index":7,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"backoffErrorThreshold":{"index":8,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":9,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":10,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":11,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":12,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":13,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"poolSize":{"index":14,"kind":"parameter","displayName":"Pool Size","group":"scheduler","label":"scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Number of core threads in the thread pool used by the scheduling thread pool. Is by default using a single thread"},"repeatCount":{"index":15,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":16,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":17,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":18,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":19,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":20,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":21,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":22,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} , -{"component":{"kind":"component","name":"schematron","title":"Schematron","description":"Validate XML payload using the Schematron Library.","deprecated":false,"firstVersion":"2.15.0","label":"validation","javaType":"org.apache.camel.component.schematron.SchematronComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-schematron","version":"4.8.1","scheme":"schematron","extendsScheme":"","syntax":"schematron:path","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"path":{"index":0,"kind":"path","displayName":"Path","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"The path to the schematron rules file. Can either be in class path or location in the file system."},"abort":{"index":1,"kind":"parameter","displayName":"Abort","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Flag to abort the route and throw a schematron validation exception."},"rules":{"index":2,"kind":"parameter","displayName":"Rules","group":"producer","label":"","required":false,"type":"object","javaType":"javax.xml.transform.Templates","deprecated":false,"autowired":false,"secret":false,"description":"To use the given schematron rules instead of loading from the path"},"lazyStartProducer":{"index":3,"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."},"uriResolver":{"index":4,"kind":"parameter","displayName":"Uri Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.URIResolver","deprecated":false,"autowired":false,"secret":false,"description":"Set the URIResolver to be used for resolving schematron includes in the rules file."}}} +{"component":{"kind":"component","name":"schematron","title":"Schematron","description":"Validate XML payload using the Schematron Library.","deprecated":false,"firstVersion":"2.15.0","label":"validation","javaType":"org.apache.camel.component.schematron.SchematronComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-schematron","version":"4.8.2","scheme":"schematron","extendsScheme":"","syntax":"schematron:path","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"path":{"index":0,"kind":"path","displayName":"Path","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"The path to the schematron rules file. Can either be in class path or location in the file system."},"abort":{"index":1,"kind":"parameter","displayName":"Abort","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Flag to abort the route and throw a schematron validation exception."},"rules":{"index":2,"kind":"parameter","displayName":"Rules","group":"producer","label":"","required":false,"type":"object","javaType":"javax.xml.transform.Templates","deprecated":false,"autowired":false,"secret":false,"description":"To use the given schematron rules instead of loading from the path"},"lazyStartProducer":{"index":3,"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."},"uriResolver":{"index":4,"kind":"parameter","displayName":"Uri Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.URIResolver","deprecated":false,"autowired":false,"secret":false,"description":"Set the URIResolver to be used for resolving schematron includes in the rules file."}}} , -{"component":{"kind":"component","name":"scp","title":"SCP","description":"Copy files to/from remote hosts using the secure copy protocol (SCP).","deprecated":false,"firstVersion":"2.10.0","label":"file","javaType":"org.apache.camel.component.scp.ScpComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jsch","version":"4.8.1","scheme":"scp","extendsScheme":"ftp","syntax":"scp:host:port/directoryName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Hostname of the FTP server"},"port":{"index":1,"kind":"path","displayName":"Port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Port of the FTP server"},"directoryName":{"index":2,"kind":"path","displayName":"Directory Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"The starting directory"},"chmod":{"index":3,"kind":"parameter","displayName":"Chmod","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"664","configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Allows you to set chmod on the stored file. For example chmod=664."},"disconnect":{"index":4,"kind":"parameter","displayName":"Disconnect","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead."},"checksumFileAlgorithm":{"index":5,"kind":"parameter","displayName":"Checksum File Algorithm","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["MD2","MD5","SHA_1","SHA_224","SHA_256","SHA_384","SHA_512","SHA_512_224","SHA_512_256","SHA3_224","SHA3_256","SHA3_384","SHA3_512"],"deprecated":false,"autowired":false,"secret":false,"description":"If provided, then Camel will write a checksum file when the original file has been written. The checksum file will contain the checksum created with the provided algorithm for the original file. The checksum file will always be written in the same folder as the original file."},"fileName":{"index":6,"kind":"parameter","displayName":"File Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."},"flatten":{"index":7,"kind":"parameter","displayName":"Flatten","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."},"jailStartingDirectory":{"index":8,"kind":"parameter","displayName":"Jail Starting Directory","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."},"strictHostKeyChecking":{"index":9,"kind":"parameter","displayName":"Strict Host Key Checking","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["no","yes"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"no","configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Sets whether to use strict host key checking. Possible values are: no, yes"},"allowNullBody":{"index":10,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."},"disconnectOnBatchComplete":{"index":11,"kind":"parameter","displayName":"Disconnect On Batch Complete","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server."},"lazyStartProducer":{"index":12,"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."},"moveExistingFileStrategy":{"index":13,"kind":"parameter","displayName":"Move Existing File Strategy","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.strategy.FileMoveExistingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"},"connectTimeout":{"index":14,"kind":"parameter","displayName":"Connect Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH"},"soTimeout":{"index":15,"kind":"parameter","displayName":"So Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"300000","configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance."},"timeout":{"index":16,"kind":"parameter","displayName":"Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Sets the data timeout for waiting for reply Used only by FTPClient"},"knownHostsFile":{"index":17,"kind":"parameter","displayName":"Known Hosts File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"supportFileReference":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Sets the known_hosts file, so that the jsch endpoint can do host key verification. You can prefix with classpath: to load the file from classpath instead of file system."},"password":{"index":18,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Password to use for login"},"preferredAuthentications":{"index":19,"kind":"parameter","displayName":"Preferred Authentications","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Set a comma separated list of authentications that will be used in order of preference. Possible authentication methods are defined by JCraft JSCH. Some examples include: gssapi-with-mic,publickey,keyboard-interactive,password If not specified the JSCH and/or system defaults will be used."},"privateKeyBytes":{"index":20,"kind":"parameter","displayName":"Private Key Bytes","group":"security","label":"security","required":false,"type":"string","javaType":"byte[]","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Set the private key bytes to that the endpoint can do private key verification. This must be used only if privateKeyFile wasn't set. Otherwise the file will have the priority."},"privateKeyFile":{"index":21,"kind":"parameter","displayName":"Private Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Set the private key file to that the endpoint can do private key verification. You can prefix with classpath: to load the file from classpath instead of file system."},"privateKeyFilePassphrase":{"index":22,"kind":"parameter","displayName":"Private Key File Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Set the private key file passphrase to that the endpoint can do private key verification."},"username":{"index":23,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Username to use for login"},"useUserKnownHostsFile":{"index":24,"kind":"parameter","displayName":"Use User Known Hosts File","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"If knownHostFile has not been explicit configured, then use the host file from System.getProperty(user.home) /.ssh/known_hosts"},"ciphers":{"index":25,"kind":"parameter","displayName":"Ciphers","group":"security (advanced)","label":"security,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: aes128-ctr,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,aes192-cbc,aes256-cbc. If not specified the default list from JSCH will be used."}}} +{"component":{"kind":"component","name":"scp","title":"SCP","description":"Copy files to/from remote hosts using the secure copy protocol (SCP).","deprecated":false,"firstVersion":"2.10.0","label":"file","javaType":"org.apache.camel.component.scp.ScpComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jsch","version":"4.8.2","scheme":"scp","extendsScheme":"ftp","syntax":"scp:host:port/directoryName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Hostname of the FTP server"},"port":{"index":1,"kind":"path","displayName":"Port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Port of the FTP server"},"directoryName":{"index":2,"kind":"path","displayName":"Directory Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"The starting directory"},"chmod":{"index":3,"kind":"parameter","displayName":"Chmod","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"664","configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Allows you to set chmod on the stored file. For example chmod=664."},"disconnect":{"index":4,"kind":"parameter","displayName":"Disconnect","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead."},"checksumFileAlgorithm":{"index":5,"kind":"parameter","displayName":"Checksum File Algorithm","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["MD2","MD5","SHA_1","SHA_224","SHA_256","SHA_384","SHA_512","SHA_512_224","SHA_512_256","SHA3_224","SHA3_256","SHA3_384","SHA3_512"],"deprecated":false,"autowired":false,"secret":false,"description":"If provided, then Camel will write a checksum file when the original file has been written. The checksum file will contain the checksum created with the provided algorithm for the original file. The checksum file will always be written in the same folder as the original file."},"fileName":{"index":6,"kind":"parameter","displayName":"File Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."},"flatten":{"index":7,"kind":"parameter","displayName":"Flatten","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."},"jailStartingDirectory":{"index":8,"kind":"parameter","displayName":"Jail Starting Directory","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."},"strictHostKeyChecking":{"index":9,"kind":"parameter","displayName":"Strict Host Key Checking","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["no","yes"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"no","configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Sets whether to use strict host key checking. Possible values are: no, yes"},"allowNullBody":{"index":10,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."},"disconnectOnBatchComplete":{"index":11,"kind":"parameter","displayName":"Disconnect On Batch Complete","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server."},"lazyStartProducer":{"index":12,"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."},"moveExistingFileStrategy":{"index":13,"kind":"parameter","displayName":"Move Existing File Strategy","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.strategy.FileMoveExistingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"},"connectTimeout":{"index":14,"kind":"parameter","displayName":"Connect Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH"},"soTimeout":{"index":15,"kind":"parameter","displayName":"So Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"300000","configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance."},"timeout":{"index":16,"kind":"parameter","displayName":"Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Sets the data timeout for waiting for reply Used only by FTPClient"},"knownHostsFile":{"index":17,"kind":"parameter","displayName":"Known Hosts File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"supportFileReference":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Sets the known_hosts file, so that the jsch endpoint can do host key verification. You can prefix with classpath: to load the file from classpath instead of file system."},"password":{"index":18,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Password to use for login"},"preferredAuthentications":{"index":19,"kind":"parameter","displayName":"Preferred Authentications","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Set a comma separated list of authentications that will be used in order of preference. Possible authentication methods are defined by JCraft JSCH. Some examples include: gssapi-with-mic,publickey,keyboard-interactive,password If not specified the JSCH and/or system defaults will be used."},"privateKeyBytes":{"index":20,"kind":"parameter","displayName":"Private Key Bytes","group":"security","label":"security","required":false,"type":"string","javaType":"byte[]","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Set the private key bytes to that the endpoint can do private key verification. This must be used only if privateKeyFile wasn't set. Otherwise the file will have the priority."},"privateKeyFile":{"index":21,"kind":"parameter","displayName":"Private Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Set the private key file to that the endpoint can do private key verification. You can prefix with classpath: to load the file from classpath instead of file system."},"privateKeyFilePassphrase":{"index":22,"kind":"parameter","displayName":"Private Key File Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Set the private key file passphrase to that the endpoint can do private key verification."},"username":{"index":23,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Username to use for login"},"useUserKnownHostsFile":{"index":24,"kind":"parameter","displayName":"Use User Known Hosts File","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"If knownHostFile has not been explicit configured, then use the host file from System.getProperty(user.home) /.ssh/known_hosts"},"ciphers":{"index":25,"kind":"parameter","displayName":"Ciphers","group":"security (advanced)","label":"security,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.scp.ScpConfiguration","configurationField":"configuration","description":"Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: aes128-ctr,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,aes192-cbc,aes256-cbc. If not specified the default list from JSCH will be used."}}} , -{"component":{"kind":"component","name":"seda","title":"SEDA","description":"Asynchronously call another endpoint from any Camel Context in the same JVM.","deprecated":false,"firstVersion":"1.1.0","label":"core,messaging","javaType":"org.apache.camel.component.seda.SedaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-seda","version":"4.8.1","scheme":"seda","extendsScheme":"","syntax":"seda:name","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of queue"},"size":{"index":1,"kind":"parameter","displayName":"Size","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"The maximum capacity of the SEDA queue (i.e., the number of messages it can hold). Will by default use the defaultSize set on the SEDA component."},"concurrentConsumers":{"index":2,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Number of concurrent threads processing exchanges."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"limitConcurrentConsumers":{"index":6,"kind":"parameter","displayName":"Limit Concurrent Consumers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to limit the number of concurrentConsumers to the maximum of 500. By default, an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off."},"multipleConsumers":{"index":7,"kind":"parameter","displayName":"Multiple Consumers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether multiple consumers are allowed. If enabled, you can use SEDA for Publish-Subscribe messaging. That is, you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint."},"pollTimeout":{"index":8,"kind":"parameter","displayName":"Poll Timeout","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"The timeout (in milliseconds) used when polling. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."},"purgeWhenStopping":{"index":9,"kind":"parameter","displayName":"Purge When Stopping","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to purge the task queue when stopping the consumer/route. This allows to stop faster, as any pending messages on the queue is discarded."},"blockWhenFull":{"index":10,"kind":"parameter","displayName":"Block When Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will instead block and wait until the message can be accepted."},"discardIfNoConsumers":{"index":11,"kind":"parameter","displayName":"Discard If No Consumers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should discard the message (do not add the message to the queue), when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time."},"discardWhenFull":{"index":12,"kind":"parameter","displayName":"Discard When Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a thread that sends messages to a full SEDA queue will be discarded. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will give up sending and continue, meaning that the message was not sent to the SEDA queue."},"failIfNoConsumers":{"index":13,"kind":"parameter","displayName":"Fail If No Consumers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should fail by throwing an exception, when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time."},"offerTimeout":{"index":14,"kind":"parameter","displayName":"Offer Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Offer timeout (in milliseconds) can be added to the block case when queue is full. You can disable timeout by using 0 or a negative value."},"timeout":{"index":15,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value."},"waitForTaskToComplete":{"index":16,"kind":"parameter","displayName":"Wait For Task To Complete","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.WaitForTaskToComplete","enum":["Never","IfReplyExpected","Always"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"IfReplyExpected","description":"Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based. The default option is IfReplyExpected."},"lazyStartProducer":{"index":17,"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."},"queue":{"index":18,"kind":"parameter","displayName":"Queue","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.concurrent.BlockingQueue","deprecated":false,"autowired":false,"secret":false,"description":"Define the queue instance which will be used by the endpoint"}}} +{"component":{"kind":"component","name":"seda","title":"SEDA","description":"Asynchronously call another endpoint from any Camel Context in the same JVM.","deprecated":false,"firstVersion":"1.1.0","label":"core,messaging","javaType":"org.apache.camel.component.seda.SedaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-seda","version":"4.8.2","scheme":"seda","extendsScheme":"","syntax":"seda:name","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of queue"},"size":{"index":1,"kind":"parameter","displayName":"Size","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"The maximum capacity of the SEDA queue (i.e., the number of messages it can hold). Will by default use the defaultSize set on the SEDA component."},"concurrentConsumers":{"index":2,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Number of concurrent threads processing exchanges."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"limitConcurrentConsumers":{"index":6,"kind":"parameter","displayName":"Limit Concurrent Consumers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to limit the number of concurrentConsumers to the maximum of 500. By default, an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off."},"multipleConsumers":{"index":7,"kind":"parameter","displayName":"Multiple Consumers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether multiple consumers are allowed. If enabled, you can use SEDA for Publish-Subscribe messaging. That is, you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint."},"pollTimeout":{"index":8,"kind":"parameter","displayName":"Poll Timeout","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"The timeout (in milliseconds) used when polling. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."},"purgeWhenStopping":{"index":9,"kind":"parameter","displayName":"Purge When Stopping","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to purge the task queue when stopping the consumer/route. This allows to stop faster, as any pending messages on the queue is discarded."},"blockWhenFull":{"index":10,"kind":"parameter","displayName":"Block When Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will instead block and wait until the message can be accepted."},"discardIfNoConsumers":{"index":11,"kind":"parameter","displayName":"Discard If No Consumers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should discard the message (do not add the message to the queue), when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time."},"discardWhenFull":{"index":12,"kind":"parameter","displayName":"Discard When Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a thread that sends messages to a full SEDA queue will be discarded. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will give up sending and continue, meaning that the message was not sent to the SEDA queue."},"failIfNoConsumers":{"index":13,"kind":"parameter","displayName":"Fail If No Consumers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should fail by throwing an exception, when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time."},"offerTimeout":{"index":14,"kind":"parameter","displayName":"Offer Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Offer timeout (in milliseconds) can be added to the block case when queue is full. You can disable timeout by using 0 or a negative value."},"timeout":{"index":15,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value."},"waitForTaskToComplete":{"index":16,"kind":"parameter","displayName":"Wait For Task To Complete","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.WaitForTaskToComplete","enum":["Never","IfReplyExpected","Always"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"IfReplyExpected","description":"Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based. The default option is IfReplyExpected."},"lazyStartProducer":{"index":17,"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."},"queue":{"index":18,"kind":"parameter","displayName":"Queue","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.concurrent.BlockingQueue","deprecated":false,"autowired":false,"secret":false,"description":"Define the queue instance which will be used by the endpoint"}}} , -{"component":{"kind":"component","name":"service","title":"Service","description":"Register a Camel endpoint to a Service Registry (such as Consul, Etcd) and delegate to it.","deprecated":false,"firstVersion":"2.22.0","label":"cloud","javaType":"org.apache.camel.component.service.ServiceComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-service","version":"4.8.1","scheme":"service","extendsScheme":"","syntax":"service:delegateUri","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":true},"properties":{"delegateUri":{"index":0,"kind":"path","displayName":"Delegate Uri","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The endpoint uri to expose as service"},"bridgeErrorHandler":{"index":1,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":2,"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":{"index":3,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} +{"component":{"kind":"component","name":"service","title":"Service","description":"Register a Camel endpoint to a Service Registry (such as Consul, Etcd) and delegate to it.","deprecated":false,"firstVersion":"2.22.0","label":"cloud","javaType":"org.apache.camel.component.service.ServiceComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-service","version":"4.8.2","scheme":"service","extendsScheme":"","syntax":"service:delegateUri","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":true},"properties":{"delegateUri":{"index":0,"kind":"path","displayName":"Delegate Uri","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The endpoint uri to expose as service"},"bridgeErrorHandler":{"index":1,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":2,"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":{"index":3,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} , -{"component":{"kind":"component","name":"servicenow","title":"ServiceNow","description":"Interact with ServiceNow via its REST API.","deprecated":false,"firstVersion":"2.18.0","label":"api,cloud,management","javaType":"org.apache.camel.component.servicenow.ServiceNowComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-servicenow","version":"4.8.1","scheme":"servicenow","extendsScheme":"","syntax":"servicenow:instanceName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"CamelServiceNowResource":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resource to access","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#RESOURCE"},"CamelServiceNowAction":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to perform","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#ACTION"},"CamelServiceNowActionSubject":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action subject","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#ACTION_SUBJECT"},"CamelServiceNowModel":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data model","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#MODEL"},"CamelServiceNowRequestModel":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request data model","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#REQUEST_MODEL"},"CamelServiceNowResponseModel":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response data model","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#RESPONSE_MODEL"},"CamelServiceNowContentType":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#CONTENT_TYPE"},"CamelServiceNowContentMeta":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content meta","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#CONTENT_META"},"CamelServiceNowResponseMeta":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response meta","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#RESPONSE_META"},"CamelServiceNowApiVersion":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The REST API version","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#API_VERSION"},"CamelServiceNowResponseType":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the response","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#RESPONSE_TYPE"},"CamelServiceNowRetrieveTargetRecord":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to retrieve the target record.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#RETRIEVE_TARGET_RECORD"},"CamelServiceNowTable":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The default table","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_TABLE_NAME"},"CamelServiceNowSysId":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys id","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_SYS_ID"},"CamelServiceNowUserSysId":{"index":14,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user sys id","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_USER_SYS_ID"},"CamelServiceNowUserId":{"index":15,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user id","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_USER_ID"},"CamelServiceNowCartItemId":{"index":16,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cart item id","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_CART_ITEM_ID"},"CamelServiceNowFileName":{"index":17,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The file name","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_FILE_NAME"},"CamelServiceNowTableSysId":{"index":18,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The table sys id","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_TABLE_SYS_ID"},"CamelServiceNowEncryptionContext":{"index":19,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The encryption context","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_ENCRYPTION_CONTEXT"},"CamelServiceNowCategory":{"index":20,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param category","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_CATEGORY"},"CamelServiceNowType":{"index":21,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param type","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_TYPE"},"CamelServiceNowCatalog":{"index":22,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param catalog","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_CATALOG"},"CamelServiceNowQuery":{"index":23,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param query","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_QUERY"},"CamelServiceNowDisplayValue":{"index":24,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Return the display value (true), actual value (false), or both (all) for reference fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_DISPLAY_VALUE"},"CamelServiceNowInputDisplayValue":{"index":25,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"True to set raw value of input fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_INPUT_DISPLAY_VALUE"},"CamelServiceNowExcludeReferenceLink":{"index":26,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"True to exclude Table API links for reference fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_EXCLUDE_REFERENCE_LINK"},"CamelServiceNowFields":{"index":27,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_FIELDS"},"CamelServiceNowLimit":{"index":28,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param limit","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_LIMIT"},"CamelServiceNowText":{"index":29,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param text","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_TEXT"},"CamelServiceNowOffset":{"index":30,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param offset","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_OFFSET"},"CamelServiceNowView":{"index":31,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param view","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_VIEW"},"CamelServiceNowSuppressAutoSysField":{"index":32,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"True to suppress auto generation of system fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_SUPPRESS_AUTO_SYS_FIELD"},"CamelServiceNowSuppressPaginationHeader":{"index":33,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_SUPPRESS_PAGINATION_HEADER"},"CamelServiceNowMinFields":{"index":34,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param min fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_MIN_FIELDS"},"CamelServiceNowMaxFields":{"index":35,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param max fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_MAX_FIELDS"},"CamelServiceNowSumFields":{"index":36,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param sum fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_SUM_FIELDS"},"CamelServiceNowAvgFields":{"index":37,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param avg fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_AVG_FIELDS"},"CamelServiceNowCount":{"index":38,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param count","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_COUNT"},"CamelServiceNowGroupBy":{"index":39,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param group by","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_GROUP_BY"},"CamelServiceNowOrderBy":{"index":40,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param order by","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_ORDER_BY"},"CamelServiceNowHaving":{"index":41,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param having","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_HAVING"},"CamelServiceNowUUID":{"index":42,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param UUID","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_UUID"},"CamelServiceNowBreakdown":{"index":43,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param breakdown","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_BREAKDOWN"},"CamelServiceNowIncludeScores":{"index":44,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to return all scores for a scorecard. If a value is not specified, this parameter defaults to false and returns only the most recent score value.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_INCLUDE_SCORES"},"CamelServiceNowIncludeScoreNotes":{"index":45,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_INCLUDE_SCORE_NOTES"},"CamelServiceNowIncludeAggregates":{"index":46,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to always return all available aggregates for an indicator, including when an aggregate has already been applied. If a value is not specified, this parameter defaults to false and returns no aggregates.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_INCLUDE_AGGREGATES"},"CamelServiceNowIncludeAvailableBreakdowns":{"index":47,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to return all available breakdowns for an indicator. If a value is not specified, this parameter defaults to false and returns no breakdowns.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_INCLUDE_AVAILABLE_BREAKDOWNS"},"CamelServiceNowIncludeAvailableAggregates":{"index":48,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to return all available aggregates for an indicator when no aggregate has been applied. If a value is not specified, this parameter defaults to false and returns no aggregates.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_INCLUDE_AVAILABLE_AGGREGATES"},"CamelServiceNowFavorites":{"index":49,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to return only scorecards that are favorites of the querying user.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_FAVORITES"},"CamelServiceNowKey":{"index":50,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to return only scorecards for key indicators.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_KEY"},"CamelServiceNowTarget":{"index":51,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to return only scorecards that have a target.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_TARGET"},"CamelServiceNowDisplay":{"index":52,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"true","description":"Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_DISPLAY"},"CamelServiceNowPerPage":{"index":53,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"10","description":"Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_PER_PAGE"},"CamelServiceNowSortBy":{"index":54,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specify the value to use when sorting results. By default, queries sort records by value.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_SORT_BY"},"CamelServiceNowSortDir":{"index":55,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specify the sort direction, ascending or descending. By default, queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_SORT_DIR"},"CamelServiceNowContains":{"index":56,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param contains.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_CONTAINS"},"CamelServiceNowTags":{"index":57,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param tags.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_TAGS"},"CamelServiceNowPage":{"index":58,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param page.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_PAGE"},"CamelServiceNowElementsFilter":{"index":59,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param elements filter.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_ELEMENTS_FILTER"},"CamelServiceNowBreakdownRelation":{"index":60,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param breakdown relation.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_BREAKDOWN_RELATION"},"CamelServiceNowDataSource":{"index":61,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param data source.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_DATA_SOURCE"},"CamelServiceNowTopLevelOnly":{"index":62,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets only those categories whose parent is a catalog.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_TOP_LEVEL_ONLY"}},"properties":{"instanceName":{"index":0,"kind":"path","displayName":"Instance Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ServiceNow instance name"},"display":{"index":1,"kind":"parameter","displayName":"Display","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["false","true","all"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value. This parameter is true by default."},"displayValue":{"index":2,"kind":"parameter","displayName":"Display Value","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["false","true","all"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Return the display value (true), actual value (false), or both (all) for reference fields (default: false)"},"excludeReferenceLink":{"index":3,"kind":"parameter","displayName":"Exclude Reference Link","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"True to exclude Table API links for reference fields (default: false)"},"favorites":{"index":4,"kind":"parameter","displayName":"Favorites","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return only scorecards that are favorites of the querying user."},"includeAggregates":{"index":5,"kind":"parameter","displayName":"Include Aggregates","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to always return all available aggregates for an indicator, including when an aggregate has already been applied. If a value is not specified, this parameter defaults to false and returns no aggregates."},"includeAvailableAggregates":{"index":6,"kind":"parameter","displayName":"Include Available Aggregates","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return all available aggregates for an indicator when no aggregate has been applied. If a value is not specified, this parameter defaults to false and returns no aggregates."},"includeAvailableBreakdowns":{"index":7,"kind":"parameter","displayName":"Include Available Breakdowns","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return all available breakdowns for an indicator. If a value is not specified, this parameter defaults to false and returns no breakdowns."},"includeScoreNotes":{"index":8,"kind":"parameter","displayName":"Include Score Notes","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added."},"includeScores":{"index":9,"kind":"parameter","displayName":"Include Scores","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return all scores for a scorecard. If a value is not specified, this parameter defaults to false and returns only the most recent score value."},"inputDisplayValue":{"index":10,"kind":"parameter","displayName":"Input Display Value","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"True to set raw value of input fields (default: false)"},"key":{"index":11,"kind":"parameter","displayName":"Key","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return only scorecards for key indicators."},"models":{"index":12,"kind":"parameter","displayName":"Models","group":"producer","label":"","required":false,"type":"object","javaType":"java.util.Map>","prefix":"model.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Defines both request and response models"},"perPage":{"index":13,"kind":"parameter","displayName":"Per Page","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100."},"release":{"index":14,"kind":"parameter","displayName":"Release","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.servicenow.ServiceNowRelease","enum":["FUJI","GENEVA","HELSINKI"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HELSINKI","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The ServiceNow release to target, default to Helsinki See https://docs.servicenow.com"},"requestModels":{"index":15,"kind":"parameter","displayName":"Request Models","group":"producer","label":"","required":false,"type":"object","javaType":"java.util.Map>","prefix":"request-model.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Defines the request model"},"resource":{"index":16,"kind":"parameter","displayName":"Resource","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The default resource, can be overridden by header CamelServiceNowResource"},"responseModels":{"index":17,"kind":"parameter","displayName":"Response Models","group":"producer","label":"","required":false,"type":"object","javaType":"java.util.Map>","prefix":"response-model.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Defines the response model"},"sortBy":{"index":18,"kind":"parameter","displayName":"Sort By","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["value","change","changeperc","gap","gapperc","duedate","name","order","default","group","indicator_group","frequency","target","date","trend","bullet","direction"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Specify the value to use when sorting results. By default, queries sort records by value."},"sortDir":{"index":19,"kind":"parameter","displayName":"Sort Dir","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["asc","desc"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Specify the sort direction, ascending or descending. By default, queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order."},"suppressAutoSysField":{"index":20,"kind":"parameter","displayName":"Suppress Auto Sys Field","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"True to suppress auto generation of system fields (default: false)"},"suppressPaginationHeader":{"index":21,"kind":"parameter","displayName":"Suppress Pagination Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit"},"table":{"index":22,"kind":"parameter","displayName":"Table","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The default table, can be overridden by header CamelServiceNowTable"},"target":{"index":23,"kind":"parameter","displayName":"Target","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return only scorecards that have a target."},"topLevelOnly":{"index":24,"kind":"parameter","displayName":"Top Level Only","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Gets only those categories whose parent is a catalog."},"lazyStartProducer":{"index":25,"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."},"apiVersion":{"index":26,"kind":"parameter","displayName":"Api Version","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The ServiceNow REST API version, default latest"},"dateFormat":{"index":27,"kind":"parameter","displayName":"Date Format","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"yyyy-MM-dd","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The date format used for Json serialization/deserialization"},"dateTimeFormat":{"index":28,"kind":"parameter","displayName":"Date Time Format","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"yyyy-MM-dd HH:mm:ss","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The date-time format used for Json serialization/deserialization"},"httpClientPolicy":{"index":29,"kind":"parameter","displayName":"Http Client Policy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.cxf.transports.http.configuration.HTTPClientPolicy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"To configure http-client"},"mapper":{"index":30,"kind":"parameter","displayName":"Mapper","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.fasterxml.jackson.databind.ObjectMapper","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Sets Jackson's ObjectMapper to use for request/reply"},"proxyAuthorizationPolicy":{"index":31,"kind":"parameter","displayName":"Proxy Authorization Policy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.cxf.configuration.security.ProxyAuthorizationPolicy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"To configure proxy authentication"},"retrieveTargetRecordOnImport":{"index":32,"kind":"parameter","displayName":"Retrieve Target Record On Import","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to retrieve the target record when using import set api. The import set result is then replaced by the target record"},"timeFormat":{"index":33,"kind":"parameter","displayName":"Time Format","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"HH:mm:ss","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The time format used for Json serialization/deserialization"},"proxyHost":{"index":34,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The proxy host name"},"proxyPort":{"index":35,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The proxy port number"},"apiUrl":{"index":36,"kind":"parameter","displayName":"Api Url","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The ServiceNow REST API url"},"oauthClientId":{"index":37,"kind":"parameter","displayName":"Oauth Client Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"OAuth2 ClientID"},"oauthClientSecret":{"index":38,"kind":"parameter","displayName":"Oauth Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"OAuth2 ClientSecret"},"oauthTokenUrl":{"index":39,"kind":"parameter","displayName":"Oauth Token Url","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"OAuth token Url"},"password":{"index":40,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"ServiceNow account password, MUST be provided"},"proxyPassword":{"index":41,"kind":"parameter","displayName":"Proxy Password","group":"security","label":"proxy,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Password for proxy authentication"},"proxyUserName":{"index":42,"kind":"parameter","displayName":"Proxy User Name","group":"security","label":"proxy,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Username for proxy authentication"},"sslContextParameters":{"index":43,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html"},"userName":{"index":44,"kind":"parameter","displayName":"User Name","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"ServiceNow user account name, MUST be provided"}}} +{"component":{"kind":"component","name":"servicenow","title":"ServiceNow","description":"Interact with ServiceNow via its REST API.","deprecated":false,"firstVersion":"2.18.0","label":"api,cloud,management","javaType":"org.apache.camel.component.servicenow.ServiceNowComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-servicenow","version":"4.8.2","scheme":"servicenow","extendsScheme":"","syntax":"servicenow:instanceName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"CamelServiceNowResource":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resource to access","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#RESOURCE"},"CamelServiceNowAction":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to perform","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#ACTION"},"CamelServiceNowActionSubject":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action subject","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#ACTION_SUBJECT"},"CamelServiceNowModel":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data model","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#MODEL"},"CamelServiceNowRequestModel":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The request data model","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#REQUEST_MODEL"},"CamelServiceNowResponseModel":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response data model","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#RESPONSE_MODEL"},"CamelServiceNowContentType":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#CONTENT_TYPE"},"CamelServiceNowContentMeta":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content meta","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#CONTENT_META"},"CamelServiceNowResponseMeta":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response meta","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#RESPONSE_META"},"CamelServiceNowApiVersion":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The REST API version","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#API_VERSION"},"CamelServiceNowResponseType":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the response","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#RESPONSE_TYPE"},"CamelServiceNowRetrieveTargetRecord":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to retrieve the target record.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#RETRIEVE_TARGET_RECORD"},"CamelServiceNowTable":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The default table","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_TABLE_NAME"},"CamelServiceNowSysId":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys id","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_SYS_ID"},"CamelServiceNowUserSysId":{"index":14,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user sys id","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_USER_SYS_ID"},"CamelServiceNowUserId":{"index":15,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user id","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_USER_ID"},"CamelServiceNowCartItemId":{"index":16,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cart item id","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_CART_ITEM_ID"},"CamelServiceNowFileName":{"index":17,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The file name","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_FILE_NAME"},"CamelServiceNowTableSysId":{"index":18,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The table sys id","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_TABLE_SYS_ID"},"CamelServiceNowEncryptionContext":{"index":19,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The encryption context","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#PARAM_ENCRYPTION_CONTEXT"},"CamelServiceNowCategory":{"index":20,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param category","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_CATEGORY"},"CamelServiceNowType":{"index":21,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param type","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_TYPE"},"CamelServiceNowCatalog":{"index":22,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param catalog","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_CATALOG"},"CamelServiceNowQuery":{"index":23,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param query","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_QUERY"},"CamelServiceNowDisplayValue":{"index":24,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Return the display value (true), actual value (false), or both (all) for reference fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_DISPLAY_VALUE"},"CamelServiceNowInputDisplayValue":{"index":25,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"True to set raw value of input fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_INPUT_DISPLAY_VALUE"},"CamelServiceNowExcludeReferenceLink":{"index":26,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"True to exclude Table API links for reference fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_EXCLUDE_REFERENCE_LINK"},"CamelServiceNowFields":{"index":27,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_FIELDS"},"CamelServiceNowLimit":{"index":28,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param limit","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_LIMIT"},"CamelServiceNowText":{"index":29,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param text","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_TEXT"},"CamelServiceNowOffset":{"index":30,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param offset","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_OFFSET"},"CamelServiceNowView":{"index":31,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param view","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_VIEW"},"CamelServiceNowSuppressAutoSysField":{"index":32,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"True to suppress auto generation of system fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_SUPPRESS_AUTO_SYS_FIELD"},"CamelServiceNowSuppressPaginationHeader":{"index":33,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_SUPPRESS_PAGINATION_HEADER"},"CamelServiceNowMinFields":{"index":34,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param min fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_MIN_FIELDS"},"CamelServiceNowMaxFields":{"index":35,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param max fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_MAX_FIELDS"},"CamelServiceNowSumFields":{"index":36,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param sum fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_SUM_FIELDS"},"CamelServiceNowAvgFields":{"index":37,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param avg fields","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_AVG_FIELDS"},"CamelServiceNowCount":{"index":38,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param count","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_COUNT"},"CamelServiceNowGroupBy":{"index":39,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param group by","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_GROUP_BY"},"CamelServiceNowOrderBy":{"index":40,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param order by","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_ORDER_BY"},"CamelServiceNowHaving":{"index":41,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param having","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_HAVING"},"CamelServiceNowUUID":{"index":42,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param UUID","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_UUID"},"CamelServiceNowBreakdown":{"index":43,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param breakdown","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_BREAKDOWN"},"CamelServiceNowIncludeScores":{"index":44,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to return all scores for a scorecard. If a value is not specified, this parameter defaults to false and returns only the most recent score value.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_INCLUDE_SCORES"},"CamelServiceNowIncludeScoreNotes":{"index":45,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_INCLUDE_SCORE_NOTES"},"CamelServiceNowIncludeAggregates":{"index":46,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to always return all available aggregates for an indicator, including when an aggregate has already been applied. If a value is not specified, this parameter defaults to false and returns no aggregates.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_INCLUDE_AGGREGATES"},"CamelServiceNowIncludeAvailableBreakdowns":{"index":47,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to return all available breakdowns for an indicator. If a value is not specified, this parameter defaults to false and returns no breakdowns.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_INCLUDE_AVAILABLE_BREAKDOWNS"},"CamelServiceNowIncludeAvailableAggregates":{"index":48,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to return all available aggregates for an indicator when no aggregate has been applied. If a value is not specified, this parameter defaults to false and returns no aggregates.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_INCLUDE_AVAILABLE_AGGREGATES"},"CamelServiceNowFavorites":{"index":49,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to return only scorecards that are favorites of the querying user.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_FAVORITES"},"CamelServiceNowKey":{"index":50,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to return only scorecards for key indicators.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_KEY"},"CamelServiceNowTarget":{"index":51,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set this parameter to true to return only scorecards that have a target.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_TARGET"},"CamelServiceNowDisplay":{"index":52,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"true","description":"Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_DISPLAY"},"CamelServiceNowPerPage":{"index":53,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"10","description":"Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_PER_PAGE"},"CamelServiceNowSortBy":{"index":54,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specify the value to use when sorting results. By default, queries sort records by value.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_SORT_BY"},"CamelServiceNowSortDir":{"index":55,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specify the sort direction, ascending or descending. By default, queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_SORT_DIR"},"CamelServiceNowContains":{"index":56,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param contains.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_CONTAINS"},"CamelServiceNowTags":{"index":57,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param tags.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_TAGS"},"CamelServiceNowPage":{"index":58,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param page.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_PAGE"},"CamelServiceNowElementsFilter":{"index":59,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param elements filter.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_ELEMENTS_FILTER"},"CamelServiceNowBreakdownRelation":{"index":60,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param breakdown relation.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_BREAKDOWN_RELATION"},"CamelServiceNowDataSource":{"index":61,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sys param data source.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_DATA_SOURCE"},"CamelServiceNowTopLevelOnly":{"index":62,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets only those categories whose parent is a catalog.","constantName":"org.apache.camel.component.servicenow.ServiceNowConstants#SYSPARM_TOP_LEVEL_ONLY"}},"properties":{"instanceName":{"index":0,"kind":"path","displayName":"Instance Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ServiceNow instance name"},"display":{"index":1,"kind":"parameter","displayName":"Display","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["false","true","all"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value. This parameter is true by default."},"displayValue":{"index":2,"kind":"parameter","displayName":"Display Value","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["false","true","all"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Return the display value (true), actual value (false), or both (all) for reference fields (default: false)"},"excludeReferenceLink":{"index":3,"kind":"parameter","displayName":"Exclude Reference Link","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"True to exclude Table API links for reference fields (default: false)"},"favorites":{"index":4,"kind":"parameter","displayName":"Favorites","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return only scorecards that are favorites of the querying user."},"includeAggregates":{"index":5,"kind":"parameter","displayName":"Include Aggregates","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to always return all available aggregates for an indicator, including when an aggregate has already been applied. If a value is not specified, this parameter defaults to false and returns no aggregates."},"includeAvailableAggregates":{"index":6,"kind":"parameter","displayName":"Include Available Aggregates","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return all available aggregates for an indicator when no aggregate has been applied. If a value is not specified, this parameter defaults to false and returns no aggregates."},"includeAvailableBreakdowns":{"index":7,"kind":"parameter","displayName":"Include Available Breakdowns","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return all available breakdowns for an indicator. If a value is not specified, this parameter defaults to false and returns no breakdowns."},"includeScoreNotes":{"index":8,"kind":"parameter","displayName":"Include Score Notes","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added."},"includeScores":{"index":9,"kind":"parameter","displayName":"Include Scores","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return all scores for a scorecard. If a value is not specified, this parameter defaults to false and returns only the most recent score value."},"inputDisplayValue":{"index":10,"kind":"parameter","displayName":"Input Display Value","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"True to set raw value of input fields (default: false)"},"key":{"index":11,"kind":"parameter","displayName":"Key","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return only scorecards for key indicators."},"models":{"index":12,"kind":"parameter","displayName":"Models","group":"producer","label":"","required":false,"type":"object","javaType":"java.util.Map>","prefix":"model.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Defines both request and response models"},"perPage":{"index":13,"kind":"parameter","displayName":"Per Page","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100."},"release":{"index":14,"kind":"parameter","displayName":"Release","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.servicenow.ServiceNowRelease","enum":["FUJI","GENEVA","HELSINKI"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HELSINKI","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The ServiceNow release to target, default to Helsinki See https://docs.servicenow.com"},"requestModels":{"index":15,"kind":"parameter","displayName":"Request Models","group":"producer","label":"","required":false,"type":"object","javaType":"java.util.Map>","prefix":"request-model.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Defines the request model"},"resource":{"index":16,"kind":"parameter","displayName":"Resource","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The default resource, can be overridden by header CamelServiceNowResource"},"responseModels":{"index":17,"kind":"parameter","displayName":"Response Models","group":"producer","label":"","required":false,"type":"object","javaType":"java.util.Map>","prefix":"response-model.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Defines the response model"},"sortBy":{"index":18,"kind":"parameter","displayName":"Sort By","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["value","change","changeperc","gap","gapperc","duedate","name","order","default","group","indicator_group","frequency","target","date","trend","bullet","direction"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Specify the value to use when sorting results. By default, queries sort records by value."},"sortDir":{"index":19,"kind":"parameter","displayName":"Sort Dir","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["asc","desc"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Specify the sort direction, ascending or descending. By default, queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order."},"suppressAutoSysField":{"index":20,"kind":"parameter","displayName":"Suppress Auto Sys Field","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"True to suppress auto generation of system fields (default: false)"},"suppressPaginationHeader":{"index":21,"kind":"parameter","displayName":"Suppress Pagination Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit"},"table":{"index":22,"kind":"parameter","displayName":"Table","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The default table, can be overridden by header CamelServiceNowTable"},"target":{"index":23,"kind":"parameter","displayName":"Target","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to return only scorecards that have a target."},"topLevelOnly":{"index":24,"kind":"parameter","displayName":"Top Level Only","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Gets only those categories whose parent is a catalog."},"lazyStartProducer":{"index":25,"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."},"apiVersion":{"index":26,"kind":"parameter","displayName":"Api Version","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The ServiceNow REST API version, default latest"},"dateFormat":{"index":27,"kind":"parameter","displayName":"Date Format","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"yyyy-MM-dd","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The date format used for Json serialization/deserialization"},"dateTimeFormat":{"index":28,"kind":"parameter","displayName":"Date Time Format","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"yyyy-MM-dd HH:mm:ss","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The date-time format used for Json serialization/deserialization"},"httpClientPolicy":{"index":29,"kind":"parameter","displayName":"Http Client Policy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.cxf.transports.http.configuration.HTTPClientPolicy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"To configure http-client"},"mapper":{"index":30,"kind":"parameter","displayName":"Mapper","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.fasterxml.jackson.databind.ObjectMapper","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Sets Jackson's ObjectMapper to use for request/reply"},"proxyAuthorizationPolicy":{"index":31,"kind":"parameter","displayName":"Proxy Authorization Policy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.cxf.configuration.security.ProxyAuthorizationPolicy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"To configure proxy authentication"},"retrieveTargetRecordOnImport":{"index":32,"kind":"parameter","displayName":"Retrieve Target Record On Import","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Set this parameter to true to retrieve the target record when using import set api. The import set result is then replaced by the target record"},"timeFormat":{"index":33,"kind":"parameter","displayName":"Time Format","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"HH:mm:ss","configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The time format used for Json serialization/deserialization"},"proxyHost":{"index":34,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The proxy host name"},"proxyPort":{"index":35,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The proxy port number"},"apiUrl":{"index":36,"kind":"parameter","displayName":"Api Url","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"The ServiceNow REST API url"},"oauthClientId":{"index":37,"kind":"parameter","displayName":"Oauth Client Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"OAuth2 ClientID"},"oauthClientSecret":{"index":38,"kind":"parameter","displayName":"Oauth Client Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"OAuth2 ClientSecret"},"oauthTokenUrl":{"index":39,"kind":"parameter","displayName":"Oauth Token Url","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"OAuth token Url"},"password":{"index":40,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"ServiceNow account password, MUST be provided"},"proxyPassword":{"index":41,"kind":"parameter","displayName":"Proxy Password","group":"security","label":"proxy,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Password for proxy authentication"},"proxyUserName":{"index":42,"kind":"parameter","displayName":"Proxy User Name","group":"security","label":"proxy,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"Username for proxy authentication"},"sslContextParameters":{"index":43,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html"},"userName":{"index":44,"kind":"parameter","displayName":"User Name","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.servicenow.ServiceNowConfiguration","configurationField":"configuration","description":"ServiceNow user account name, MUST be provided"}}} , -{"component":{"kind":"component","name":"servlet","title":"Servlet","description":"Serve HTTP requests by a Servlet.","deprecated":false,"firstVersion":"2.0.0","label":"http","javaType":"org.apache.camel.component.servlet.ServletComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-servlet","version":"4.8.1","scheme":"servlet","extendsScheme":"http","syntax":"servlet:contextPath","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"contextPath":{"index":0,"kind":"path","displayName":"Context Path","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The context-path to use"},"disableStreamCache":{"index":1,"kind":"parameter","displayName":"Disable Stream Cache","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The producer (camel-http) will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is (the stream can only be read once) as the message body."},"headerFilterStrategy":{"index":2,"kind":"parameter","displayName":"Header Filter Strategy","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"httpBinding":{"index":3,"kind":"parameter","displayName":"Http Binding","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.http.common.HttpBinding","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpBinding to control the mapping between Camel message and HttpClient."},"chunked":{"index":4,"kind":"parameter","displayName":"Chunked","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response"},"transferException":{"index":5,"kind":"parameter","displayName":"Transfer Exception","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk."},"async":{"index":6,"kind":"parameter","displayName":"Async","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configure the consumer to work in async mode"},"httpMethodRestrict":{"index":7,"kind":"parameter","displayName":"Http Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma."},"logException":{"index":8,"kind":"parameter","displayName":"Log Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side the exception's stack trace will be logged when the exception stack trace is not sent in the response's body."},"matchOnUriPrefix":{"index":9,"kind":"parameter","displayName":"Match On Uri Prefix","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found."},"muteException":{"index":10,"kind":"parameter","displayName":"Mute Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace."},"responseBufferSize":{"index":11,"kind":"parameter","displayName":"Response Buffer Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom buffer size on the jakarta.servlet.ServletResponse."},"servletName":{"index":12,"kind":"parameter","displayName":"Servlet Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelServlet","description":"Name of the servlet to use"},"attachmentMultipartBinding":{"index":13,"kind":"parameter","displayName":"Attachment Multipart Binding","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"eagerCheckContentAvailable":{"index":15,"kind":"parameter","displayName":"Eager Check Content Available","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data."},"exceptionHandler":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"fileNameExtWhitelist":{"index":18,"kind":"parameter","displayName":"File Name Ext Whitelist","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml."},"mapHttpMessageBody":{"index":19,"kind":"parameter","displayName":"Map Http Message Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping."},"mapHttpMessageFormUrlEncodedBody":{"index":20,"kind":"parameter","displayName":"Map Http Message Form Url Encoded Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping."},"mapHttpMessageHeaders":{"index":21,"kind":"parameter","displayName":"Map Http Message Headers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping."},"optionsEnabled":{"index":22,"kind":"parameter","displayName":"Options Enabled","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off."},"traceEnabled":{"index":23,"kind":"parameter","displayName":"Trace Enabled","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off."}}} +{"component":{"kind":"component","name":"servlet","title":"Servlet","description":"Serve HTTP requests by a Servlet.","deprecated":false,"firstVersion":"2.0.0","label":"http","javaType":"org.apache.camel.component.servlet.ServletComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-servlet","version":"4.8.2","scheme":"servlet","extendsScheme":"http","syntax":"servlet:contextPath","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"contextPath":{"index":0,"kind":"path","displayName":"Context Path","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The context-path to use"},"disableStreamCache":{"index":1,"kind":"parameter","displayName":"Disable Stream Cache","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The producer (camel-http) will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is (the stream can only be read once) as the message body."},"headerFilterStrategy":{"index":2,"kind":"parameter","displayName":"Header Filter Strategy","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"httpBinding":{"index":3,"kind":"parameter","displayName":"Http Binding","group":"common (advanced)","label":"common,advanced","required":false,"type":"object","javaType":"org.apache.camel.http.common.HttpBinding","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpBinding to control the mapping between Camel message and HttpClient."},"chunked":{"index":4,"kind":"parameter","displayName":"Chunked","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response"},"transferException":{"index":5,"kind":"parameter","displayName":"Transfer Exception","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk."},"async":{"index":6,"kind":"parameter","displayName":"Async","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Configure the consumer to work in async mode"},"httpMethodRestrict":{"index":7,"kind":"parameter","displayName":"Http Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma."},"logException":{"index":8,"kind":"parameter","displayName":"Log Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side the exception's stack trace will be logged when the exception stack trace is not sent in the response's body."},"matchOnUriPrefix":{"index":9,"kind":"parameter","displayName":"Match On Uri Prefix","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found."},"muteException":{"index":10,"kind":"parameter","displayName":"Mute Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace."},"responseBufferSize":{"index":11,"kind":"parameter","displayName":"Response Buffer Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom buffer size on the jakarta.servlet.ServletResponse."},"servletName":{"index":12,"kind":"parameter","displayName":"Servlet Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelServlet","description":"Name of the servlet to use"},"attachmentMultipartBinding":{"index":13,"kind":"parameter","displayName":"Attachment Multipart Binding","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's."},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"eagerCheckContentAvailable":{"index":15,"kind":"parameter","displayName":"Eager Check Content Available","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data."},"exceptionHandler":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"fileNameExtWhitelist":{"index":18,"kind":"parameter","displayName":"File Name Ext Whitelist","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml."},"mapHttpMessageBody":{"index":19,"kind":"parameter","displayName":"Map Http Message Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping."},"mapHttpMessageFormUrlEncodedBody":{"index":20,"kind":"parameter","displayName":"Map Http Message Form Url Encoded Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping."},"mapHttpMessageHeaders":{"index":21,"kind":"parameter","displayName":"Map Http Message Headers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping."},"optionsEnabled":{"index":22,"kind":"parameter","displayName":"Options Enabled","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off."},"traceEnabled":{"index":23,"kind":"parameter","displayName":"Trace Enabled","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off."}}} , -{"component":{"kind":"component","name":"sftp","title":"SFTP","description":"Upload and download files to/from SFTP servers.","deprecated":false,"firstVersion":"1.1.0","label":"file","javaType":"org.apache.camel.component.file.remote.SftpComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ftp","version":"4.8.1","scheme":"sftp","extendsScheme":"file","syntax":"sftp:host:port/directoryName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelFileLength":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A long value containing the file size.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LENGTH"},"CamelFileLastModified":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Long value containing the last modified timestamp of the file.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LAST_MODIFIED"},"CamelFileName":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the output file name (relative to the endpoint directory) to be used for the output message when sending to the endpoint. If this is not present and no expression either, then a generated message ID is used as the filename instead.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_NAME"},"CamelFileNameOnly":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only the file name (the name with no leading paths).","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_NAME_ONLY"},"CamelFileParent":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent path.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_PARENT"},"CamelRemoteFileInputStream":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.io.InputStream","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote file input stream.","constantName":"org.apache.camel.component.file.remote.FtpConstants#REMOTE_FILE_INPUT_STREAM"},"CamelFileLocalWorkPath":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the local work file, if local work directory is used.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LOCAL_WORK_PATH"},"CamelFtpReplyCode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FTP client reply code","constantName":"org.apache.camel.component.file.remote.FtpConstants#FTP_REPLY_CODE"},"CamelFtpReplyString":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FTP client reply string","constantName":"org.apache.camel.component.file.remote.FtpConstants#FTP_REPLY_STRING"},"CamelFileHost":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote hostname.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_HOST"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Hostname of the FTP server"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Port of the FTP server"},"directoryName":{"index":2,"kind":"path","displayName":"Directory Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"The starting directory"},"binary":{"index":3,"kind":"parameter","displayName":"Binary","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false)."},"charset":{"index":4,"kind":"parameter","displayName":"Charset","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages."},"disconnect":{"index":5,"kind":"parameter","displayName":"Disconnect","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead."},"doneFileName":{"index":6,"kind":"parameter","displayName":"Done File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders."},"fileName":{"index":7,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."},"jschLoggingLevel":{"index":8,"kind":"parameter","displayName":"Jsch Logging Level","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["DEBUG","INFO","WARN","ERROR"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"The logging level to use for JSCH activity logging. As JSCH is verbose at by default at INFO level the threshold is WARN by default."},"passiveMode":{"index":9,"kind":"parameter","displayName":"Passive Mode","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets passive mode connections. Default is active mode connections."},"separator":{"index":10,"kind":"parameter","displayName":"Separator","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator","enum":["UNIX","Windows","Auto"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"UNIX","configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name"},"fastExistsCheck":{"index":11,"kind":"parameter","displayName":"Fast Exists Check","group":"common (advanced)","label":"common,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set this option to be true, camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly, if the option is false, camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files."},"delete":{"index":12,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file will be deleted after it is processed successfully."},"moveFailed":{"index":13,"kind":"parameter","displayName":"Move Failed","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again."},"noop":{"index":14,"kind":"parameter","displayName":"Noop","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again."},"preMove":{"index":15,"kind":"parameter","displayName":"Pre Move","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order."},"preSort":{"index":16,"kind":"parameter","displayName":"Pre Sort","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled."},"recursive":{"index":17,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If a directory, will look for files in all the sub-directories as well."},"sendEmptyMessageWhenIdle":{"index":18,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"streamDownload":{"index":19,"kind":"parameter","displayName":"Stream Download","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the download method to use when not using a local working directory. If set to true, the remote files are streamed to the route as they are read. When set to false, the remote files are loaded into memory before being sent into the route. If enabling this option then you must set stepwise=false as both cannot be enabled at the same time."},"bridgeErrorHandler":{"index":20,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"download":{"index":21,"kind":"parameter","displayName":"Download","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded."},"exceptionHandler":{"index":22,"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":{"index":23,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"ignoreFileNotFoundOrPermissionError":{"index":24,"kind":"parameter","displayName":"Ignore File Not Found Or Permission Error","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exist or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead."},"inProgressRepository":{"index":25,"kind":"parameter","displayName":"In Progress Repository","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."},"localWorkDirectory":{"index":26,"kind":"parameter","displayName":"Local Work Directory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory."},"onCompletionExceptionHandler":{"index":27,"kind":"parameter","displayName":"On Completion Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore."},"pollStrategy":{"index":28,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"processStrategy":{"index":29,"kind":"parameter","displayName":"Process Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileProcessStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply."},"useList":{"index":30,"kind":"parameter","displayName":"Use List","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Whether to allow using LIST command when downloading a file. Default is true. In some use cases you may want to download a specific file and are not allowed to use the LIST command, and therefore you can set this option to false. Notice when using this option, then the specific file to download does not include meta-data information such as file size, timestamp, permissions etc, because those information is only possible to retrieve when LIST command is in use."},"checksumFileAlgorithm":{"index":31,"kind":"parameter","displayName":"Checksum File Algorithm","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["MD2","MD5","SHA_1","SHA_224","SHA_256","SHA_384","SHA_512","SHA_512_224","SHA_512_256","SHA3_224","SHA3_256","SHA3_384","SHA3_512"],"deprecated":false,"autowired":false,"secret":false,"description":"If provided, then Camel will write a checksum file when the original file has been written. The checksum file will contain the checksum created with the provided algorithm for the original file. The checksum file will always be written in the same folder as the original file."},"fileExist":{"index":32,"kind":"parameter","displayName":"File Exist","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExist","enum":["Override","Append","Fail","Ignore","Move","TryRename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Override","description":"What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers."},"flatten":{"index":33,"kind":"parameter","displayName":"Flatten","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."},"jailStartingDirectory":{"index":34,"kind":"parameter","displayName":"Jail Starting Directory","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."},"moveExisting":{"index":35,"kind":"parameter","displayName":"Move Existing","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base."},"tempFileName":{"index":36,"kind":"parameter","displayName":"Temp File Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir."},"tempPrefix":{"index":37,"kind":"parameter","displayName":"Temp Prefix","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files."},"allowNullBody":{"index":38,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."},"chmod":{"index":39,"kind":"parameter","displayName":"Chmod","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Allows you to set chmod on the stored file. For example chmod=640."},"chmodDirectory":{"index":40,"kind":"parameter","displayName":"Chmod Directory","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Allows you to set chmod during path creation. For example chmod=640."},"disconnectOnBatchComplete":{"index":41,"kind":"parameter","displayName":"Disconnect On Batch Complete","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server."},"eagerDeleteTargetFile":{"index":42,"kind":"parameter","displayName":"Eager Delete Target File","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation."},"keepLastModified":{"index":43,"kind":"parameter","displayName":"Keep Last Modified","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers."},"lazyStartProducer":{"index":44,"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."},"moveExistingFileStrategy":{"index":45,"kind":"parameter","displayName":"Move Existing File Strategy","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.strategy.FileMoveExistingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"},"sendNoop":{"index":46,"kind":"parameter","displayName":"Send Noop","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Whether to send a noop command as a pre-write check before uploading files to the FTP server. This is enabled by default as a validation of the connection is still valid, which allows to silently re-connect to be able to upload the file. However if this causes problems, you can turn this option off."},"autoCreate":{"index":47,"kind":"parameter","displayName":"Auto Create","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to."},"bindAddress":{"index":48,"kind":"parameter","displayName":"Bind Address","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Specifies the address of the local interface against which the connection should bind."},"bulkRequests":{"index":49,"kind":"parameter","displayName":"Bulk Requests","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Specifies how many requests may be outstanding at any one time. Increasing this value may slightly improve file transfer speed but will increase memory usage."},"compression":{"index":50,"kind":"parameter","displayName":"Compression","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"To use compression. Specify a level from 1 to 10. Important: You must manually add the needed JSCH zlib JAR to the classpath for compression support."},"connectTimeout":{"index":51,"kind":"parameter","displayName":"Connect Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH"},"existDirCheckUsingLs":{"index":52,"kind":"parameter","displayName":"Exist Dir Check Using Ls","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Whether to check for existing directory using LS command or CD. By default LS is used which is safer as otherwise Camel needs to change the directory back after checking. However LS has been reported to cause a problem on windows system in some situations and therefore you can disable this option to use CD."},"filenameEncoding":{"index":53,"kind":"parameter","displayName":"Filename Encoding","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Encoding to use for FTP client when parsing filenames. By default, UTF-8 is used."},"maximumReconnectAttempts":{"index":54,"kind":"parameter","displayName":"Maximum Reconnect Attempts","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior."},"proxy":{"index":55,"kind":"parameter","displayName":"Proxy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.jcraft.jsch.Proxy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom configured com.jcraft.jsch.Proxy. This proxy is used to consume/send messages from the target SFTP host."},"reconnectDelay":{"index":56,"kind":"parameter","displayName":"Reconnect Delay","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Delay in millis Camel will wait before performing a reconnect attempt."},"serverAliveCountMax":{"index":57,"kind":"parameter","displayName":"Server Alive Count Max","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the number of keep-alive messages which may be sent without receiving any messages back from the server. If this threshold is reached while keep-alive messages are being sent, the connection will be disconnected. The default value is one."},"serverAliveInterval":{"index":58,"kind":"parameter","displayName":"Server Alive Interval","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the interval (millis) to send a keep-alive message. If zero is specified, any keep-alive message must not be sent. The default interval is zero."},"serverMessageLoggingLevel":{"index":59,"kind":"parameter","displayName":"Server Message Logging Level","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"The logging level used for various human intended log messages from the FTP server. This can be used during troubleshooting to raise the logging level and inspect the logs received from the FTP server."},"soTimeout":{"index":60,"kind":"parameter","displayName":"So Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"300000","configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance."},"stepwise":{"index":61,"kind":"parameter","displayName":"Stepwise","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets whether we should stepwise change directories while traversing file structures when downloading files, or as well when uploading a file to a directory. You can disable this if you for example are in a situation where you cannot change directory on the FTP server due security reasons. Stepwise cannot be used together with streamDownload."},"throwExceptionOnConnectFailed":{"index":62,"kind":"parameter","displayName":"Throw Exception On Connect Failed","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method."},"timeout":{"index":63,"kind":"parameter","displayName":"Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the data timeout for waiting for reply Used only by FTPClient"},"antExclude":{"index":64,"kind":"parameter","displayName":"Ant Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format."},"antFilterCaseSensitive":{"index":65,"kind":"parameter","displayName":"Ant Filter Case Sensitive","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets case sensitive flag on ant filter."},"antInclude":{"index":66,"kind":"parameter","displayName":"Ant Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format."},"eagerMaxMessagesPerPoll":{"index":67,"kind":"parameter","displayName":"Eager Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting."},"exclude":{"index":68,"kind":"parameter","displayName":"Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"excludeExt":{"index":69,"kind":"parameter","displayName":"Exclude Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat files, use excludeExt=bak,dat. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"filter":{"index":70,"kind":"parameter","displayName":"Filter","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileFilter","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method."},"filterDirectory":{"index":71,"kind":"parameter","displayName":"Filter Directory","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}"},"filterFile":{"index":72,"kind":"parameter","displayName":"Filter File","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000"},"idempotent":{"index":73,"kind":"parameter","displayName":"Idempotent","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentEager":{"index":74,"kind":"parameter","displayName":"Idempotent Eager","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentKey":{"index":75,"kind":"parameter","displayName":"Idempotent Key","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}"},"idempotentRepository":{"index":76,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true."},"include":{"index":77,"kind":"parameter","displayName":"Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"includeExt":{"index":78,"kind":"parameter","displayName":"Include Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml files, use includeExt=txt,xml. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"maxDepth":{"index":79,"kind":"parameter","displayName":"Max Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"description":"The maximum depth to traverse when recursively processing a directory."},"maxMessagesPerPoll":{"index":80,"kind":"parameter","displayName":"Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards."},"minDepth":{"index":81,"kind":"parameter","displayName":"Min Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory."},"move":{"index":82,"kind":"parameter","displayName":"Move","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done."},"exclusiveReadLockStrategy":{"index":83,"kind":"parameter","displayName":"Exclusive Read Lock Strategy","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation."},"readLock":{"index":84,"kind":"parameter","displayName":"Read Lock","group":"lock","label":"consumer,lock","required":false,"type":"string","javaType":"java.lang.String","enum":["none","markerFile","fileLock","rename","changed","idempotent","idempotent-changed","idempotent-rename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: - none - No read lock is in use - markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component - changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. - fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. - rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. - idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that.Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan."},"readLockCheckInterval":{"index":85,"kind":"parameter","displayName":"Read Lock Check Interval","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"readLockDeleteOrphanLockFiles":{"index":86,"kind":"parameter","displayName":"Read Lock Delete Orphan Lock Files","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory."},"readLockIdempotentReleaseAsync":{"index":87,"kind":"parameter","displayName":"Read Lock Idempotent Release Async","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the delayed release task should be synchronous or asynchronous. See more details at the readLockIdempotentReleaseDelay option."},"readLockIdempotentReleaseAsyncPoolSize":{"index":88,"kind":"parameter","displayName":"Read Lock Idempotent Release Async Pool Size","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of threads in the scheduled thread pool when using asynchronous release tasks. Using a default of 1 core threads should be sufficient in almost all use-cases, only set this to a higher value if either updating the idempotent repository is slow, or there are a lot of files to process. This option is not in-use if you use a shared thread pool by configuring the readLockIdempotentReleaseExecutorService option. See more details at the readLockIdempotentReleaseDelay option."},"readLockIdempotentReleaseDelay":{"index":89,"kind":"parameter","displayName":"Read Lock Idempotent Release Delay","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Whether to delay the release task for a period of millis. This can be used to delay the release tasks to expand the window when a file is regarded as read-locked, in an active/active cluster scenario with a shared idempotent repository, to ensure other nodes cannot potentially scan and acquire the same file, due to race-conditions. By expanding the time-window of the release tasks helps prevents these situations. Note delaying is only needed if you have configured readLockRemoveOnCommit to true."},"readLockIdempotentReleaseExecutorService":{"index":90,"kind":"parameter","displayName":"Read Lock Idempotent Release Executor Service","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom and shared thread pool for asynchronous release tasks. See more details at the readLockIdempotentReleaseDelay option."},"readLockLoggingLevel":{"index":91,"kind":"parameter","displayName":"Read Lock Logging Level","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename."},"readLockMarkerFile":{"index":92,"kind":"parameter","displayName":"Read Lock Marker File","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application."},"readLockMinAge":{"index":93,"kind":"parameter","displayName":"Read Lock Min Age","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age."},"readLockMinLength":{"index":94,"kind":"parameter","displayName":"Read Lock Min Length","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files."},"readLockRemoveOnCommit":{"index":95,"kind":"parameter","displayName":"Read Lock Remove On Commit","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option."},"readLockRemoveOnRollback":{"index":96,"kind":"parameter","displayName":"Read Lock Remove On Rollback","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit)."},"readLockTimeout":{"index":97,"kind":"parameter","displayName":"Read Lock Timeout","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"description":"Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"backoffErrorThreshold":{"index":98,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":99,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":100,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":101,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":102,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":103,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":104,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":105,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":106,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":107,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":108,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":109,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":110,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":111,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"autoCreateKnownHostsFile":{"index":112,"kind":"parameter","displayName":"Auto Create Known Hosts File","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"If knownHostFile does not exist, then attempt to auto-create the path and file (beware that the file will be created by the current user of the running Java process, which may not have file permission)."},"ciphers":{"index":113,"kind":"parameter","displayName":"Ciphers","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: aes128-ctr,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,aes192-cbc,aes256-cbc. If not specified the default list from JSCH will be used."},"keyExchangeProtocols":{"index":114,"kind":"parameter","displayName":"Key Exchange Protocols","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set a comma separated list of key exchange protocols that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: diffie-hellman-group-exchange-sha1,diffie-hellman-group1-sha1,diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521. If not specified the default list from JSCH will be used."},"keyPair":{"index":115,"kind":"parameter","displayName":"Key Pair","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.KeyPair","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets a key pair of the public and private key so to that the SFTP endpoint can do public/private key verification."},"knownHosts":{"index":116,"kind":"parameter","displayName":"Known Hosts","group":"security","label":"security","required":false,"type":"string","javaType":"byte[]","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the known_hosts from the byte array, so that the SFTP endpoint can do host key verification."},"knownHostsFile":{"index":117,"kind":"parameter","displayName":"Known Hosts File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the known_hosts file, so that the SFTP endpoint can do host key verification."},"knownHostsUri":{"index":118,"kind":"parameter","displayName":"Known Hosts Uri","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"supportFileReference":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the known_hosts file (loaded from classpath by default), so that the SFTP endpoint can do host key verification."},"password":{"index":119,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Password to use for login"},"preferredAuthentications":{"index":120,"kind":"parameter","displayName":"Preferred Authentications","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set the preferred authentications which SFTP endpoint will used. Some example include:password,publickey. If not specified the default list from JSCH will be used."},"privateKey":{"index":121,"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"string","javaType":"byte[]","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set the private key as byte so that the SFTP endpoint can do private key verification."},"privateKeyFile":{"index":122,"kind":"parameter","displayName":"Private Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set the private key file so that the SFTP endpoint can do private key verification."},"privateKeyPassphrase":{"index":123,"kind":"parameter","displayName":"Private Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set the private key file passphrase so that the SFTP endpoint can do private key verification."},"privateKeyUri":{"index":124,"kind":"parameter","displayName":"Private Key Uri","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"supportFileReference":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set the private key file (loaded from classpath by default) so that the SFTP endpoint can do private key verification."},"publicKeyAcceptedAlgorithms":{"index":125,"kind":"parameter","displayName":"Public Key Accepted Algorithms","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set a comma separated list of public key accepted algorithms. Some examples include: ssh-dss,ssh-rsa,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521. If not specified the default list from JSCH will be used."},"serverHostKeys":{"index":126,"kind":"parameter","displayName":"Server Host Keys","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set a comma separated list of algorithms supported for the server host key. Some examples include: ssh-dss,ssh-rsa,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521. If not specified the default list from JSCH will be used."},"strictHostKeyChecking":{"index":127,"kind":"parameter","displayName":"Strict Host Key Checking","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","enum":["no","yes"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"no","configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets whether to use strict host key checking."},"username":{"index":128,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Username to use for login"},"useUserKnownHostsFile":{"index":129,"kind":"parameter","displayName":"Use User Known Hosts File","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts"},"shuffle":{"index":130,"kind":"parameter","displayName":"Shuffle","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To shuffle the list of files (sort in random order)"},"sortBy":{"index":131,"kind":"parameter","displayName":"Sort By","group":"sort","label":"consumer,sort","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date."},"sorter":{"index":132,"kind":"parameter","displayName":"Sorter","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"java.util.Comparator>","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable sorter as a java.util.Comparator class."}}} +{"component":{"kind":"component","name":"sftp","title":"SFTP","description":"Upload and download files to/from SFTP servers.","deprecated":false,"firstVersion":"1.1.0","label":"file","javaType":"org.apache.camel.component.file.remote.SftpComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ftp","version":"4.8.2","scheme":"sftp","extendsScheme":"file","syntax":"sftp:host:port/directoryName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelFileLength":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A long value containing the file size.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LENGTH"},"CamelFileLastModified":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Long value containing the last modified timestamp of the file.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LAST_MODIFIED"},"CamelFileName":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the output file name (relative to the endpoint directory) to be used for the output message when sending to the endpoint. If this is not present and no expression either, then a generated message ID is used as the filename instead.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_NAME"},"CamelFileNameOnly":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only the file name (the name with no leading paths).","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_NAME_ONLY"},"CamelFileParent":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent path.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_PARENT"},"CamelRemoteFileInputStream":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.io.InputStream","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote file input stream.","constantName":"org.apache.camel.component.file.remote.FtpConstants#REMOTE_FILE_INPUT_STREAM"},"CamelFileLocalWorkPath":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the local work file, if local work directory is used.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_LOCAL_WORK_PATH"},"CamelFtpReplyCode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FTP client reply code","constantName":"org.apache.camel.component.file.remote.FtpConstants#FTP_REPLY_CODE"},"CamelFtpReplyString":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FTP client reply string","constantName":"org.apache.camel.component.file.remote.FtpConstants#FTP_REPLY_STRING"},"CamelFileHost":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote hostname.","constantName":"org.apache.camel.component.file.remote.FtpConstants#FILE_HOST"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Hostname of the FTP server"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Port of the FTP server"},"directoryName":{"index":2,"kind":"path","displayName":"Directory Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"The starting directory"},"binary":{"index":3,"kind":"parameter","displayName":"Binary","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false)."},"charset":{"index":4,"kind":"parameter","displayName":"Charset","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages."},"disconnect":{"index":5,"kind":"parameter","displayName":"Disconnect","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead."},"doneFileName":{"index":6,"kind":"parameter","displayName":"Done File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders."},"fileName":{"index":7,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."},"jschLoggingLevel":{"index":8,"kind":"parameter","displayName":"Jsch Logging Level","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["DEBUG","INFO","WARN","ERROR"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"The logging level to use for JSCH activity logging. As JSCH is verbose at by default at INFO level the threshold is WARN by default."},"passiveMode":{"index":9,"kind":"parameter","displayName":"Passive Mode","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets passive mode connections. Default is active mode connections."},"separator":{"index":10,"kind":"parameter","displayName":"Separator","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator","enum":["UNIX","Windows","Auto"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"UNIX","configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name"},"fastExistsCheck":{"index":11,"kind":"parameter","displayName":"Fast Exists Check","group":"common (advanced)","label":"common,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set this option to be true, camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly, if the option is false, camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files."},"delete":{"index":12,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file will be deleted after it is processed successfully."},"moveFailed":{"index":13,"kind":"parameter","displayName":"Move Failed","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again."},"noop":{"index":14,"kind":"parameter","displayName":"Noop","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again."},"preMove":{"index":15,"kind":"parameter","displayName":"Pre Move","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order."},"preSort":{"index":16,"kind":"parameter","displayName":"Pre Sort","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled."},"recursive":{"index":17,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If a directory, will look for files in all the sub-directories as well."},"sendEmptyMessageWhenIdle":{"index":18,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"streamDownload":{"index":19,"kind":"parameter","displayName":"Stream Download","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the download method to use when not using a local working directory. If set to true, the remote files are streamed to the route as they are read. When set to false, the remote files are loaded into memory before being sent into the route. If enabling this option then you must set stepwise=false as both cannot be enabled at the same time."},"bridgeErrorHandler":{"index":20,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"download":{"index":21,"kind":"parameter","displayName":"Download","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded."},"exceptionHandler":{"index":22,"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":{"index":23,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"ignoreFileNotFoundOrPermissionError":{"index":24,"kind":"parameter","displayName":"Ignore File Not Found Or Permission Error","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exist or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead."},"inProgressRepository":{"index":25,"kind":"parameter","displayName":"In Progress Repository","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."},"localWorkDirectory":{"index":26,"kind":"parameter","displayName":"Local Work Directory","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory."},"onCompletionExceptionHandler":{"index":27,"kind":"parameter","displayName":"On Completion Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore."},"pollStrategy":{"index":28,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"processStrategy":{"index":29,"kind":"parameter","displayName":"Process Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileProcessStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply."},"useList":{"index":30,"kind":"parameter","displayName":"Use List","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Whether to allow using LIST command when downloading a file. Default is true. In some use cases you may want to download a specific file and are not allowed to use the LIST command, and therefore you can set this option to false. Notice when using this option, then the specific file to download does not include meta-data information such as file size, timestamp, permissions etc, because those information is only possible to retrieve when LIST command is in use."},"checksumFileAlgorithm":{"index":31,"kind":"parameter","displayName":"Checksum File Algorithm","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["MD2","MD5","SHA_1","SHA_224","SHA_256","SHA_384","SHA_512","SHA_512_224","SHA_512_256","SHA3_224","SHA3_256","SHA3_384","SHA3_512"],"deprecated":false,"autowired":false,"secret":false,"description":"If provided, then Camel will write a checksum file when the original file has been written. The checksum file will contain the checksum created with the provided algorithm for the original file. The checksum file will always be written in the same folder as the original file."},"fileExist":{"index":32,"kind":"parameter","displayName":"File Exist","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExist","enum":["Override","Append","Fail","Ignore","Move","TryRename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Override","description":"What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers."},"flatten":{"index":33,"kind":"parameter","displayName":"Flatten","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."},"jailStartingDirectory":{"index":34,"kind":"parameter","displayName":"Jail Starting Directory","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."},"moveExisting":{"index":35,"kind":"parameter","displayName":"Move Existing","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base."},"tempFileName":{"index":36,"kind":"parameter","displayName":"Temp File Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir."},"tempPrefix":{"index":37,"kind":"parameter","displayName":"Temp Prefix","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files."},"allowNullBody":{"index":38,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."},"chmod":{"index":39,"kind":"parameter","displayName":"Chmod","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Allows you to set chmod on the stored file. For example chmod=640."},"chmodDirectory":{"index":40,"kind":"parameter","displayName":"Chmod Directory","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Allows you to set chmod during path creation. For example chmod=640."},"disconnectOnBatchComplete":{"index":41,"kind":"parameter","displayName":"Disconnect On Batch Complete","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server."},"eagerDeleteTargetFile":{"index":42,"kind":"parameter","displayName":"Eager Delete Target File","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation."},"keepLastModified":{"index":43,"kind":"parameter","displayName":"Keep Last Modified","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers."},"lazyStartProducer":{"index":44,"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."},"moveExistingFileStrategy":{"index":45,"kind":"parameter","displayName":"Move Existing File Strategy","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.file.strategy.FileMoveExistingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"},"sendNoop":{"index":46,"kind":"parameter","displayName":"Send Noop","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Whether to send a noop command as a pre-write check before uploading files to the FTP server. This is enabled by default as a validation of the connection is still valid, which allows to silently re-connect to be able to upload the file. However if this causes problems, you can turn this option off."},"autoCreate":{"index":47,"kind":"parameter","displayName":"Auto Create","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to."},"bindAddress":{"index":48,"kind":"parameter","displayName":"Bind Address","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Specifies the address of the local interface against which the connection should bind."},"bulkRequests":{"index":49,"kind":"parameter","displayName":"Bulk Requests","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Specifies how many requests may be outstanding at any one time. Increasing this value may slightly improve file transfer speed but will increase memory usage."},"compression":{"index":50,"kind":"parameter","displayName":"Compression","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"To use compression. Specify a level from 1 to 10. Important: You must manually add the needed JSCH zlib JAR to the classpath for compression support."},"connectTimeout":{"index":51,"kind":"parameter","displayName":"Connect Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH"},"existDirCheckUsingLs":{"index":52,"kind":"parameter","displayName":"Exist Dir Check Using Ls","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Whether to check for existing directory using LS command or CD. By default LS is used which is safer as otherwise Camel needs to change the directory back after checking. However LS has been reported to cause a problem on windows system in some situations and therefore you can disable this option to use CD."},"filenameEncoding":{"index":53,"kind":"parameter","displayName":"Filename Encoding","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Encoding to use for FTP client when parsing filenames. By default, UTF-8 is used."},"maximumReconnectAttempts":{"index":54,"kind":"parameter","displayName":"Maximum Reconnect Attempts","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior."},"proxy":{"index":55,"kind":"parameter","displayName":"Proxy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.jcraft.jsch.Proxy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom configured com.jcraft.jsch.Proxy. This proxy is used to consume/send messages from the target SFTP host."},"reconnectDelay":{"index":56,"kind":"parameter","displayName":"Reconnect Delay","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Delay in millis Camel will wait before performing a reconnect attempt."},"serverAliveCountMax":{"index":57,"kind":"parameter","displayName":"Server Alive Count Max","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the number of keep-alive messages which may be sent without receiving any messages back from the server. If this threshold is reached while keep-alive messages are being sent, the connection will be disconnected. The default value is one."},"serverAliveInterval":{"index":58,"kind":"parameter","displayName":"Server Alive Interval","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the interval (millis) to send a keep-alive message. If zero is specified, any keep-alive message must not be sent. The default interval is zero."},"serverMessageLoggingLevel":{"index":59,"kind":"parameter","displayName":"Server Message Logging Level","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"The logging level used for various human intended log messages from the FTP server. This can be used during troubleshooting to raise the logging level and inspect the logs received from the FTP server."},"soTimeout":{"index":60,"kind":"parameter","displayName":"So Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"300000","configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance."},"stepwise":{"index":61,"kind":"parameter","displayName":"Stepwise","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets whether we should stepwise change directories while traversing file structures when downloading files, or as well when uploading a file to a directory. You can disable this if you for example are in a situation where you cannot change directory on the FTP server due security reasons. Stepwise cannot be used together with streamDownload."},"throwExceptionOnConnectFailed":{"index":62,"kind":"parameter","displayName":"Throw Exception On Connect Failed","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method."},"timeout":{"index":63,"kind":"parameter","displayName":"Timeout","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the data timeout for waiting for reply Used only by FTPClient"},"antExclude":{"index":64,"kind":"parameter","displayName":"Ant Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format."},"antFilterCaseSensitive":{"index":65,"kind":"parameter","displayName":"Ant Filter Case Sensitive","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets case sensitive flag on ant filter."},"antInclude":{"index":66,"kind":"parameter","displayName":"Ant Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format."},"eagerMaxMessagesPerPoll":{"index":67,"kind":"parameter","displayName":"Eager Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting."},"exclude":{"index":68,"kind":"parameter","displayName":"Exclude","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"excludeExt":{"index":69,"kind":"parameter","displayName":"Exclude Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat files, use excludeExt=bak,dat. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"filter":{"index":70,"kind":"parameter","displayName":"Filter","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileFilter","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method."},"filterDirectory":{"index":71,"kind":"parameter","displayName":"Filter Directory","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}"},"filterFile":{"index":72,"kind":"parameter","displayName":"Filter File","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000"},"idempotent":{"index":73,"kind":"parameter","displayName":"Idempotent","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentEager":{"index":74,"kind":"parameter","displayName":"Idempotent Eager","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."},"idempotentKey":{"index":75,"kind":"parameter","displayName":"Idempotent Key","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}"},"idempotentRepository":{"index":76,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true."},"include":{"index":77,"kind":"parameter","displayName":"Include","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"},"includeExt":{"index":78,"kind":"parameter","displayName":"Include Ext","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml files, use includeExt=txt,xml. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options."},"maxDepth":{"index":79,"kind":"parameter","displayName":"Max Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"description":"The maximum depth to traverse when recursively processing a directory."},"maxMessagesPerPoll":{"index":80,"kind":"parameter","displayName":"Max Messages Per Poll","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards."},"minDepth":{"index":81,"kind":"parameter","displayName":"Min Depth","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory."},"move":{"index":82,"kind":"parameter","displayName":"Move","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done."},"exclusiveReadLockStrategy":{"index":83,"kind":"parameter","displayName":"Exclusive Read Lock Strategy","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation."},"readLock":{"index":84,"kind":"parameter","displayName":"Read Lock","group":"lock","label":"consumer,lock","required":false,"type":"string","javaType":"java.lang.String","enum":["none","markerFile","fileLock","rename","changed","idempotent","idempotent-changed","idempotent-rename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: - none - No read lock is in use - markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component - changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. - fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. - rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. - idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that.Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan."},"readLockCheckInterval":{"index":85,"kind":"parameter","displayName":"Read Lock Check Interval","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"readLockDeleteOrphanLockFiles":{"index":86,"kind":"parameter","displayName":"Read Lock Delete Orphan Lock Files","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory."},"readLockIdempotentReleaseAsync":{"index":87,"kind":"parameter","displayName":"Read Lock Idempotent Release Async","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the delayed release task should be synchronous or asynchronous. See more details at the readLockIdempotentReleaseDelay option."},"readLockIdempotentReleaseAsyncPoolSize":{"index":88,"kind":"parameter","displayName":"Read Lock Idempotent Release Async Pool Size","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of threads in the scheduled thread pool when using asynchronous release tasks. Using a default of 1 core threads should be sufficient in almost all use-cases, only set this to a higher value if either updating the idempotent repository is slow, or there are a lot of files to process. This option is not in-use if you use a shared thread pool by configuring the readLockIdempotentReleaseExecutorService option. See more details at the readLockIdempotentReleaseDelay option."},"readLockIdempotentReleaseDelay":{"index":89,"kind":"parameter","displayName":"Read Lock Idempotent Release Delay","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Whether to delay the release task for a period of millis. This can be used to delay the release tasks to expand the window when a file is regarded as read-locked, in an active/active cluster scenario with a shared idempotent repository, to ensure other nodes cannot potentially scan and acquire the same file, due to race-conditions. By expanding the time-window of the release tasks helps prevents these situations. Note delaying is only needed if you have configured readLockRemoveOnCommit to true."},"readLockIdempotentReleaseExecutorService":{"index":90,"kind":"parameter","displayName":"Read Lock Idempotent Release Executor Service","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom and shared thread pool for asynchronous release tasks. See more details at the readLockIdempotentReleaseDelay option."},"readLockLoggingLevel":{"index":91,"kind":"parameter","displayName":"Read Lock Logging Level","group":"lock","label":"consumer,lock","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename."},"readLockMarkerFile":{"index":92,"kind":"parameter","displayName":"Read Lock Marker File","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application."},"readLockMinAge":{"index":93,"kind":"parameter","displayName":"Read Lock Min Age","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age."},"readLockMinLength":{"index":94,"kind":"parameter","displayName":"Read Lock Min Length","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files."},"readLockRemoveOnCommit":{"index":95,"kind":"parameter","displayName":"Read Lock Remove On Commit","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option."},"readLockRemoveOnRollback":{"index":96,"kind":"parameter","displayName":"Read Lock Remove On Rollback","group":"lock","label":"consumer,lock","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit)."},"readLockTimeout":{"index":97,"kind":"parameter","displayName":"Read Lock Timeout","group":"lock","label":"consumer,lock","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"description":"Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit."},"backoffErrorThreshold":{"index":98,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":99,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":100,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":101,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":102,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":103,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":104,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":105,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":106,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":107,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":108,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":109,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":110,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":111,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"autoCreateKnownHostsFile":{"index":112,"kind":"parameter","displayName":"Auto Create Known Hosts File","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"If knownHostFile does not exist, then attempt to auto-create the path and file (beware that the file will be created by the current user of the running Java process, which may not have file permission)."},"ciphers":{"index":113,"kind":"parameter","displayName":"Ciphers","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: aes128-ctr,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,aes192-cbc,aes256-cbc. If not specified the default list from JSCH will be used."},"keyExchangeProtocols":{"index":114,"kind":"parameter","displayName":"Key Exchange Protocols","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set a comma separated list of key exchange protocols that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: diffie-hellman-group-exchange-sha1,diffie-hellman-group1-sha1,diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521. If not specified the default list from JSCH will be used."},"keyPair":{"index":115,"kind":"parameter","displayName":"Key Pair","group":"security","label":"security","required":false,"type":"object","javaType":"java.security.KeyPair","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets a key pair of the public and private key so to that the SFTP endpoint can do public/private key verification."},"knownHosts":{"index":116,"kind":"parameter","displayName":"Known Hosts","group":"security","label":"security","required":false,"type":"string","javaType":"byte[]","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the known_hosts from the byte array, so that the SFTP endpoint can do host key verification."},"knownHostsFile":{"index":117,"kind":"parameter","displayName":"Known Hosts File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the known_hosts file, so that the SFTP endpoint can do host key verification."},"knownHostsUri":{"index":118,"kind":"parameter","displayName":"Known Hosts Uri","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"supportFileReference":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets the known_hosts file (loaded from classpath by default), so that the SFTP endpoint can do host key verification."},"password":{"index":119,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Password to use for login"},"preferredAuthentications":{"index":120,"kind":"parameter","displayName":"Preferred Authentications","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set the preferred authentications which SFTP endpoint will used. Some example include:password,publickey. If not specified the default list from JSCH will be used."},"privateKey":{"index":121,"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"string","javaType":"byte[]","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set the private key as byte so that the SFTP endpoint can do private key verification."},"privateKeyFile":{"index":122,"kind":"parameter","displayName":"Private Key File","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set the private key file so that the SFTP endpoint can do private key verification."},"privateKeyPassphrase":{"index":123,"kind":"parameter","displayName":"Private Key Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set the private key file passphrase so that the SFTP endpoint can do private key verification."},"privateKeyUri":{"index":124,"kind":"parameter","displayName":"Private Key Uri","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"supportFileReference":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set the private key file (loaded from classpath by default) so that the SFTP endpoint can do private key verification."},"publicKeyAcceptedAlgorithms":{"index":125,"kind":"parameter","displayName":"Public Key Accepted Algorithms","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set a comma separated list of public key accepted algorithms. Some examples include: ssh-dss,ssh-rsa,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521. If not specified the default list from JSCH will be used."},"serverHostKeys":{"index":126,"kind":"parameter","displayName":"Server Host Keys","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Set a comma separated list of algorithms supported for the server host key. Some examples include: ssh-dss,ssh-rsa,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521. If not specified the default list from JSCH will be used."},"strictHostKeyChecking":{"index":127,"kind":"parameter","displayName":"Strict Host Key Checking","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","enum":["no","yes"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"no","configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Sets whether to use strict host key checking."},"username":{"index":128,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"Username to use for login"},"useUserKnownHostsFile":{"index":129,"kind":"parameter","displayName":"Use User Known Hosts File","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.file.remote.SftpConfiguration","configurationField":"configuration","description":"If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts"},"shuffle":{"index":130,"kind":"parameter","displayName":"Shuffle","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To shuffle the list of files (sort in random order)"},"sortBy":{"index":131,"kind":"parameter","displayName":"Sort By","group":"sort","label":"consumer,sort","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date."},"sorter":{"index":132,"kind":"parameter","displayName":"Sorter","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"java.util.Comparator>","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable sorter as a java.util.Comparator class."}}} , -{"component":{"kind":"component","name":"sjms","title":"Simple JMS","description":"Send and receive messages to/from a JMS Queue or Topic using plain JMS 1.x API.","deprecated":false,"firstVersion":"2.11.0","label":"messaging","javaType":"org.apache.camel.component.sjms.SjmsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-sjms","version":"4.8.1","scheme":"sjms","extendsScheme":"","syntax":"sjms:destinationType:destinationName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJMSDestinationName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"DestinationName is a JMS queue or topic name. By default, the destinationName is interpreted as a queue name.","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_DESTINATION_NAME"},"CamelJmsRequestTimeout":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_REQUEST_TIMEOUT"},"JMSCorrelationID":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The correlation ID.","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_CORRELATION_ID"},"JMSReplyTo":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_REPLY_TO"}},"properties":{"destinationType":{"index":0,"kind":"path","displayName":"Destination Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["queue","topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"queue","description":"The kind of destination to use"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"DestinationName is a JMS queue or topic name. By default, the destinationName is interpreted as a queue name."},"acknowledgementMode":{"index":2,"kind":"parameter","displayName":"Acknowledgement Mode","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.SessionAcknowledgementType","enum":["SESSION_TRANSACTED","CLIENT_ACKNOWLEDGE","AUTO_ACKNOWLEDGE","DUPS_OK_ACKNOWLEDGE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO_ACKNOWLEDGE","description":"The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"common","required":false,"type":"object","javaType":"jakarta.jms.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"disableReplyTo":{"index":4,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."},"replyTo":{"index":5,"kind":"parameter","displayName":"Reply To","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)."},"testConnectionOnStartup":{"index":6,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"asyncConsumer":{"index":7,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."},"autoStartup":{"index":8,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether the consumer container should auto-startup."},"clientId":{"index":9,"kind":"parameter","displayName":"Client Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead."},"concurrentConsumers":{"index":10,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"durableSubscriptionName":{"index":11,"kind":"parameter","displayName":"Durable Subscription Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."},"replyToDeliveryPersistent":{"index":12,"kind":"parameter","displayName":"Reply To Delivery Persistent","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether to use persistent delivery by default for replies."},"bridgeErrorHandler":{"index":13,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"eagerLoadingOfProperties":{"index":14,"kind":"parameter","displayName":"Eager Loading Of Properties","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties. See also the option eagerPoisonBody."},"eagerPoisonBody":{"index":15,"kind":"parameter","displayName":"Eager Poison Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Poison JMS message due to ${exception.message}","description":"If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties."},"exceptionHandler":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"messageSelector":{"index":18,"kind":"parameter","displayName":"Message Selector","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the JMS Message selector syntax."},"replyToSameDestinationAllowed":{"index":19,"kind":"parameter","displayName":"Reply To Same Destination Allowed","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself."},"deliveryMode":{"index":20,"kind":"parameter","displayName":"Delivery Mode","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","enum":["1","2"],"deprecated":false,"autowired":false,"secret":false,"description":"Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."},"deliveryPersistent":{"index":21,"kind":"parameter","displayName":"Delivery Persistent","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether persistent delivery is used by default."},"priority":{"index":22,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","enum":["1","2","3","4","5","6","7","8","9"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":4,"description":"Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect."},"replyToConcurrentConsumers":{"index":23,"kind":"parameter","displayName":"Reply To Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToOverride":{"index":24,"kind":"parameter","displayName":"Reply To Override","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."},"replyToType":{"index":25,"kind":"parameter","displayName":"Reply To Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.ReplyToType","enum":["Temporary","Exclusive"],"deprecated":false,"autowired":false,"secret":false,"description":"Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Exclusive is used."},"requestTimeout":{"index":26,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20000","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."},"timeToLive":{"index":27,"kind":"parameter","displayName":"Time To Live","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"When sending messages, specifies the time-to-live of the message (in milliseconds)."},"allowNullBody":{"index":28,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."},"disableTimeToLive":{"index":29,"kind":"parameter","displayName":"Disable Time To Live","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."},"explicitQosEnabled":{"index":30,"kind":"parameter","displayName":"Explicit Qos Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."},"lazyStartProducer":{"index":31,"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."},"preserveMessageQos":{"index":32,"kind":"parameter","displayName":"Preserve Message Qos","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."},"asyncStartListener":{"index":33,"kind":"parameter","displayName":"Async Start Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to startup the consumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail over. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry."},"asyncStopListener":{"index":34,"kind":"parameter","displayName":"Async Stop Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to stop the consumer message listener asynchronously, when stopping a route."},"destinationCreationStrategy":{"index":35,"kind":"parameter","displayName":"Destination Creation Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.DestinationCreationStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom DestinationCreationStrategy."},"exceptionListener":{"index":36,"kind":"parameter","displayName":"Exception Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.jms.ExceptionListener","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions."},"headerFilterStrategy":{"index":37,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"includeAllJMSXProperties":{"index":38,"kind":"parameter","displayName":"Include All JMSXProperties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply."},"jmsKeyFormatStrategy":{"index":39,"kind":"parameter","displayName":"Jms Key Format Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation."},"mapJmsMessage":{"index":40,"kind":"parameter","displayName":"Map Jms Message","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc. See section about how mapping works below for more details."},"messageCreatedStrategy":{"index":41,"kind":"parameter","displayName":"Message Created Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.MessageCreatedStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message."},"recoveryInterval":{"index":42,"kind":"parameter","displayName":"Recovery Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","description":"Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds."},"synchronous":{"index":43,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"transferException":{"index":44,"kind":"parameter","displayName":"Transfer Exception","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!"},"transacted":{"index":45,"kind":"parameter","displayName":"Transacted","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to use transacted mode"}}} +{"component":{"kind":"component","name":"sjms","title":"Simple JMS","description":"Send and receive messages to/from a JMS Queue or Topic using plain JMS 1.x API.","deprecated":false,"firstVersion":"2.11.0","label":"messaging","javaType":"org.apache.camel.component.sjms.SjmsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-sjms","version":"4.8.2","scheme":"sjms","extendsScheme":"","syntax":"sjms:destinationType:destinationName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJMSDestinationName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"DestinationName is a JMS queue or topic name. By default, the destinationName is interpreted as a queue name.","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_DESTINATION_NAME"},"CamelJmsRequestTimeout":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_REQUEST_TIMEOUT"},"JMSCorrelationID":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The correlation ID.","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_CORRELATION_ID"},"JMSReplyTo":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_REPLY_TO"}},"properties":{"destinationType":{"index":0,"kind":"path","displayName":"Destination Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["queue","topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"queue","description":"The kind of destination to use"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"DestinationName is a JMS queue or topic name. By default, the destinationName is interpreted as a queue name."},"acknowledgementMode":{"index":2,"kind":"parameter","displayName":"Acknowledgement Mode","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.SessionAcknowledgementType","enum":["SESSION_TRANSACTED","CLIENT_ACKNOWLEDGE","AUTO_ACKNOWLEDGE","DUPS_OK_ACKNOWLEDGE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO_ACKNOWLEDGE","description":"The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"common","required":false,"type":"object","javaType":"jakarta.jms.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"disableReplyTo":{"index":4,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."},"replyTo":{"index":5,"kind":"parameter","displayName":"Reply To","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)."},"testConnectionOnStartup":{"index":6,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"asyncConsumer":{"index":7,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."},"autoStartup":{"index":8,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether the consumer container should auto-startup."},"clientId":{"index":9,"kind":"parameter","displayName":"Client Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead."},"concurrentConsumers":{"index":10,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"durableSubscriptionName":{"index":11,"kind":"parameter","displayName":"Durable Subscription Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."},"replyToDeliveryPersistent":{"index":12,"kind":"parameter","displayName":"Reply To Delivery Persistent","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether to use persistent delivery by default for replies."},"bridgeErrorHandler":{"index":13,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"eagerLoadingOfProperties":{"index":14,"kind":"parameter","displayName":"Eager Loading Of Properties","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties. See also the option eagerPoisonBody."},"eagerPoisonBody":{"index":15,"kind":"parameter","displayName":"Eager Poison Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Poison JMS message due to ${exception.message}","description":"If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties."},"exceptionHandler":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"messageSelector":{"index":18,"kind":"parameter","displayName":"Message Selector","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the JMS Message selector syntax."},"replyToSameDestinationAllowed":{"index":19,"kind":"parameter","displayName":"Reply To Same Destination Allowed","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself."},"deliveryMode":{"index":20,"kind":"parameter","displayName":"Delivery Mode","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","enum":["1","2"],"deprecated":false,"autowired":false,"secret":false,"description":"Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."},"deliveryPersistent":{"index":21,"kind":"parameter","displayName":"Delivery Persistent","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether persistent delivery is used by default."},"priority":{"index":22,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","enum":["1","2","3","4","5","6","7","8","9"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":4,"description":"Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect."},"replyToConcurrentConsumers":{"index":23,"kind":"parameter","displayName":"Reply To Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToOverride":{"index":24,"kind":"parameter","displayName":"Reply To Override","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."},"replyToType":{"index":25,"kind":"parameter","displayName":"Reply To Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.ReplyToType","enum":["Temporary","Exclusive"],"deprecated":false,"autowired":false,"secret":false,"description":"Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Exclusive is used."},"requestTimeout":{"index":26,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20000","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."},"timeToLive":{"index":27,"kind":"parameter","displayName":"Time To Live","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"When sending messages, specifies the time-to-live of the message (in milliseconds)."},"allowNullBody":{"index":28,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."},"disableTimeToLive":{"index":29,"kind":"parameter","displayName":"Disable Time To Live","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."},"explicitQosEnabled":{"index":30,"kind":"parameter","displayName":"Explicit Qos Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."},"lazyStartProducer":{"index":31,"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."},"preserveMessageQos":{"index":32,"kind":"parameter","displayName":"Preserve Message Qos","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."},"asyncStartListener":{"index":33,"kind":"parameter","displayName":"Async Start Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to startup the consumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail over. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry."},"asyncStopListener":{"index":34,"kind":"parameter","displayName":"Async Stop Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to stop the consumer message listener asynchronously, when stopping a route."},"destinationCreationStrategy":{"index":35,"kind":"parameter","displayName":"Destination Creation Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.DestinationCreationStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom DestinationCreationStrategy."},"exceptionListener":{"index":36,"kind":"parameter","displayName":"Exception Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.jms.ExceptionListener","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions."},"headerFilterStrategy":{"index":37,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"includeAllJMSXProperties":{"index":38,"kind":"parameter","displayName":"Include All JMSXProperties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply."},"jmsKeyFormatStrategy":{"index":39,"kind":"parameter","displayName":"Jms Key Format Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation."},"mapJmsMessage":{"index":40,"kind":"parameter","displayName":"Map Jms Message","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc. See section about how mapping works below for more details."},"messageCreatedStrategy":{"index":41,"kind":"parameter","displayName":"Message Created Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.MessageCreatedStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message."},"recoveryInterval":{"index":42,"kind":"parameter","displayName":"Recovery Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","description":"Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds."},"synchronous":{"index":43,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"transferException":{"index":44,"kind":"parameter","displayName":"Transfer Exception","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!"},"transacted":{"index":45,"kind":"parameter","displayName":"Transacted","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to use transacted mode"}}} , -{"component":{"kind":"component","name":"sjms2","title":"Simple JMS2","description":"Send and receive messages to/from a JMS Queue or Topic using plain JMS 2.x API.","deprecated":false,"firstVersion":"2.19.0","label":"messaging","javaType":"org.apache.camel.component.sjms2.Sjms2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-sjms2","version":"4.8.1","scheme":"sjms2","extendsScheme":"sjms","syntax":"sjms2:destinationType:destinationName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJMSDestinationName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"DestinationName is a JMS queue or topic name. By default, the destinationName is interpreted as a queue name.","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_DESTINATION_NAME"},"CamelJmsRequestTimeout":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_REQUEST_TIMEOUT"},"JMSCorrelationID":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The correlation ID.","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_CORRELATION_ID"},"JMSReplyTo":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_REPLY_TO"}},"properties":{"destinationType":{"index":0,"kind":"path","displayName":"Destination Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["queue","topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"queue","description":"The kind of destination to use"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"DestinationName is a JMS queue or topic name. By default, the destinationName is interpreted as a queue name."},"acknowledgementMode":{"index":2,"kind":"parameter","displayName":"Acknowledgement Mode","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.SessionAcknowledgementType","enum":["SESSION_TRANSACTED","CLIENT_ACKNOWLEDGE","AUTO_ACKNOWLEDGE","DUPS_OK_ACKNOWLEDGE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO_ACKNOWLEDGE","description":"The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"common","required":false,"type":"object","javaType":"jakarta.jms.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"disableReplyTo":{"index":4,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."},"replyTo":{"index":5,"kind":"parameter","displayName":"Reply To","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)."},"testConnectionOnStartup":{"index":6,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"asyncConsumer":{"index":7,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."},"autoStartup":{"index":8,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether the consumer container should auto-startup."},"clientId":{"index":9,"kind":"parameter","displayName":"Client Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead."},"concurrentConsumers":{"index":10,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"durable":{"index":11,"kind":"parameter","displayName":"Durable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets the topic to be durable"},"durableSubscriptionName":{"index":12,"kind":"parameter","displayName":"Durable Subscription Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."},"replyToDeliveryPersistent":{"index":13,"kind":"parameter","displayName":"Reply To Delivery Persistent","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether to use persistent delivery by default for replies."},"shared":{"index":14,"kind":"parameter","displayName":"Shared","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets the topic to be shared"},"subscriptionId":{"index":15,"kind":"parameter","displayName":"Subscription Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the topic subscription id, required for durable or shared topics."},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"eagerLoadingOfProperties":{"index":17,"kind":"parameter","displayName":"Eager Loading Of Properties","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties. See also the option eagerPoisonBody."},"eagerPoisonBody":{"index":18,"kind":"parameter","displayName":"Eager Poison Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Poison JMS message due to ${exception.message}","description":"If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties."},"exceptionHandler":{"index":19,"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":{"index":20,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"messageSelector":{"index":21,"kind":"parameter","displayName":"Message Selector","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the JMS Message selector syntax."},"replyToSameDestinationAllowed":{"index":22,"kind":"parameter","displayName":"Reply To Same Destination Allowed","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself."},"deliveryMode":{"index":23,"kind":"parameter","displayName":"Delivery Mode","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","enum":["1","2"],"deprecated":false,"autowired":false,"secret":false,"description":"Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."},"deliveryPersistent":{"index":24,"kind":"parameter","displayName":"Delivery Persistent","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether persistent delivery is used by default."},"priority":{"index":25,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","enum":["1","2","3","4","5","6","7","8","9"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":4,"description":"Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect."},"replyToConcurrentConsumers":{"index":26,"kind":"parameter","displayName":"Reply To Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToOverride":{"index":27,"kind":"parameter","displayName":"Reply To Override","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."},"replyToType":{"index":28,"kind":"parameter","displayName":"Reply To Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.ReplyToType","enum":["Temporary","Exclusive"],"deprecated":false,"autowired":false,"secret":false,"description":"Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Exclusive is used."},"requestTimeout":{"index":29,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20000","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."},"timeToLive":{"index":30,"kind":"parameter","displayName":"Time To Live","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"When sending messages, specifies the time-to-live of the message (in milliseconds)."},"allowNullBody":{"index":31,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."},"disableTimeToLive":{"index":32,"kind":"parameter","displayName":"Disable Time To Live","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."},"explicitQosEnabled":{"index":33,"kind":"parameter","displayName":"Explicit Qos Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."},"lazyStartProducer":{"index":34,"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."},"preserveMessageQos":{"index":35,"kind":"parameter","displayName":"Preserve Message Qos","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."},"asyncStartListener":{"index":36,"kind":"parameter","displayName":"Async Start Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to startup the consumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail over. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry."},"asyncStopListener":{"index":37,"kind":"parameter","displayName":"Async Stop Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to stop the consumer message listener asynchronously, when stopping a route."},"destinationCreationStrategy":{"index":38,"kind":"parameter","displayName":"Destination Creation Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.DestinationCreationStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom DestinationCreationStrategy."},"exceptionListener":{"index":39,"kind":"parameter","displayName":"Exception Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.jms.ExceptionListener","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions."},"headerFilterStrategy":{"index":40,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"includeAllJMSXProperties":{"index":41,"kind":"parameter","displayName":"Include All JMSXProperties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply."},"jmsKeyFormatStrategy":{"index":42,"kind":"parameter","displayName":"Jms Key Format Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation."},"mapJmsMessage":{"index":43,"kind":"parameter","displayName":"Map Jms Message","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc. See section about how mapping works below for more details."},"messageCreatedStrategy":{"index":44,"kind":"parameter","displayName":"Message Created Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.MessageCreatedStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message."},"recoveryInterval":{"index":45,"kind":"parameter","displayName":"Recovery Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","description":"Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds."},"synchronous":{"index":46,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"transferException":{"index":47,"kind":"parameter","displayName":"Transfer Exception","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!"},"transacted":{"index":48,"kind":"parameter","displayName":"Transacted","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to use transacted mode"}}} +{"component":{"kind":"component","name":"sjms2","title":"Simple JMS2","description":"Send and receive messages to/from a JMS Queue or Topic using plain JMS 2.x API.","deprecated":false,"firstVersion":"2.19.0","label":"messaging","javaType":"org.apache.camel.component.sjms2.Sjms2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-sjms2","version":"4.8.2","scheme":"sjms2","extendsScheme":"sjms","syntax":"sjms2:destinationType:destinationName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJMSDestinationName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"DestinationName is a JMS queue or topic name. By default, the destinationName is interpreted as a queue name.","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_DESTINATION_NAME"},"CamelJmsRequestTimeout":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_REQUEST_TIMEOUT"},"JMSCorrelationID":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The correlation ID.","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_CORRELATION_ID"},"JMSReplyTo":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)","constantName":"org.apache.camel.component.sjms.SjmsConstants#JMS_REPLY_TO"}},"properties":{"destinationType":{"index":0,"kind":"path","displayName":"Destination Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["queue","topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"queue","description":"The kind of destination to use"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"DestinationName is a JMS queue or topic name. By default, the destinationName is interpreted as a queue name."},"acknowledgementMode":{"index":2,"kind":"parameter","displayName":"Acknowledgement Mode","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.SessionAcknowledgementType","enum":["SESSION_TRANSACTED","CLIENT_ACKNOWLEDGE","AUTO_ACKNOWLEDGE","DUPS_OK_ACKNOWLEDGE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO_ACKNOWLEDGE","description":"The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"common","required":false,"type":"object","javaType":"jakarta.jms.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"disableReplyTo":{"index":4,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."},"replyTo":{"index":5,"kind":"parameter","displayName":"Reply To","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)."},"testConnectionOnStartup":{"index":6,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"asyncConsumer":{"index":7,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."},"autoStartup":{"index":8,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether the consumer container should auto-startup."},"clientId":{"index":9,"kind":"parameter","displayName":"Client Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead."},"concurrentConsumers":{"index":10,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"durable":{"index":11,"kind":"parameter","displayName":"Durable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets the topic to be durable"},"durableSubscriptionName":{"index":12,"kind":"parameter","displayName":"Durable Subscription Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."},"replyToDeliveryPersistent":{"index":13,"kind":"parameter","displayName":"Reply To Delivery Persistent","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether to use persistent delivery by default for replies."},"shared":{"index":14,"kind":"parameter","displayName":"Shared","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets the topic to be shared"},"subscriptionId":{"index":15,"kind":"parameter","displayName":"Subscription Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the topic subscription id, required for durable or shared topics."},"bridgeErrorHandler":{"index":16,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"eagerLoadingOfProperties":{"index":17,"kind":"parameter","displayName":"Eager Loading Of Properties","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties. See also the option eagerPoisonBody."},"eagerPoisonBody":{"index":18,"kind":"parameter","displayName":"Eager Poison Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Poison JMS message due to ${exception.message}","description":"If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties."},"exceptionHandler":{"index":19,"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":{"index":20,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"messageSelector":{"index":21,"kind":"parameter","displayName":"Message Selector","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the JMS Message selector syntax."},"replyToSameDestinationAllowed":{"index":22,"kind":"parameter","displayName":"Reply To Same Destination Allowed","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself."},"deliveryMode":{"index":23,"kind":"parameter","displayName":"Delivery Mode","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","enum":["1","2"],"deprecated":false,"autowired":false,"secret":false,"description":"Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."},"deliveryPersistent":{"index":24,"kind":"parameter","displayName":"Delivery Persistent","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether persistent delivery is used by default."},"priority":{"index":25,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","enum":["1","2","3","4","5","6","7","8","9"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":4,"description":"Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect."},"replyToConcurrentConsumers":{"index":26,"kind":"parameter","displayName":"Reply To Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToOverride":{"index":27,"kind":"parameter","displayName":"Reply To Override","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."},"replyToType":{"index":28,"kind":"parameter","displayName":"Reply To Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.ReplyToType","enum":["Temporary","Exclusive"],"deprecated":false,"autowired":false,"secret":false,"description":"Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Exclusive is used."},"requestTimeout":{"index":29,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20000","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."},"timeToLive":{"index":30,"kind":"parameter","displayName":"Time To Live","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"When sending messages, specifies the time-to-live of the message (in milliseconds)."},"allowNullBody":{"index":31,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."},"disableTimeToLive":{"index":32,"kind":"parameter","displayName":"Disable Time To Live","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."},"explicitQosEnabled":{"index":33,"kind":"parameter","displayName":"Explicit Qos Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."},"lazyStartProducer":{"index":34,"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."},"preserveMessageQos":{"index":35,"kind":"parameter","displayName":"Preserve Message Qos","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."},"asyncStartListener":{"index":36,"kind":"parameter","displayName":"Async Start Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to startup the consumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail over. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry."},"asyncStopListener":{"index":37,"kind":"parameter","displayName":"Async Stop Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to stop the consumer message listener asynchronously, when stopping a route."},"destinationCreationStrategy":{"index":38,"kind":"parameter","displayName":"Destination Creation Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.DestinationCreationStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom DestinationCreationStrategy."},"exceptionListener":{"index":39,"kind":"parameter","displayName":"Exception Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.jms.ExceptionListener","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions."},"headerFilterStrategy":{"index":40,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"includeAllJMSXProperties":{"index":41,"kind":"parameter","displayName":"Include All JMSXProperties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply."},"jmsKeyFormatStrategy":{"index":42,"kind":"parameter","displayName":"Jms Key Format Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation."},"mapJmsMessage":{"index":43,"kind":"parameter","displayName":"Map Jms Message","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc. See section about how mapping works below for more details."},"messageCreatedStrategy":{"index":44,"kind":"parameter","displayName":"Message Created Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sjms.jms.MessageCreatedStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message."},"recoveryInterval":{"index":45,"kind":"parameter","displayName":"Recovery Interval","group":"advanced","label":"advanced","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","description":"Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds."},"synchronous":{"index":46,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"transferException":{"index":47,"kind":"parameter","displayName":"Transfer Exception","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!"},"transacted":{"index":48,"kind":"parameter","displayName":"Transacted","group":"transaction","label":"transaction","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to use transacted mode"}}} , -{"component":{"kind":"component","name":"slack","title":"Slack","description":"Send and receive messages to/from Slack.","deprecated":false,"firstVersion":"2.16.0","label":"social","javaType":"org.apache.camel.component.slack.SlackComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-slack","version":"4.8.1","scheme":"slack","extendsScheme":"","syntax":"slack:channel","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"channel":{"index":0,"kind":"path","displayName":"Channel","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channel name (syntax #name) or slack user (syntax userName) to send a message directly to an user."},"token":{"index":1,"kind":"parameter","displayName":"Token","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The token to access Slack. This app needs to have channels:history, groups:history, im:history, mpim:history, channels:read, groups:read, im:read and mpim:read permissions. The User OAuth Token is the kind of token needed."},"conversationType":{"index":2,"kind":"parameter","displayName":"Conversation Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.slack.api.model.ConversationType","enum":["PUBLIC_CHANNEL","PRIVATE_CHANNEL","MPIM","IM"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PUBLIC_CHANNEL","description":"Type of conversation"},"maxResults":{"index":3,"kind":"parameter","displayName":"Max Results","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10","description":"The Max Result for the poll"},"naturalOrder":{"index":4,"kind":"parameter","displayName":"Natural Order","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Create exchanges in natural order (oldest to newest) or not"},"sendEmptyMessageWhenIdle":{"index":5,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"serverUrl":{"index":6,"kind":"parameter","displayName":"Server Url","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https://slack.com","description":"The Server URL of the Slack instance"},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":10,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"iconEmoji":{"index":11,"kind":"parameter","displayName":"Icon Emoji","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":true,"autowired":false,"secret":false,"description":"Use a Slack emoji as an avatar"},"iconUrl":{"index":12,"kind":"parameter","displayName":"Icon Url","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":true,"autowired":false,"secret":false,"description":"The avatar that the component will use when sending message to a channel or user."},"username":{"index":13,"kind":"parameter","displayName":"Username","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":true,"autowired":false,"secret":true,"description":"This is the username that the bot will have when sending messages to a channel or user."},"webhookUrl":{"index":14,"kind":"parameter","displayName":"Webhook Url","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The incoming webhook URL"},"lazyStartProducer":{"index":15,"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."},"backoffErrorThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":17,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":18,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":19,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","description":"Milliseconds before the next poll."},"greedy":{"index":20,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":21,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":22,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":23,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":24,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":25,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":26,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":27,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":28,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":29,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} +{"component":{"kind":"component","name":"slack","title":"Slack","description":"Send and receive messages to/from Slack.","deprecated":false,"firstVersion":"2.16.0","label":"social","javaType":"org.apache.camel.component.slack.SlackComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-slack","version":"4.8.2","scheme":"slack","extendsScheme":"","syntax":"slack:channel","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"channel":{"index":0,"kind":"path","displayName":"Channel","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channel name (syntax #name) or slack user (syntax userName) to send a message directly to an user."},"token":{"index":1,"kind":"parameter","displayName":"Token","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The token to access Slack. This app needs to have channels:history, groups:history, im:history, mpim:history, channels:read, groups:read, im:read and mpim:read permissions. The User OAuth Token is the kind of token needed."},"conversationType":{"index":2,"kind":"parameter","displayName":"Conversation Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.slack.api.model.ConversationType","enum":["PUBLIC_CHANNEL","PRIVATE_CHANNEL","MPIM","IM"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PUBLIC_CHANNEL","description":"Type of conversation"},"maxResults":{"index":3,"kind":"parameter","displayName":"Max Results","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10","description":"The Max Result for the poll"},"naturalOrder":{"index":4,"kind":"parameter","displayName":"Natural Order","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Create exchanges in natural order (oldest to newest) or not"},"sendEmptyMessageWhenIdle":{"index":5,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"serverUrl":{"index":6,"kind":"parameter","displayName":"Server Url","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https://slack.com","description":"The Server URL of the Slack instance"},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":10,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"iconEmoji":{"index":11,"kind":"parameter","displayName":"Icon Emoji","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":true,"autowired":false,"secret":false,"description":"Use a Slack emoji as an avatar"},"iconUrl":{"index":12,"kind":"parameter","displayName":"Icon Url","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":true,"autowired":false,"secret":false,"description":"The avatar that the component will use when sending message to a channel or user."},"username":{"index":13,"kind":"parameter","displayName":"Username","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":true,"autowired":false,"secret":true,"description":"This is the username that the bot will have when sending messages to a channel or user."},"webhookUrl":{"index":14,"kind":"parameter","displayName":"Webhook Url","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The incoming webhook URL"},"lazyStartProducer":{"index":15,"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."},"backoffErrorThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":17,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":18,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":19,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","description":"Milliseconds before the next poll."},"greedy":{"index":20,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":21,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":22,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":23,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":24,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":25,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":26,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":27,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":28,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":29,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} , -{"component":{"kind":"component","name":"smb","title":"SMB","description":"Receive files from SMB (Server Message Block) shares.","deprecated":false,"firstVersion":"4.3.0","label":"file","javaType":"org.apache.camel.component.smb.SmbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-smb","version":"4.8.1","scheme":"smb","extendsScheme":"","syntax":"smb:hostname:port/shareName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"hostname":{"index":0,"kind":"path","displayName":"Hostname","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The share hostname or IP address"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":445,"description":"The share port number"},"shareName":{"index":2,"kind":"path","displayName":"Share Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the share to connect to."},"path":{"index":3,"kind":"parameter","displayName":"Path","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"The path, within the share, to consume the files from"},"searchPattern":{"index":4,"kind":"parameter","displayName":"Search Pattern","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"*.txt","configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"The search pattern used to list the files"},"recursive":{"index":5,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"If a directory, will look for files in all the sub-directories as well."},"sendEmptyMessageWhenIdle":{"index":6,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":10,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"autoCreate":{"index":11,"kind":"parameter","displayName":"Auto Create","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"Whether to create parent directory if it does not exist"},"fileExist":{"index":12,"kind":"parameter","displayName":"File Exist","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExist","enum":["Override","Append","Fail","Ignore","Move","TryRename"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"Ignore","configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"What action to take if the SMB file already exists"},"readBufferSize":{"index":13,"kind":"parameter","displayName":"Read Buffer Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"Read buffer size when for file being produced"},"lazyStartProducer":{"index":14,"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."},"idempotentRepository":{"index":15,"kind":"parameter","displayName":"Idempotent Repository","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified."},"smbConfig":{"index":16,"kind":"parameter","displayName":"Smb Config","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.hierynomus.smbj.SmbConfig","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"An optional SMB client configuration, can be used to configure client specific configurations, like timeouts"},"smbIoBean":{"index":17,"kind":"parameter","displayName":"Smb Io Bean","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.smb.SmbIOBean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"An optional SMB I/O bean to use to setup the file access attributes when reading/writing a file"},"backoffErrorThreshold":{"index":18,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":19,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":20,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":21,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":22,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":23,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":24,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":25,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":26,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":27,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":28,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":29,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":30,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":31,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"domain":{"index":32,"kind":"parameter","displayName":"Domain","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"The user domain"},"password":{"index":33,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"The password to access the share"},"username":{"index":34,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"The username required to access the share"}}} +{"component":{"kind":"component","name":"smb","title":"SMB","description":"Receive files from SMB (Server Message Block) shares.","deprecated":false,"firstVersion":"4.3.0","label":"file","javaType":"org.apache.camel.component.smb.SmbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-smb","version":"4.8.2","scheme":"smb","extendsScheme":"","syntax":"smb:hostname:port/shareName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"hostname":{"index":0,"kind":"path","displayName":"Hostname","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The share hostname or IP address"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":445,"description":"The share port number"},"shareName":{"index":2,"kind":"path","displayName":"Share Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the share to connect to."},"path":{"index":3,"kind":"parameter","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"The path, within the share, to consume the files from"},"searchPattern":{"index":4,"kind":"parameter","displayName":"Search Pattern","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"*.txt","configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"The search pattern used to list the files"},"recursive":{"index":5,"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"If a directory, will look for files in all the sub-directories as well."},"sendEmptyMessageWhenIdle":{"index":6,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":10,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"autoCreate":{"index":11,"kind":"parameter","displayName":"Auto Create","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"Whether to create parent directory if it does not exist"},"disconnect":{"index":12,"kind":"parameter","displayName":"Disconnect","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"Whether or not to disconnect from remote SMB server right after use. Disconnect will only disconnect the current connection to the SMB server. If you have a consumer which you want to stop, then you need to stop the consumer route instead."},"fileExist":{"index":13,"kind":"parameter","displayName":"File Exist","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.file.GenericFileExist","enum":["Override","Append","Fail","Ignore","Move","TryRename"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Ignore","configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"What action to take if the SMB file already exists"},"readBufferSize":{"index":14,"kind":"parameter","displayName":"Read Buffer Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":2048,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"Read buffer size when for file being produced"},"lazyStartProducer":{"index":15,"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."},"idempotentRepository":{"index":16,"kind":"parameter","displayName":"Idempotent Repository","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified."},"smbConfig":{"index":17,"kind":"parameter","displayName":"Smb Config","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.hierynomus.smbj.SmbConfig","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"An optional SMB client configuration, can be used to configure client specific configurations, like timeouts"},"smbIoBean":{"index":18,"kind":"parameter","displayName":"Smb Io Bean","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.smb.SmbIOBean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"An optional SMB I/O bean to use to setup the file access attributes when reading/writing a file"},"backoffErrorThreshold":{"index":19,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":20,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":21,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":22,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":23,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":24,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":25,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":26,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":27,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":28,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":29,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":30,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":31,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":32,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"domain":{"index":33,"kind":"parameter","displayName":"Domain","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"The user domain"},"password":{"index":34,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"The password to access the share"},"username":{"index":35,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.smb.SmbConfiguration","configurationField":"configuration","description":"The username required to access the share"}}} , -{"component":{"kind":"component","name":"smooks","title":"Smooks","description":"EDI, XML, CSV, etc. based data transformation using Smooks.","deprecated":false,"firstVersion":"4.7.0","label":"transformation","javaType":"org.apache.camel.component.smooks.SmooksComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-smooks","version":"4.8.1","scheme":"smooks","extendsScheme":"","syntax":"smooks:smooksConfig","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"smooksConfig":{"index":0,"kind":"path","displayName":"Smooks Config","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Smooks XML configuration file"},"sendEmptyMessageWhenIdle":{"index":1,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":2,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":3,"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":{"index":4,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":5,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":6,"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."},"backoffErrorThreshold":{"index":7,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":8,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":9,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":10,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":11,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":12,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":13,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":14,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":15,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":16,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":17,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":18,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":19,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":20,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} +{"component":{"kind":"component","name":"smooks","title":"Smooks","description":"EDI, XML, CSV, etc. based data transformation using Smooks.","deprecated":false,"firstVersion":"4.7.0","label":"transformation","javaType":"org.apache.camel.component.smooks.SmooksComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-smooks","version":"4.8.2","scheme":"smooks","extendsScheme":"","syntax":"smooks:smooksConfig","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"smooksConfig":{"index":0,"kind":"path","displayName":"Smooks Config","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Smooks XML configuration file"},"sendEmptyMessageWhenIdle":{"index":1,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":2,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":3,"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":{"index":4,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":5,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":6,"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."},"backoffErrorThreshold":{"index":7,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":8,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":9,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":10,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":11,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":12,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":13,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":14,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":15,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":16,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":17,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":18,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":19,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":20,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} , -{"component":{"kind":"component","name":"smpp","title":"SMPP","description":"Send and receive SMS messages using a SMSC (Short Message Service Center).","deprecated":false,"firstVersion":"2.2.0","label":"mobile","javaType":"org.apache.camel.component.smpp.SmppComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-smpp","version":"4.8.1","scheme":"smpp","extendsScheme":"","alternativeSchemes":"smpp,smpps","syntax":"smpp:host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelSmppAlphabet":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"For SubmitSm, SubmitMulti and ReplaceSm The data coding according to the SMPP 3.4 specification, section 5.2.19. Use the URI option alphabet settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ALPHABET"},"CamelSmppCommand":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The command","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND"},"CamelSmppCommandId":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification, DeliverSm and DataSm The command id field identifies the particular SMPP PDU. For the complete list of defined values see chapter 5.1.2.1 in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND_ID"},"CamelSmppCommandStatus":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for DataSm The Command status of the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND_STATUS"},"CamelSmppDataCoding":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"For SubmitSm, SubmitMulti and ReplaceSm The data coding according to the SMPP 3.4 specification, section 5.2.19. Use the URI option alphabet settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DATA_CODING"},"CamelSmppSplitter":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.smpp.SmppSplitter","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The splitter","constantName":"org.apache.camel.component.smpp.SmppConstants#DATA_SPLITTER"},"CamelSmppDelivered":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt Number of short messages delivered. This is only relevant where the original message was submitted to a distribution list.The value is padded with leading zeros if necessary.","constantName":"org.apache.camel.component.smpp.SmppConstants#DELIVERED"},"CamelSmppDestAddr":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"List or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the destination SME address(es). For mobile terminated messages, this is the directory number of the recipient MS. It must be a List for SubmitMulti and a String otherwise. Consumer: only for DeliverSm and DataSm: Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR"},"CamelSmppDestAddrNpi":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the numeric plan indicator (NPI) to be used in the SME destination address parameters. Use the URI option sourceAddrNpi values defined above. Consumer: only for DataSm Defines the numeric plan indicator (NPI) in the destination address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR_NPI"},"CamelSmppDestAddrTon":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the type of number (TON) to be used in the SME destination address parameters. Use the sourceAddrTon URI option values defined above. Consumer: only for DataSm Defines the type of number (TON) in the destination address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR_TON"},"CamelSmppDoneDate":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt The time and date at which the short message reached it's final state. The format is as follows: YYMMDDhhmm.","constantName":"org.apache.camel.component.smpp.SmppConstants#DONE_DATE"},"CamelSmppEncoding":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti and DataSm. Specifies the encoding (character set name) of the bytes in the message body. If the message body is a string then this is not relevant because Java Strings are always Unicode. If the body is a byte array then this header can be used to indicate that it is ISO-8859-1 or some other value. Default value is specified by the endpoint configuration parameter _encoding_","constantName":"org.apache.camel.component.smpp.SmppConstants#ENCODING"},"CamelSmppError":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or Map>>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitMultiSm The errors which occurred by sending the short message(s) the form Map (messageID : (destAddr : address, error : errorCode)). Consumer: only for smsc DeliveryReceipt Where appropriate this may hold a Network specific error code or an SMSC error code for the attempted delivery of the message. These errors are Network or SMSC specific and are not included here.","constantName":"org.apache.camel.component.smpp.SmppConstants#ERROR"},"CamelSmppClass":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.jsmpp.bean.ESMClass","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the ASM class","constantName":"org.apache.camel.component.smpp.SmppConstants#ESM_CLASS"},"CamelSmppEsmeAddr":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the destination ESME address. For mobile terminated messages, this is the directory number of the recipient MS.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR"},"CamelSmppEsmeAddrNpi":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the numeric plan indicator (NPI) to be used in the ESME originator address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR_NPI"},"CamelSmppEsmeAddrTon":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the type of number (TON) to be used in the ESME originator address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR_TON"},"CamelSmppFinalDate":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The final date","constantName":"org.apache.camel.component.smpp.SmppConstants#FINAL_DATE"},"CamelSmppStatus":{"index":18,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.jsmpp.util.DeliveryReceiptState","enum":["ENROUTE","DELIVRD","EXPIRED","DELETED","UNDELIV","ACCEPTD","UNKNOWN","REJECTD"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt: The final status of the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#FINAL_STATUS"},"CamelSmppId":{"index":19,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The id to identify the submitted short message(s) for later use. In case of a ReplaceSm, QuerySm, CancelSm and DataSm this header value is a String. In case of a SubmitSm or SubmitMultiSm this header value is a List. Consumer: only for smsc DeliveryReceipt and DataSm The message ID allocated to the message by the SMSC when originally submitted.","constantName":"org.apache.camel.component.smpp.SmppConstants#ID"},"CamelSmppMessageState":{"index":20,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message date","constantName":"org.apache.camel.component.smpp.SmppConstants#MESSAGE_STATE"},"CamelSmppMessageType":{"index":21,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Identifies the type of an incoming message: AlertNotification: an SMSC alert notification, DataSm: an SMSC data short message, DeliveryReceipt: an SMSC delivery receipt, DeliverSm: an SMSC deliver short message","constantName":"org.apache.camel.component.smpp.SmppConstants#MESSAGE_TYPE"},"CamelSmppPriorityFlag":{"index":22,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMulti Allows the originating SME to assign a priority level to the short message. Use the URI option priorityFlag settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#PRIORITY_FLAG"},"CamelSmppProtocolId":{"index":23,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The protocol id","constantName":"org.apache.camel.component.smpp.SmppConstants#PROTOCOL_ID"},"CamelSmppRegisteredDelivery":{"index":24,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, ReplaceSm, SubmitMulti and DataSm Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. Use the URI option registeredDelivery settings above. Consumer: only for DataSm Is used to request an delivery receipt and/or SME originated acknowledgements. Same values as in Producer header list above.","constantName":"org.apache.camel.component.smpp.SmppConstants#REGISTERED_DELIVERY"},"CamelSmppSingleDLR":{"index":25,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti Is used to request the SMSC delivery receipt only on the last segment of multi-segment (long) messages. Use the URI option singleDLR settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SINGLE_DLR"},"CamelSmppReplaceIfPresentFlag":{"index":26,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMulti The replace if present flag parameter is used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following values are defined: 0, Don't replace and 1, Replace","constantName":"org.apache.camel.component.smpp.SmppConstants#REPLACE_IF_PRESENT_FLAG"},"CamelSmppScheduleDeliveryTime":{"index":27,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and ReplaceSm This parameter specifies the scheduled time at which the message delivery should be first attempted. It defines either the absolute date and time or relative time from the current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time format is specified in chapter 7.1.1. in the smpp specification v3.4. Consumer: only for DeliverSm: This parameter specifies the scheduled time at which the message delivery should be first attempted. It defines either the absolute date and time or relative time from the current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time format is specified in Section 7.1.1. in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#SCHEDULE_DELIVERY_TIME"},"CamelSmppSentMessageCount":{"index":28,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMultiSm The total number of messages which has been sent.","constantName":"org.apache.camel.component.smpp.SmppConstants#SENT_MESSAGE_COUNT"},"CamelSmppSequenceNumber":{"index":29,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification, DeliverSm and DataSm A sequence number allows a response PDU to be correlated with a request PDU. The associated SMPP response PDU must preserve this field.","constantName":"org.apache.camel.component.smpp.SmppConstants#SEQUENCE_NUMBER"},"CamelSmppServiceType":{"index":30,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The service type parameter can be used to indicate the SMS Application service associated with the message. Use the URI option serviceType settings above. Consumer: only for DeliverSm and DataSm The service type parameter indicates the SMS Application service associated with the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#SERVICE_TYPE"},"CamelSmppSourceAddr":{"index":31,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the address of SME (Short Message Entity) which originated this message. Consumer: Only for AlertNotification, DeliverSm and DataSm Defines the address of SME (Short Message Entity) which originated this message.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR"},"CamelSmppSourceAddrNpi":{"index":32,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Use the URI option sourceAddrNpi values defined above. Consumer: only for AlertNotification and DataSm Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR_NPI"},"CamelSmppSourceAddrTon":{"index":33,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the type of number (TON) to be used in the SME originator address parameters. Use the sourceAddrTon URI option values defined above. Consumer: only for AlertNotification and DataSm Defines the type of number (TON) to be used in the SME originator address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR_TON"},"CamelSmppSubmitted":{"index":34,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt Number of short messages originally submitted. This is only relevant when the original message was submitted to a distribution list.The value is padded with leading zeros if necessary.","constantName":"org.apache.camel.component.smpp.SmppConstants#SUBMITTED"},"CamelSmppSubmitDate":{"index":35,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt The time and date at which the short message was submitted. In the case of a message which has been replaced, this is the date that the original message was replaced. The format is as follows: YYMMDDhhmm.","constantName":"org.apache.camel.component.smpp.SmppConstants#SUBMIT_DATE"},"CamelSmppSystemId":{"index":36,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The system id.","constantName":"org.apache.camel.component.smpp.SmppConstants#SYSTEM_ID"},"CamelSmppPassword":{"index":37,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password.","constantName":"org.apache.camel.component.smpp.SmppConstants#PASSWORD"},"CamelSmppValidityPeriod":{"index":38,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and ReplaceSm The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. If it's provided as Date, it's interpreted as absolute time or relative time format if you provide it as String as specified in chapter 7.1.1 in the smpp specification v3.4. Consumer: only for DeliverSm The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. It can be defined in absolute time format or relative time format. The encoding of absolute and relative time format is specified in Section 7.1.1 in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#VALIDITY_PERIOD"},"CamelSmppOptionalParameters":{"index":39,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"Use CamelSmppOptionalParameter instead","autowired":false,"secret":false,"description":"The optional parameters by name. Deprecation note: Use CamelSmppOptionalParameter instead","constantName":"org.apache.camel.component.smpp.SmppConstants#OPTIONAL_PARAMETERS"},"CamelSmppOptionalParameter":{"index":40,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and DataSm The optional parameter which are send to the SMSC. The value is converted in the following way: String - org.jsmpp.bean.OptionalParameter.COctetString, byte - org.jsmpp.bean.OptionalParameter.OctetString, Byte - org.jsmpp.bean.OptionalParameter.Byte, Integer - org.jsmpp.bean.OptionalParameter.Int, Short - org.jsmpp.bean.OptionalParameter.Short, null - org.jsmpp.bean.OptionalParameter.Null Consumer: only for DeliverSm The optional parameters send back by the SMSC. The key is the Short code for the optional parameter. The value is converted in the following way: org.jsmpp.bean.OptionalParameter.COctetString - String, org.jsmpp.bean.OptionalParameter.OctetString - byte, org.jsmpp.bean.OptionalParameter.Byte - Byte, org.jsmpp.bean.OptionalParameter.Int - Integer, org.jsmpp.bean.OptionalParameter.Short - Short, org.jsmpp.bean.OptionalParameter.Null - null","constantName":"org.apache.camel.component.smpp.SmppConstants#OPTIONAL_PARAMETER"},"CamelSmppSplittingPolicy":{"index":41,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti and DataSm. Specifies the policy for message splitting for this exchange. Possible values are described in the endpoint configuration parameter _splittingPolicy_","constantName":"org.apache.camel.component.smpp.SmppConstants#SPLITTING_POLICY"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Hostname for the SMSC server to use."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2775","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Port number for the SMSC server to use."},"initialReconnectDelay":{"index":2,"kind":"parameter","displayName":"Initial Reconnect Delay","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost."},"maxReconnect":{"index":3,"kind":"parameter","displayName":"Max Reconnect","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response"},"reconnectDelay":{"index":4,"kind":"parameter","displayName":"Reconnect Delay","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the interval in milliseconds between the reconnect attempts, if the connection to the SMSC was lost and the previous was not succeed."},"splittingPolicy":{"index":5,"kind":"parameter","displayName":"Splitting Policy","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.smpp.SmppSplittingPolicy","enum":["ALLOW","REJECT","TRUNCATE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ALLOW","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can specify a policy for handling long messages: ALLOW - the default, long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered. REJECT - if a message would need to be split, it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long."},"systemType":{"index":6,"kind":"parameter","displayName":"System Type","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max. 13 characters)."},"addressRange":{"index":7,"kind":"parameter","displayName":"Address Range","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can specify the address range for the SmppConsumer as defined in section 5.2.7 of the SMPP 3.4 specification. The SmppConsumer will receive messages only from SMSC's which target an address (MSISDN or IP address) within this range."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"destAddr":{"index":11,"kind":"parameter","displayName":"Dest Addr","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1717","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS. Only for SubmitSm, SubmitMulti, CancelSm and DataSm."},"destAddrNpi":{"index":12,"kind":"parameter","displayName":"Dest Addr Npi","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"destAddrTon":{"index":13,"kind":"parameter","displayName":"Dest Addr Ton","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"lazySessionCreation":{"index":14,"kind":"parameter","displayName":"Lazy Session Creation","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sessions can be lazily created to avoid exceptions, if the SMSC is not available when the Camel producer is started. Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present, Camel will use these data to connect to the SMSC."},"messageReceiverRouteId":{"index":15,"kind":"parameter","displayName":"Message Receiver Route Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Set this on producer in order to benefit from transceiver (TRX) binding type. So once set, you don't need to define an 'SMTPP consumer' endpoint anymore. You would set this to a 'Direct consumer' endpoint instead. DISCALIMER: This feature is only tested with 'Direct consumer' endpoint. The behavior with any other consumer type is unknown and not tested."},"numberingPlanIndicator":{"index":16,"kind":"parameter","displayName":"Numbering Plan Indicator","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the numeric plan indicator (NPI) to be used in the SME. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"priorityFlag":{"index":17,"kind":"parameter","displayName":"Priority Flag","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Allows the originating SME to assign a priority level to the short message. Only for SubmitSm and SubmitMulti. Four Priority Levels are supported: 0: Level 0 (lowest) priority 1: Level 1 priority 2: Level 2 priority 3: Level 3 (highest) priority"},"protocolId":{"index":18,"kind":"parameter","displayName":"Protocol Id","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The protocol id"},"registeredDelivery":{"index":19,"kind":"parameter","displayName":"Registered Delivery","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined: 0: No SMSC delivery receipt requested. 1: SMSC delivery receipt requested where final delivery outcome is success or failure. 2: SMSC delivery receipt requested where the final delivery outcome is delivery failure."},"replaceIfPresentFlag":{"index":20,"kind":"parameter","displayName":"Replace If Present Flag","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following replace if present flag values are defined: 0: Don't replace 1: Replace"},"serviceType":{"index":21,"kind":"parameter","displayName":"Service Type","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["CMT","CPT","VMN","VMA","WAP","USSD"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The service type parameter can be used to indicate the SMS Application service associated with the message. The following generic service_types are defined: CMT: Cellular Messaging CPT: Cellular Paging VMN: Voice Mail Notification VMA: Voice Mail Alerting WAP: Wireless Application Protocol USSD: Unstructured Supplementary Services Data"},"sourceAddr":{"index":22,"kind":"parameter","displayName":"Source Addr","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1616","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the address of SME (Short Message Entity) which originated this message."},"sourceAddrNpi":{"index":23,"kind":"parameter","displayName":"Source Addr Npi","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"sourceAddrTon":{"index":24,"kind":"parameter","displayName":"Source Addr Ton","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"typeOfNumber":{"index":25,"kind":"parameter","displayName":"Type Of Number","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"lazyStartProducer":{"index":26,"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."},"enquireLinkTimer":{"index":27,"kind":"parameter","displayName":"Enquire Link Timer","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the interval in milliseconds between the confidence checks. The confidence check is used to test the communication path between an ESME and an SMSC."},"interfaceVersion":{"index":28,"kind":"parameter","displayName":"Interface Version","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["legacy","3.3","3.4","5.0"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"3.4","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the interface version to be used in the binding request with the SMSC. The following values are allowed, as defined in the SMPP protocol (and the underlying implementation using the jSMPP library, respectively): legacy (0x00), 3.3 (0x33), 3.4 (0x34), and 5.0 (0x50). The default (fallback) value is version 3.4."},"pduProcessorDegree":{"index":29,"kind":"parameter","displayName":"Pdu Processor Degree","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sets the number of threads which can read PDU and process them in parallel."},"pduProcessorQueueCapacity":{"index":30,"kind":"parameter","displayName":"Pdu Processor Queue Capacity","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sets the capacity of the working queue for PDU processing."},"sessionStateListener":{"index":31,"kind":"parameter","displayName":"Session State Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.jsmpp.session.SessionStateListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed."},"singleDLR":{"index":32,"kind":"parameter","displayName":"Single DLR","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"When true, the SMSC delivery receipt would be requested only for the last segment of a multi-segment (long) message. For short messages, with only 1 segment the behaviour is unchanged."},"transactionTimer":{"index":33,"kind":"parameter","displayName":"Transaction Timer","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the maximum period of inactivity allowed after a transaction, after which an SMPP entity may assume that the session is no longer active. This timer may be active on either communicating SMPP entity (i.e. SMSC or ESME)."},"alphabet":{"index":34,"kind":"parameter","displayName":"Alphabet","group":"codec","label":"codec","required":false,"type":"integer","javaType":"byte","enum":["0","4","8"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2 Alphabet"},"dataCoding":{"index":35,"kind":"parameter","displayName":"Data Coding","group":"codec","label":"codec","required":false,"type":"integer","javaType":"byte","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the data coding according the SMPP 3.4 specification, section 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2 (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990)"},"encoding":{"index":36,"kind":"parameter","displayName":"Encoding","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ISO-8859-1","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the encoding scheme of the short message user data. Only for SubmitSm, ReplaceSm and SubmitMulti."},"httpProxyHost":{"index":37,"kind":"parameter","displayName":"Http Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If you need to tunnel SMPP through a HTTP proxy, set this attribute to the hostname or ip address of your HTTP proxy."},"httpProxyPassword":{"index":38,"kind":"parameter","displayName":"Http Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy."},"httpProxyPort":{"index":39,"kind":"parameter","displayName":"Http Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3128","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy."},"httpProxyUsername":{"index":40,"kind":"parameter","displayName":"Http Proxy Username","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy."},"proxyHeaders":{"index":41,"kind":"parameter","displayName":"Proxy Headers","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"These headers will be passed to the proxy server while establishing the connection."},"password":{"index":42,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The password for connecting to SMSC server."},"systemId":{"index":43,"kind":"parameter","displayName":"System Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"defaultValue":"smppclient","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The system id (username) for connecting to SMSC server."},"usingSSL":{"index":44,"kind":"parameter","displayName":"Using SSL","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Whether using SSL with the smpps protocol"}}} +{"component":{"kind":"component","name":"smpp","title":"SMPP","description":"Send and receive SMS messages using a SMSC (Short Message Service Center).","deprecated":false,"firstVersion":"2.2.0","label":"mobile","javaType":"org.apache.camel.component.smpp.SmppComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-smpp","version":"4.8.2","scheme":"smpp","extendsScheme":"","alternativeSchemes":"smpp,smpps","syntax":"smpp:host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelSmppAlphabet":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"For SubmitSm, SubmitMulti and ReplaceSm The data coding according to the SMPP 3.4 specification, section 5.2.19. Use the URI option alphabet settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ALPHABET"},"CamelSmppCommand":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The command","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND"},"CamelSmppCommandId":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification, DeliverSm and DataSm The command id field identifies the particular SMPP PDU. For the complete list of defined values see chapter 5.1.2.1 in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND_ID"},"CamelSmppCommandStatus":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for DataSm The Command status of the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND_STATUS"},"CamelSmppDataCoding":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"For SubmitSm, SubmitMulti and ReplaceSm The data coding according to the SMPP 3.4 specification, section 5.2.19. Use the URI option alphabet settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DATA_CODING"},"CamelSmppSplitter":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.smpp.SmppSplitter","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The splitter","constantName":"org.apache.camel.component.smpp.SmppConstants#DATA_SPLITTER"},"CamelSmppDelivered":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt Number of short messages delivered. This is only relevant where the original message was submitted to a distribution list.The value is padded with leading zeros if necessary.","constantName":"org.apache.camel.component.smpp.SmppConstants#DELIVERED"},"CamelSmppDestAddr":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"List or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the destination SME address(es). For mobile terminated messages, this is the directory number of the recipient MS. It must be a List for SubmitMulti and a String otherwise. Consumer: only for DeliverSm and DataSm: Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR"},"CamelSmppDestAddrNpi":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the numeric plan indicator (NPI) to be used in the SME destination address parameters. Use the URI option sourceAddrNpi values defined above. Consumer: only for DataSm Defines the numeric plan indicator (NPI) in the destination address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR_NPI"},"CamelSmppDestAddrTon":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the type of number (TON) to be used in the SME destination address parameters. Use the sourceAddrTon URI option values defined above. Consumer: only for DataSm Defines the type of number (TON) in the destination address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR_TON"},"CamelSmppDoneDate":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt The time and date at which the short message reached it's final state. The format is as follows: YYMMDDhhmm.","constantName":"org.apache.camel.component.smpp.SmppConstants#DONE_DATE"},"CamelSmppEncoding":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti and DataSm. Specifies the encoding (character set name) of the bytes in the message body. If the message body is a string then this is not relevant because Java Strings are always Unicode. If the body is a byte array then this header can be used to indicate that it is ISO-8859-1 or some other value. Default value is specified by the endpoint configuration parameter _encoding_","constantName":"org.apache.camel.component.smpp.SmppConstants#ENCODING"},"CamelSmppError":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or Map>>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitMultiSm The errors which occurred by sending the short message(s) the form Map (messageID : (destAddr : address, error : errorCode)). Consumer: only for smsc DeliveryReceipt Where appropriate this may hold a Network specific error code or an SMSC error code for the attempted delivery of the message. These errors are Network or SMSC specific and are not included here.","constantName":"org.apache.camel.component.smpp.SmppConstants#ERROR"},"CamelSmppClass":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.jsmpp.bean.ESMClass","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the ASM class","constantName":"org.apache.camel.component.smpp.SmppConstants#ESM_CLASS"},"CamelSmppEsmeAddr":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the destination ESME address. For mobile terminated messages, this is the directory number of the recipient MS.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR"},"CamelSmppEsmeAddrNpi":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the numeric plan indicator (NPI) to be used in the ESME originator address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR_NPI"},"CamelSmppEsmeAddrTon":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the type of number (TON) to be used in the ESME originator address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR_TON"},"CamelSmppFinalDate":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The final date","constantName":"org.apache.camel.component.smpp.SmppConstants#FINAL_DATE"},"CamelSmppStatus":{"index":18,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.jsmpp.util.DeliveryReceiptState","enum":["ENROUTE","DELIVRD","EXPIRED","DELETED","UNDELIV","ACCEPTD","UNKNOWN","REJECTD"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt: The final status of the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#FINAL_STATUS"},"CamelSmppId":{"index":19,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The id to identify the submitted short message(s) for later use. In case of a ReplaceSm, QuerySm, CancelSm and DataSm this header value is a String. In case of a SubmitSm or SubmitMultiSm this header value is a List. Consumer: only for smsc DeliveryReceipt and DataSm The message ID allocated to the message by the SMSC when originally submitted.","constantName":"org.apache.camel.component.smpp.SmppConstants#ID"},"CamelSmppMessageState":{"index":20,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message date","constantName":"org.apache.camel.component.smpp.SmppConstants#MESSAGE_STATE"},"CamelSmppMessageType":{"index":21,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Identifies the type of an incoming message: AlertNotification: an SMSC alert notification, DataSm: an SMSC data short message, DeliveryReceipt: an SMSC delivery receipt, DeliverSm: an SMSC deliver short message","constantName":"org.apache.camel.component.smpp.SmppConstants#MESSAGE_TYPE"},"CamelSmppPriorityFlag":{"index":22,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMulti Allows the originating SME to assign a priority level to the short message. Use the URI option priorityFlag settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#PRIORITY_FLAG"},"CamelSmppProtocolId":{"index":23,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The protocol id","constantName":"org.apache.camel.component.smpp.SmppConstants#PROTOCOL_ID"},"CamelSmppRegisteredDelivery":{"index":24,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, ReplaceSm, SubmitMulti and DataSm Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. Use the URI option registeredDelivery settings above. Consumer: only for DataSm Is used to request an delivery receipt and/or SME originated acknowledgements. Same values as in Producer header list above.","constantName":"org.apache.camel.component.smpp.SmppConstants#REGISTERED_DELIVERY"},"CamelSmppSingleDLR":{"index":25,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti Is used to request the SMSC delivery receipt only on the last segment of multi-segment (long) messages. Use the URI option singleDLR settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SINGLE_DLR"},"CamelSmppReplaceIfPresentFlag":{"index":26,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMulti The replace if present flag parameter is used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following values are defined: 0, Don't replace and 1, Replace","constantName":"org.apache.camel.component.smpp.SmppConstants#REPLACE_IF_PRESENT_FLAG"},"CamelSmppScheduleDeliveryTime":{"index":27,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and ReplaceSm This parameter specifies the scheduled time at which the message delivery should be first attempted. It defines either the absolute date and time or relative time from the current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time format is specified in chapter 7.1.1. in the smpp specification v3.4. Consumer: only for DeliverSm: This parameter specifies the scheduled time at which the message delivery should be first attempted. It defines either the absolute date and time or relative time from the current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time format is specified in Section 7.1.1. in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#SCHEDULE_DELIVERY_TIME"},"CamelSmppSentMessageCount":{"index":28,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMultiSm The total number of messages which has been sent.","constantName":"org.apache.camel.component.smpp.SmppConstants#SENT_MESSAGE_COUNT"},"CamelSmppSequenceNumber":{"index":29,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification, DeliverSm and DataSm A sequence number allows a response PDU to be correlated with a request PDU. The associated SMPP response PDU must preserve this field.","constantName":"org.apache.camel.component.smpp.SmppConstants#SEQUENCE_NUMBER"},"CamelSmppServiceType":{"index":30,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The service type parameter can be used to indicate the SMS Application service associated with the message. Use the URI option serviceType settings above. Consumer: only for DeliverSm and DataSm The service type parameter indicates the SMS Application service associated with the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#SERVICE_TYPE"},"CamelSmppSourceAddr":{"index":31,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the address of SME (Short Message Entity) which originated this message. Consumer: Only for AlertNotification, DeliverSm and DataSm Defines the address of SME (Short Message Entity) which originated this message.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR"},"CamelSmppSourceAddrNpi":{"index":32,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Use the URI option sourceAddrNpi values defined above. Consumer: only for AlertNotification and DataSm Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR_NPI"},"CamelSmppSourceAddrTon":{"index":33,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the type of number (TON) to be used in the SME originator address parameters. Use the sourceAddrTon URI option values defined above. Consumer: only for AlertNotification and DataSm Defines the type of number (TON) to be used in the SME originator address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR_TON"},"CamelSmppSubmitted":{"index":34,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt Number of short messages originally submitted. This is only relevant when the original message was submitted to a distribution list.The value is padded with leading zeros if necessary.","constantName":"org.apache.camel.component.smpp.SmppConstants#SUBMITTED"},"CamelSmppSubmitDate":{"index":35,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt The time and date at which the short message was submitted. In the case of a message which has been replaced, this is the date that the original message was replaced. The format is as follows: YYMMDDhhmm.","constantName":"org.apache.camel.component.smpp.SmppConstants#SUBMIT_DATE"},"CamelSmppSystemId":{"index":36,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The system id.","constantName":"org.apache.camel.component.smpp.SmppConstants#SYSTEM_ID"},"CamelSmppPassword":{"index":37,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password.","constantName":"org.apache.camel.component.smpp.SmppConstants#PASSWORD"},"CamelSmppValidityPeriod":{"index":38,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and ReplaceSm The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. If it's provided as Date, it's interpreted as absolute time or relative time format if you provide it as String as specified in chapter 7.1.1 in the smpp specification v3.4. Consumer: only for DeliverSm The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. It can be defined in absolute time format or relative time format. The encoding of absolute and relative time format is specified in Section 7.1.1 in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#VALIDITY_PERIOD"},"CamelSmppOptionalParameters":{"index":39,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"Use CamelSmppOptionalParameter instead","autowired":false,"secret":false,"description":"The optional parameters by name. Deprecation note: Use CamelSmppOptionalParameter instead","constantName":"org.apache.camel.component.smpp.SmppConstants#OPTIONAL_PARAMETERS"},"CamelSmppOptionalParameter":{"index":40,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and DataSm The optional parameter which are send to the SMSC. The value is converted in the following way: String - org.jsmpp.bean.OptionalParameter.COctetString, byte - org.jsmpp.bean.OptionalParameter.OctetString, Byte - org.jsmpp.bean.OptionalParameter.Byte, Integer - org.jsmpp.bean.OptionalParameter.Int, Short - org.jsmpp.bean.OptionalParameter.Short, null - org.jsmpp.bean.OptionalParameter.Null Consumer: only for DeliverSm The optional parameters send back by the SMSC. The key is the Short code for the optional parameter. The value is converted in the following way: org.jsmpp.bean.OptionalParameter.COctetString - String, org.jsmpp.bean.OptionalParameter.OctetString - byte, org.jsmpp.bean.OptionalParameter.Byte - Byte, org.jsmpp.bean.OptionalParameter.Int - Integer, org.jsmpp.bean.OptionalParameter.Short - Short, org.jsmpp.bean.OptionalParameter.Null - null","constantName":"org.apache.camel.component.smpp.SmppConstants#OPTIONAL_PARAMETER"},"CamelSmppSplittingPolicy":{"index":41,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti and DataSm. Specifies the policy for message splitting for this exchange. Possible values are described in the endpoint configuration parameter _splittingPolicy_","constantName":"org.apache.camel.component.smpp.SmppConstants#SPLITTING_POLICY"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Hostname for the SMSC server to use."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2775","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Port number for the SMSC server to use."},"initialReconnectDelay":{"index":2,"kind":"parameter","displayName":"Initial Reconnect Delay","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost."},"maxReconnect":{"index":3,"kind":"parameter","displayName":"Max Reconnect","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response"},"reconnectDelay":{"index":4,"kind":"parameter","displayName":"Reconnect Delay","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the interval in milliseconds between the reconnect attempts, if the connection to the SMSC was lost and the previous was not succeed."},"splittingPolicy":{"index":5,"kind":"parameter","displayName":"Splitting Policy","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.smpp.SmppSplittingPolicy","enum":["ALLOW","REJECT","TRUNCATE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ALLOW","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can specify a policy for handling long messages: ALLOW - the default, long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered. REJECT - if a message would need to be split, it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long."},"systemType":{"index":6,"kind":"parameter","displayName":"System Type","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max. 13 characters)."},"addressRange":{"index":7,"kind":"parameter","displayName":"Address Range","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can specify the address range for the SmppConsumer as defined in section 5.2.7 of the SMPP 3.4 specification. The SmppConsumer will receive messages only from SMSC's which target an address (MSISDN or IP address) within this range."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"destAddr":{"index":11,"kind":"parameter","displayName":"Dest Addr","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1717","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS. Only for SubmitSm, SubmitMulti, CancelSm and DataSm."},"destAddrNpi":{"index":12,"kind":"parameter","displayName":"Dest Addr Npi","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"destAddrTon":{"index":13,"kind":"parameter","displayName":"Dest Addr Ton","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"lazySessionCreation":{"index":14,"kind":"parameter","displayName":"Lazy Session Creation","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sessions can be lazily created to avoid exceptions, if the SMSC is not available when the Camel producer is started. Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present, Camel will use these data to connect to the SMSC."},"messageReceiverRouteId":{"index":15,"kind":"parameter","displayName":"Message Receiver Route Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Set this on producer in order to benefit from transceiver (TRX) binding type. So once set, you don't need to define an 'SMTPP consumer' endpoint anymore. You would set this to a 'Direct consumer' endpoint instead. DISCALIMER: This feature is only tested with 'Direct consumer' endpoint. The behavior with any other consumer type is unknown and not tested."},"numberingPlanIndicator":{"index":16,"kind":"parameter","displayName":"Numbering Plan Indicator","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the numeric plan indicator (NPI) to be used in the SME. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"priorityFlag":{"index":17,"kind":"parameter","displayName":"Priority Flag","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Allows the originating SME to assign a priority level to the short message. Only for SubmitSm and SubmitMulti. Four Priority Levels are supported: 0: Level 0 (lowest) priority 1: Level 1 priority 2: Level 2 priority 3: Level 3 (highest) priority"},"protocolId":{"index":18,"kind":"parameter","displayName":"Protocol Id","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The protocol id"},"registeredDelivery":{"index":19,"kind":"parameter","displayName":"Registered Delivery","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined: 0: No SMSC delivery receipt requested. 1: SMSC delivery receipt requested where final delivery outcome is success or failure. 2: SMSC delivery receipt requested where the final delivery outcome is delivery failure."},"replaceIfPresentFlag":{"index":20,"kind":"parameter","displayName":"Replace If Present Flag","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following replace if present flag values are defined: 0: Don't replace 1: Replace"},"serviceType":{"index":21,"kind":"parameter","displayName":"Service Type","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["CMT","CPT","VMN","VMA","WAP","USSD"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The service type parameter can be used to indicate the SMS Application service associated with the message. The following generic service_types are defined: CMT: Cellular Messaging CPT: Cellular Paging VMN: Voice Mail Notification VMA: Voice Mail Alerting WAP: Wireless Application Protocol USSD: Unstructured Supplementary Services Data"},"sourceAddr":{"index":22,"kind":"parameter","displayName":"Source Addr","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1616","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the address of SME (Short Message Entity) which originated this message."},"sourceAddrNpi":{"index":23,"kind":"parameter","displayName":"Source Addr Npi","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"sourceAddrTon":{"index":24,"kind":"parameter","displayName":"Source Addr Ton","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"typeOfNumber":{"index":25,"kind":"parameter","displayName":"Type Of Number","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"lazyStartProducer":{"index":26,"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."},"enquireLinkTimer":{"index":27,"kind":"parameter","displayName":"Enquire Link Timer","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the interval in milliseconds between the confidence checks. The confidence check is used to test the communication path between an ESME and an SMSC."},"interfaceVersion":{"index":28,"kind":"parameter","displayName":"Interface Version","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["legacy","3.3","3.4","5.0"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"3.4","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the interface version to be used in the binding request with the SMSC. The following values are allowed, as defined in the SMPP protocol (and the underlying implementation using the jSMPP library, respectively): legacy (0x00), 3.3 (0x33), 3.4 (0x34), and 5.0 (0x50). The default (fallback) value is version 3.4."},"pduProcessorDegree":{"index":29,"kind":"parameter","displayName":"Pdu Processor Degree","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sets the number of threads which can read PDU and process them in parallel."},"pduProcessorQueueCapacity":{"index":30,"kind":"parameter","displayName":"Pdu Processor Queue Capacity","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sets the capacity of the working queue for PDU processing."},"sessionStateListener":{"index":31,"kind":"parameter","displayName":"Session State Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.jsmpp.session.SessionStateListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed."},"singleDLR":{"index":32,"kind":"parameter","displayName":"Single DLR","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"When true, the SMSC delivery receipt would be requested only for the last segment of a multi-segment (long) message. For short messages, with only 1 segment the behaviour is unchanged."},"transactionTimer":{"index":33,"kind":"parameter","displayName":"Transaction Timer","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the maximum period of inactivity allowed after a transaction, after which an SMPP entity may assume that the session is no longer active. This timer may be active on either communicating SMPP entity (i.e. SMSC or ESME)."},"alphabet":{"index":34,"kind":"parameter","displayName":"Alphabet","group":"codec","label":"codec","required":false,"type":"integer","javaType":"byte","enum":["0","4","8"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2 Alphabet"},"dataCoding":{"index":35,"kind":"parameter","displayName":"Data Coding","group":"codec","label":"codec","required":false,"type":"integer","javaType":"byte","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the data coding according the SMPP 3.4 specification, section 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2 (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990)"},"encoding":{"index":36,"kind":"parameter","displayName":"Encoding","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ISO-8859-1","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the encoding scheme of the short message user data. Only for SubmitSm, ReplaceSm and SubmitMulti."},"httpProxyHost":{"index":37,"kind":"parameter","displayName":"Http Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If you need to tunnel SMPP through a HTTP proxy, set this attribute to the hostname or ip address of your HTTP proxy."},"httpProxyPassword":{"index":38,"kind":"parameter","displayName":"Http Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy."},"httpProxyPort":{"index":39,"kind":"parameter","displayName":"Http Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3128","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy."},"httpProxyUsername":{"index":40,"kind":"parameter","displayName":"Http Proxy Username","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy."},"proxyHeaders":{"index":41,"kind":"parameter","displayName":"Proxy Headers","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"These headers will be passed to the proxy server while establishing the connection."},"password":{"index":42,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The password for connecting to SMSC server."},"systemId":{"index":43,"kind":"parameter","displayName":"System Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"defaultValue":"smppclient","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The system id (username) for connecting to SMSC server."},"usingSSL":{"index":44,"kind":"parameter","displayName":"Using SSL","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Whether using SSL with the smpps protocol"}}} , -{"component":{"kind":"component","name":"smpps","title":"SMPP (Secure)","description":"Send and receive SMS messages using a SMSC (Short Message Service Center).","deprecated":false,"firstVersion":"2.2.0","label":"mobile","javaType":"org.apache.camel.component.smpp.SmppComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-smpp","version":"4.8.1","scheme":"smpps","extendsScheme":"","alternativeSchemes":"smpp,smpps","syntax":"smpps:host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelSmppAlphabet":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"For SubmitSm, SubmitMulti and ReplaceSm The data coding according to the SMPP 3.4 specification, section 5.2.19. Use the URI option alphabet settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ALPHABET"},"CamelSmppCommand":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The command","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND"},"CamelSmppCommandId":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification, DeliverSm and DataSm The command id field identifies the particular SMPP PDU. For the complete list of defined values see chapter 5.1.2.1 in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND_ID"},"CamelSmppCommandStatus":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for DataSm The Command status of the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND_STATUS"},"CamelSmppDataCoding":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"For SubmitSm, SubmitMulti and ReplaceSm The data coding according to the SMPP 3.4 specification, section 5.2.19. Use the URI option alphabet settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DATA_CODING"},"CamelSmppSplitter":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.smpp.SmppSplitter","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The splitter","constantName":"org.apache.camel.component.smpp.SmppConstants#DATA_SPLITTER"},"CamelSmppDelivered":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt Number of short messages delivered. This is only relevant where the original message was submitted to a distribution list.The value is padded with leading zeros if necessary.","constantName":"org.apache.camel.component.smpp.SmppConstants#DELIVERED"},"CamelSmppDestAddr":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"List or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the destination SME address(es). For mobile terminated messages, this is the directory number of the recipient MS. It must be a List for SubmitMulti and a String otherwise. Consumer: only for DeliverSm and DataSm: Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR"},"CamelSmppDestAddrNpi":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the numeric plan indicator (NPI) to be used in the SME destination address parameters. Use the URI option sourceAddrNpi values defined above. Consumer: only for DataSm Defines the numeric plan indicator (NPI) in the destination address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR_NPI"},"CamelSmppDestAddrTon":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the type of number (TON) to be used in the SME destination address parameters. Use the sourceAddrTon URI option values defined above. Consumer: only for DataSm Defines the type of number (TON) in the destination address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR_TON"},"CamelSmppDoneDate":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt The time and date at which the short message reached it's final state. The format is as follows: YYMMDDhhmm.","constantName":"org.apache.camel.component.smpp.SmppConstants#DONE_DATE"},"CamelSmppEncoding":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti and DataSm. Specifies the encoding (character set name) of the bytes in the message body. If the message body is a string then this is not relevant because Java Strings are always Unicode. If the body is a byte array then this header can be used to indicate that it is ISO-8859-1 or some other value. Default value is specified by the endpoint configuration parameter _encoding_","constantName":"org.apache.camel.component.smpp.SmppConstants#ENCODING"},"CamelSmppError":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or Map>>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitMultiSm The errors which occurred by sending the short message(s) the form Map (messageID : (destAddr : address, error : errorCode)). Consumer: only for smsc DeliveryReceipt Where appropriate this may hold a Network specific error code or an SMSC error code for the attempted delivery of the message. These errors are Network or SMSC specific and are not included here.","constantName":"org.apache.camel.component.smpp.SmppConstants#ERROR"},"CamelSmppClass":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.jsmpp.bean.ESMClass","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the ASM class","constantName":"org.apache.camel.component.smpp.SmppConstants#ESM_CLASS"},"CamelSmppEsmeAddr":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the destination ESME address. For mobile terminated messages, this is the directory number of the recipient MS.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR"},"CamelSmppEsmeAddrNpi":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the numeric plan indicator (NPI) to be used in the ESME originator address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR_NPI"},"CamelSmppEsmeAddrTon":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the type of number (TON) to be used in the ESME originator address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR_TON"},"CamelSmppFinalDate":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The final date","constantName":"org.apache.camel.component.smpp.SmppConstants#FINAL_DATE"},"CamelSmppStatus":{"index":18,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.jsmpp.util.DeliveryReceiptState","enum":["ENROUTE","DELIVRD","EXPIRED","DELETED","UNDELIV","ACCEPTD","UNKNOWN","REJECTD"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt: The final status of the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#FINAL_STATUS"},"CamelSmppId":{"index":19,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The id to identify the submitted short message(s) for later use. In case of a ReplaceSm, QuerySm, CancelSm and DataSm this header value is a String. In case of a SubmitSm or SubmitMultiSm this header value is a List. Consumer: only for smsc DeliveryReceipt and DataSm The message ID allocated to the message by the SMSC when originally submitted.","constantName":"org.apache.camel.component.smpp.SmppConstants#ID"},"CamelSmppMessageState":{"index":20,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message date","constantName":"org.apache.camel.component.smpp.SmppConstants#MESSAGE_STATE"},"CamelSmppMessageType":{"index":21,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Identifies the type of an incoming message: AlertNotification: an SMSC alert notification, DataSm: an SMSC data short message, DeliveryReceipt: an SMSC delivery receipt, DeliverSm: an SMSC deliver short message","constantName":"org.apache.camel.component.smpp.SmppConstants#MESSAGE_TYPE"},"CamelSmppPriorityFlag":{"index":22,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMulti Allows the originating SME to assign a priority level to the short message. Use the URI option priorityFlag settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#PRIORITY_FLAG"},"CamelSmppProtocolId":{"index":23,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The protocol id","constantName":"org.apache.camel.component.smpp.SmppConstants#PROTOCOL_ID"},"CamelSmppRegisteredDelivery":{"index":24,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, ReplaceSm, SubmitMulti and DataSm Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. Use the URI option registeredDelivery settings above. Consumer: only for DataSm Is used to request an delivery receipt and/or SME originated acknowledgements. Same values as in Producer header list above.","constantName":"org.apache.camel.component.smpp.SmppConstants#REGISTERED_DELIVERY"},"CamelSmppSingleDLR":{"index":25,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti Is used to request the SMSC delivery receipt only on the last segment of multi-segment (long) messages. Use the URI option singleDLR settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SINGLE_DLR"},"CamelSmppReplaceIfPresentFlag":{"index":26,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMulti The replace if present flag parameter is used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following values are defined: 0, Don't replace and 1, Replace","constantName":"org.apache.camel.component.smpp.SmppConstants#REPLACE_IF_PRESENT_FLAG"},"CamelSmppScheduleDeliveryTime":{"index":27,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and ReplaceSm This parameter specifies the scheduled time at which the message delivery should be first attempted. It defines either the absolute date and time or relative time from the current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time format is specified in chapter 7.1.1. in the smpp specification v3.4. Consumer: only for DeliverSm: This parameter specifies the scheduled time at which the message delivery should be first attempted. It defines either the absolute date and time or relative time from the current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time format is specified in Section 7.1.1. in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#SCHEDULE_DELIVERY_TIME"},"CamelSmppSentMessageCount":{"index":28,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMultiSm The total number of messages which has been sent.","constantName":"org.apache.camel.component.smpp.SmppConstants#SENT_MESSAGE_COUNT"},"CamelSmppSequenceNumber":{"index":29,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification, DeliverSm and DataSm A sequence number allows a response PDU to be correlated with a request PDU. The associated SMPP response PDU must preserve this field.","constantName":"org.apache.camel.component.smpp.SmppConstants#SEQUENCE_NUMBER"},"CamelSmppServiceType":{"index":30,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The service type parameter can be used to indicate the SMS Application service associated with the message. Use the URI option serviceType settings above. Consumer: only for DeliverSm and DataSm The service type parameter indicates the SMS Application service associated with the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#SERVICE_TYPE"},"CamelSmppSourceAddr":{"index":31,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the address of SME (Short Message Entity) which originated this message. Consumer: Only for AlertNotification, DeliverSm and DataSm Defines the address of SME (Short Message Entity) which originated this message.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR"},"CamelSmppSourceAddrNpi":{"index":32,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Use the URI option sourceAddrNpi values defined above. Consumer: only for AlertNotification and DataSm Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR_NPI"},"CamelSmppSourceAddrTon":{"index":33,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the type of number (TON) to be used in the SME originator address parameters. Use the sourceAddrTon URI option values defined above. Consumer: only for AlertNotification and DataSm Defines the type of number (TON) to be used in the SME originator address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR_TON"},"CamelSmppSubmitted":{"index":34,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt Number of short messages originally submitted. This is only relevant when the original message was submitted to a distribution list.The value is padded with leading zeros if necessary.","constantName":"org.apache.camel.component.smpp.SmppConstants#SUBMITTED"},"CamelSmppSubmitDate":{"index":35,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt The time and date at which the short message was submitted. In the case of a message which has been replaced, this is the date that the original message was replaced. The format is as follows: YYMMDDhhmm.","constantName":"org.apache.camel.component.smpp.SmppConstants#SUBMIT_DATE"},"CamelSmppSystemId":{"index":36,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The system id.","constantName":"org.apache.camel.component.smpp.SmppConstants#SYSTEM_ID"},"CamelSmppPassword":{"index":37,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password.","constantName":"org.apache.camel.component.smpp.SmppConstants#PASSWORD"},"CamelSmppValidityPeriod":{"index":38,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and ReplaceSm The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. If it's provided as Date, it's interpreted as absolute time or relative time format if you provide it as String as specified in chapter 7.1.1 in the smpp specification v3.4. Consumer: only for DeliverSm The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. It can be defined in absolute time format or relative time format. The encoding of absolute and relative time format is specified in Section 7.1.1 in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#VALIDITY_PERIOD"},"CamelSmppOptionalParameters":{"index":39,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"Use CamelSmppOptionalParameter instead","autowired":false,"secret":false,"description":"The optional parameters by name. Deprecation note: Use CamelSmppOptionalParameter instead","constantName":"org.apache.camel.component.smpp.SmppConstants#OPTIONAL_PARAMETERS"},"CamelSmppOptionalParameter":{"index":40,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and DataSm The optional parameter which are send to the SMSC. The value is converted in the following way: String - org.jsmpp.bean.OptionalParameter.COctetString, byte - org.jsmpp.bean.OptionalParameter.OctetString, Byte - org.jsmpp.bean.OptionalParameter.Byte, Integer - org.jsmpp.bean.OptionalParameter.Int, Short - org.jsmpp.bean.OptionalParameter.Short, null - org.jsmpp.bean.OptionalParameter.Null Consumer: only for DeliverSm The optional parameters send back by the SMSC. The key is the Short code for the optional parameter. The value is converted in the following way: org.jsmpp.bean.OptionalParameter.COctetString - String, org.jsmpp.bean.OptionalParameter.OctetString - byte, org.jsmpp.bean.OptionalParameter.Byte - Byte, org.jsmpp.bean.OptionalParameter.Int - Integer, org.jsmpp.bean.OptionalParameter.Short - Short, org.jsmpp.bean.OptionalParameter.Null - null","constantName":"org.apache.camel.component.smpp.SmppConstants#OPTIONAL_PARAMETER"},"CamelSmppSplittingPolicy":{"index":41,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti and DataSm. Specifies the policy for message splitting for this exchange. Possible values are described in the endpoint configuration parameter _splittingPolicy_","constantName":"org.apache.camel.component.smpp.SmppConstants#SPLITTING_POLICY"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Hostname for the SMSC server to use."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2775","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Port number for the SMSC server to use."},"initialReconnectDelay":{"index":2,"kind":"parameter","displayName":"Initial Reconnect Delay","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost."},"maxReconnect":{"index":3,"kind":"parameter","displayName":"Max Reconnect","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response"},"reconnectDelay":{"index":4,"kind":"parameter","displayName":"Reconnect Delay","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the interval in milliseconds between the reconnect attempts, if the connection to the SMSC was lost and the previous was not succeed."},"splittingPolicy":{"index":5,"kind":"parameter","displayName":"Splitting Policy","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.smpp.SmppSplittingPolicy","enum":["ALLOW","REJECT","TRUNCATE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ALLOW","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can specify a policy for handling long messages: ALLOW - the default, long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered. REJECT - if a message would need to be split, it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long."},"systemType":{"index":6,"kind":"parameter","displayName":"System Type","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max. 13 characters)."},"addressRange":{"index":7,"kind":"parameter","displayName":"Address Range","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can specify the address range for the SmppConsumer as defined in section 5.2.7 of the SMPP 3.4 specification. The SmppConsumer will receive messages only from SMSC's which target an address (MSISDN or IP address) within this range."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"destAddr":{"index":11,"kind":"parameter","displayName":"Dest Addr","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1717","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS. Only for SubmitSm, SubmitMulti, CancelSm and DataSm."},"destAddrNpi":{"index":12,"kind":"parameter","displayName":"Dest Addr Npi","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"destAddrTon":{"index":13,"kind":"parameter","displayName":"Dest Addr Ton","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"lazySessionCreation":{"index":14,"kind":"parameter","displayName":"Lazy Session Creation","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sessions can be lazily created to avoid exceptions, if the SMSC is not available when the Camel producer is started. Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present, Camel will use these data to connect to the SMSC."},"messageReceiverRouteId":{"index":15,"kind":"parameter","displayName":"Message Receiver Route Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Set this on producer in order to benefit from transceiver (TRX) binding type. So once set, you don't need to define an 'SMTPP consumer' endpoint anymore. You would set this to a 'Direct consumer' endpoint instead. DISCALIMER: This feature is only tested with 'Direct consumer' endpoint. The behavior with any other consumer type is unknown and not tested."},"numberingPlanIndicator":{"index":16,"kind":"parameter","displayName":"Numbering Plan Indicator","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the numeric plan indicator (NPI) to be used in the SME. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"priorityFlag":{"index":17,"kind":"parameter","displayName":"Priority Flag","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Allows the originating SME to assign a priority level to the short message. Only for SubmitSm and SubmitMulti. Four Priority Levels are supported: 0: Level 0 (lowest) priority 1: Level 1 priority 2: Level 2 priority 3: Level 3 (highest) priority"},"protocolId":{"index":18,"kind":"parameter","displayName":"Protocol Id","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The protocol id"},"registeredDelivery":{"index":19,"kind":"parameter","displayName":"Registered Delivery","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined: 0: No SMSC delivery receipt requested. 1: SMSC delivery receipt requested where final delivery outcome is success or failure. 2: SMSC delivery receipt requested where the final delivery outcome is delivery failure."},"replaceIfPresentFlag":{"index":20,"kind":"parameter","displayName":"Replace If Present Flag","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following replace if present flag values are defined: 0: Don't replace 1: Replace"},"serviceType":{"index":21,"kind":"parameter","displayName":"Service Type","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["CMT","CPT","VMN","VMA","WAP","USSD"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The service type parameter can be used to indicate the SMS Application service associated with the message. The following generic service_types are defined: CMT: Cellular Messaging CPT: Cellular Paging VMN: Voice Mail Notification VMA: Voice Mail Alerting WAP: Wireless Application Protocol USSD: Unstructured Supplementary Services Data"},"sourceAddr":{"index":22,"kind":"parameter","displayName":"Source Addr","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1616","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the address of SME (Short Message Entity) which originated this message."},"sourceAddrNpi":{"index":23,"kind":"parameter","displayName":"Source Addr Npi","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"sourceAddrTon":{"index":24,"kind":"parameter","displayName":"Source Addr Ton","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"typeOfNumber":{"index":25,"kind":"parameter","displayName":"Type Of Number","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"lazyStartProducer":{"index":26,"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."},"enquireLinkTimer":{"index":27,"kind":"parameter","displayName":"Enquire Link Timer","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the interval in milliseconds between the confidence checks. The confidence check is used to test the communication path between an ESME and an SMSC."},"interfaceVersion":{"index":28,"kind":"parameter","displayName":"Interface Version","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["legacy","3.3","3.4","5.0"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"3.4","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the interface version to be used in the binding request with the SMSC. The following values are allowed, as defined in the SMPP protocol (and the underlying implementation using the jSMPP library, respectively): legacy (0x00), 3.3 (0x33), 3.4 (0x34), and 5.0 (0x50). The default (fallback) value is version 3.4."},"pduProcessorDegree":{"index":29,"kind":"parameter","displayName":"Pdu Processor Degree","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sets the number of threads which can read PDU and process them in parallel."},"pduProcessorQueueCapacity":{"index":30,"kind":"parameter","displayName":"Pdu Processor Queue Capacity","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sets the capacity of the working queue for PDU processing."},"sessionStateListener":{"index":31,"kind":"parameter","displayName":"Session State Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.jsmpp.session.SessionStateListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed."},"singleDLR":{"index":32,"kind":"parameter","displayName":"Single DLR","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"When true, the SMSC delivery receipt would be requested only for the last segment of a multi-segment (long) message. For short messages, with only 1 segment the behaviour is unchanged."},"transactionTimer":{"index":33,"kind":"parameter","displayName":"Transaction Timer","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the maximum period of inactivity allowed after a transaction, after which an SMPP entity may assume that the session is no longer active. This timer may be active on either communicating SMPP entity (i.e. SMSC or ESME)."},"alphabet":{"index":34,"kind":"parameter","displayName":"Alphabet","group":"codec","label":"codec","required":false,"type":"integer","javaType":"byte","enum":["0","4","8"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2 Alphabet"},"dataCoding":{"index":35,"kind":"parameter","displayName":"Data Coding","group":"codec","label":"codec","required":false,"type":"integer","javaType":"byte","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the data coding according the SMPP 3.4 specification, section 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2 (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990)"},"encoding":{"index":36,"kind":"parameter","displayName":"Encoding","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ISO-8859-1","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the encoding scheme of the short message user data. Only for SubmitSm, ReplaceSm and SubmitMulti."},"httpProxyHost":{"index":37,"kind":"parameter","displayName":"Http Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If you need to tunnel SMPP through a HTTP proxy, set this attribute to the hostname or ip address of your HTTP proxy."},"httpProxyPassword":{"index":38,"kind":"parameter","displayName":"Http Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy."},"httpProxyPort":{"index":39,"kind":"parameter","displayName":"Http Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3128","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy."},"httpProxyUsername":{"index":40,"kind":"parameter","displayName":"Http Proxy Username","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy."},"proxyHeaders":{"index":41,"kind":"parameter","displayName":"Proxy Headers","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"These headers will be passed to the proxy server while establishing the connection."},"password":{"index":42,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The password for connecting to SMSC server."},"systemId":{"index":43,"kind":"parameter","displayName":"System Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"defaultValue":"smppclient","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The system id (username) for connecting to SMSC server."},"usingSSL":{"index":44,"kind":"parameter","displayName":"Using SSL","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Whether using SSL with the smpps protocol"}}} +{"component":{"kind":"component","name":"smpps","title":"SMPP (Secure)","description":"Send and receive SMS messages using a SMSC (Short Message Service Center).","deprecated":false,"firstVersion":"2.2.0","label":"mobile","javaType":"org.apache.camel.component.smpp.SmppComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-smpp","version":"4.8.2","scheme":"smpps","extendsScheme":"","alternativeSchemes":"smpp,smpps","syntax":"smpps:host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelSmppAlphabet":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"For SubmitSm, SubmitMulti and ReplaceSm The data coding according to the SMPP 3.4 specification, section 5.2.19. Use the URI option alphabet settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ALPHABET"},"CamelSmppCommand":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The command","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND"},"CamelSmppCommandId":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification, DeliverSm and DataSm The command id field identifies the particular SMPP PDU. For the complete list of defined values see chapter 5.1.2.1 in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND_ID"},"CamelSmppCommandStatus":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for DataSm The Command status of the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND_STATUS"},"CamelSmppDataCoding":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"For SubmitSm, SubmitMulti and ReplaceSm The data coding according to the SMPP 3.4 specification, section 5.2.19. Use the URI option alphabet settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DATA_CODING"},"CamelSmppSplitter":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.smpp.SmppSplitter","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The splitter","constantName":"org.apache.camel.component.smpp.SmppConstants#DATA_SPLITTER"},"CamelSmppDelivered":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt Number of short messages delivered. This is only relevant where the original message was submitted to a distribution list.The value is padded with leading zeros if necessary.","constantName":"org.apache.camel.component.smpp.SmppConstants#DELIVERED"},"CamelSmppDestAddr":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"List or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the destination SME address(es). For mobile terminated messages, this is the directory number of the recipient MS. It must be a List for SubmitMulti and a String otherwise. Consumer: only for DeliverSm and DataSm: Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR"},"CamelSmppDestAddrNpi":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the numeric plan indicator (NPI) to be used in the SME destination address parameters. Use the URI option sourceAddrNpi values defined above. Consumer: only for DataSm Defines the numeric plan indicator (NPI) in the destination address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR_NPI"},"CamelSmppDestAddrTon":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the type of number (TON) to be used in the SME destination address parameters. Use the sourceAddrTon URI option values defined above. Consumer: only for DataSm Defines the type of number (TON) in the destination address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR_TON"},"CamelSmppDoneDate":{"index":10,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt The time and date at which the short message reached it's final state. The format is as follows: YYMMDDhhmm.","constantName":"org.apache.camel.component.smpp.SmppConstants#DONE_DATE"},"CamelSmppEncoding":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti and DataSm. Specifies the encoding (character set name) of the bytes in the message body. If the message body is a string then this is not relevant because Java Strings are always Unicode. If the body is a byte array then this header can be used to indicate that it is ISO-8859-1 or some other value. Default value is specified by the endpoint configuration parameter _encoding_","constantName":"org.apache.camel.component.smpp.SmppConstants#ENCODING"},"CamelSmppError":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or Map>>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitMultiSm The errors which occurred by sending the short message(s) the form Map (messageID : (destAddr : address, error : errorCode)). Consumer: only for smsc DeliveryReceipt Where appropriate this may hold a Network specific error code or an SMSC error code for the attempted delivery of the message. These errors are Network or SMSC specific and are not included here.","constantName":"org.apache.camel.component.smpp.SmppConstants#ERROR"},"CamelSmppClass":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.jsmpp.bean.ESMClass","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the ASM class","constantName":"org.apache.camel.component.smpp.SmppConstants#ESM_CLASS"},"CamelSmppEsmeAddr":{"index":14,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the destination ESME address. For mobile terminated messages, this is the directory number of the recipient MS.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR"},"CamelSmppEsmeAddrNpi":{"index":15,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the numeric plan indicator (NPI) to be used in the ESME originator address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR_NPI"},"CamelSmppEsmeAddrTon":{"index":16,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the type of number (TON) to be used in the ESME originator address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR_TON"},"CamelSmppFinalDate":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The final date","constantName":"org.apache.camel.component.smpp.SmppConstants#FINAL_DATE"},"CamelSmppStatus":{"index":18,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.jsmpp.util.DeliveryReceiptState","enum":["ENROUTE","DELIVRD","EXPIRED","DELETED","UNDELIV","ACCEPTD","UNKNOWN","REJECTD"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt: The final status of the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#FINAL_STATUS"},"CamelSmppId":{"index":19,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The id to identify the submitted short message(s) for later use. In case of a ReplaceSm, QuerySm, CancelSm and DataSm this header value is a String. In case of a SubmitSm or SubmitMultiSm this header value is a List. Consumer: only for smsc DeliveryReceipt and DataSm The message ID allocated to the message by the SMSC when originally submitted.","constantName":"org.apache.camel.component.smpp.SmppConstants#ID"},"CamelSmppMessageState":{"index":20,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message date","constantName":"org.apache.camel.component.smpp.SmppConstants#MESSAGE_STATE"},"CamelSmppMessageType":{"index":21,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Identifies the type of an incoming message: AlertNotification: an SMSC alert notification, DataSm: an SMSC data short message, DeliveryReceipt: an SMSC delivery receipt, DeliverSm: an SMSC deliver short message","constantName":"org.apache.camel.component.smpp.SmppConstants#MESSAGE_TYPE"},"CamelSmppPriorityFlag":{"index":22,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMulti Allows the originating SME to assign a priority level to the short message. Use the URI option priorityFlag settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#PRIORITY_FLAG"},"CamelSmppProtocolId":{"index":23,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The protocol id","constantName":"org.apache.camel.component.smpp.SmppConstants#PROTOCOL_ID"},"CamelSmppRegisteredDelivery":{"index":24,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, ReplaceSm, SubmitMulti and DataSm Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. Use the URI option registeredDelivery settings above. Consumer: only for DataSm Is used to request an delivery receipt and/or SME originated acknowledgements. Same values as in Producer header list above.","constantName":"org.apache.camel.component.smpp.SmppConstants#REGISTERED_DELIVERY"},"CamelSmppSingleDLR":{"index":25,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti Is used to request the SMSC delivery receipt only on the last segment of multi-segment (long) messages. Use the URI option singleDLR settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SINGLE_DLR"},"CamelSmppReplaceIfPresentFlag":{"index":26,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMulti The replace if present flag parameter is used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following values are defined: 0, Don't replace and 1, Replace","constantName":"org.apache.camel.component.smpp.SmppConstants#REPLACE_IF_PRESENT_FLAG"},"CamelSmppScheduleDeliveryTime":{"index":27,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and ReplaceSm This parameter specifies the scheduled time at which the message delivery should be first attempted. It defines either the absolute date and time or relative time from the current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time format is specified in chapter 7.1.1. in the smpp specification v3.4. Consumer: only for DeliverSm: This parameter specifies the scheduled time at which the message delivery should be first attempted. It defines either the absolute date and time or relative time from the current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time format is specified in Section 7.1.1. in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#SCHEDULE_DELIVERY_TIME"},"CamelSmppSentMessageCount":{"index":28,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMultiSm The total number of messages which has been sent.","constantName":"org.apache.camel.component.smpp.SmppConstants#SENT_MESSAGE_COUNT"},"CamelSmppSequenceNumber":{"index":29,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification, DeliverSm and DataSm A sequence number allows a response PDU to be correlated with a request PDU. The associated SMPP response PDU must preserve this field.","constantName":"org.apache.camel.component.smpp.SmppConstants#SEQUENCE_NUMBER"},"CamelSmppServiceType":{"index":30,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The service type parameter can be used to indicate the SMS Application service associated with the message. Use the URI option serviceType settings above. Consumer: only for DeliverSm and DataSm The service type parameter indicates the SMS Application service associated with the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#SERVICE_TYPE"},"CamelSmppSourceAddr":{"index":31,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the address of SME (Short Message Entity) which originated this message. Consumer: Only for AlertNotification, DeliverSm and DataSm Defines the address of SME (Short Message Entity) which originated this message.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR"},"CamelSmppSourceAddrNpi":{"index":32,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Use the URI option sourceAddrNpi values defined above. Consumer: only for AlertNotification and DataSm Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR_NPI"},"CamelSmppSourceAddrTon":{"index":33,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the type of number (TON) to be used in the SME originator address parameters. Use the sourceAddrTon URI option values defined above. Consumer: only for AlertNotification and DataSm Defines the type of number (TON) to be used in the SME originator address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR_TON"},"CamelSmppSubmitted":{"index":34,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt Number of short messages originally submitted. This is only relevant when the original message was submitted to a distribution list.The value is padded with leading zeros if necessary.","constantName":"org.apache.camel.component.smpp.SmppConstants#SUBMITTED"},"CamelSmppSubmitDate":{"index":35,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt The time and date at which the short message was submitted. In the case of a message which has been replaced, this is the date that the original message was replaced. The format is as follows: YYMMDDhhmm.","constantName":"org.apache.camel.component.smpp.SmppConstants#SUBMIT_DATE"},"CamelSmppSystemId":{"index":36,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The system id.","constantName":"org.apache.camel.component.smpp.SmppConstants#SYSTEM_ID"},"CamelSmppPassword":{"index":37,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password.","constantName":"org.apache.camel.component.smpp.SmppConstants#PASSWORD"},"CamelSmppValidityPeriod":{"index":38,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and ReplaceSm The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. If it's provided as Date, it's interpreted as absolute time or relative time format if you provide it as String as specified in chapter 7.1.1 in the smpp specification v3.4. Consumer: only for DeliverSm The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. It can be defined in absolute time format or relative time format. The encoding of absolute and relative time format is specified in Section 7.1.1 in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#VALIDITY_PERIOD"},"CamelSmppOptionalParameters":{"index":39,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"Use CamelSmppOptionalParameter instead","autowired":false,"secret":false,"description":"The optional parameters by name. Deprecation note: Use CamelSmppOptionalParameter instead","constantName":"org.apache.camel.component.smpp.SmppConstants#OPTIONAL_PARAMETERS"},"CamelSmppOptionalParameter":{"index":40,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and DataSm The optional parameter which are send to the SMSC. The value is converted in the following way: String - org.jsmpp.bean.OptionalParameter.COctetString, byte - org.jsmpp.bean.OptionalParameter.OctetString, Byte - org.jsmpp.bean.OptionalParameter.Byte, Integer - org.jsmpp.bean.OptionalParameter.Int, Short - org.jsmpp.bean.OptionalParameter.Short, null - org.jsmpp.bean.OptionalParameter.Null Consumer: only for DeliverSm The optional parameters send back by the SMSC. The key is the Short code for the optional parameter. The value is converted in the following way: org.jsmpp.bean.OptionalParameter.COctetString - String, org.jsmpp.bean.OptionalParameter.OctetString - byte, org.jsmpp.bean.OptionalParameter.Byte - Byte, org.jsmpp.bean.OptionalParameter.Int - Integer, org.jsmpp.bean.OptionalParameter.Short - Short, org.jsmpp.bean.OptionalParameter.Null - null","constantName":"org.apache.camel.component.smpp.SmppConstants#OPTIONAL_PARAMETER"},"CamelSmppSplittingPolicy":{"index":41,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti and DataSm. Specifies the policy for message splitting for this exchange. Possible values are described in the endpoint configuration parameter _splittingPolicy_","constantName":"org.apache.camel.component.smpp.SmppConstants#SPLITTING_POLICY"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Hostname for the SMSC server to use."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2775","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Port number for the SMSC server to use."},"initialReconnectDelay":{"index":2,"kind":"parameter","displayName":"Initial Reconnect Delay","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost."},"maxReconnect":{"index":3,"kind":"parameter","displayName":"Max Reconnect","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response"},"reconnectDelay":{"index":4,"kind":"parameter","displayName":"Reconnect Delay","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the interval in milliseconds between the reconnect attempts, if the connection to the SMSC was lost and the previous was not succeed."},"splittingPolicy":{"index":5,"kind":"parameter","displayName":"Splitting Policy","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.smpp.SmppSplittingPolicy","enum":["ALLOW","REJECT","TRUNCATE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ALLOW","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can specify a policy for handling long messages: ALLOW - the default, long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered. REJECT - if a message would need to be split, it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long."},"systemType":{"index":6,"kind":"parameter","displayName":"System Type","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max. 13 characters)."},"addressRange":{"index":7,"kind":"parameter","displayName":"Address Range","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can specify the address range for the SmppConsumer as defined in section 5.2.7 of the SMPP 3.4 specification. The SmppConsumer will receive messages only from SMSC's which target an address (MSISDN or IP address) within this range."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"destAddr":{"index":11,"kind":"parameter","displayName":"Dest Addr","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1717","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS. Only for SubmitSm, SubmitMulti, CancelSm and DataSm."},"destAddrNpi":{"index":12,"kind":"parameter","displayName":"Dest Addr Npi","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"destAddrTon":{"index":13,"kind":"parameter","displayName":"Dest Addr Ton","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"lazySessionCreation":{"index":14,"kind":"parameter","displayName":"Lazy Session Creation","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sessions can be lazily created to avoid exceptions, if the SMSC is not available when the Camel producer is started. Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present, Camel will use these data to connect to the SMSC."},"messageReceiverRouteId":{"index":15,"kind":"parameter","displayName":"Message Receiver Route Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Set this on producer in order to benefit from transceiver (TRX) binding type. So once set, you don't need to define an 'SMTPP consumer' endpoint anymore. You would set this to a 'Direct consumer' endpoint instead. DISCALIMER: This feature is only tested with 'Direct consumer' endpoint. The behavior with any other consumer type is unknown and not tested."},"numberingPlanIndicator":{"index":16,"kind":"parameter","displayName":"Numbering Plan Indicator","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the numeric plan indicator (NPI) to be used in the SME. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"priorityFlag":{"index":17,"kind":"parameter","displayName":"Priority Flag","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Allows the originating SME to assign a priority level to the short message. Only for SubmitSm and SubmitMulti. Four Priority Levels are supported: 0: Level 0 (lowest) priority 1: Level 1 priority 2: Level 2 priority 3: Level 3 (highest) priority"},"protocolId":{"index":18,"kind":"parameter","displayName":"Protocol Id","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The protocol id"},"registeredDelivery":{"index":19,"kind":"parameter","displayName":"Registered Delivery","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined: 0: No SMSC delivery receipt requested. 1: SMSC delivery receipt requested where final delivery outcome is success or failure. 2: SMSC delivery receipt requested where the final delivery outcome is delivery failure."},"replaceIfPresentFlag":{"index":20,"kind":"parameter","displayName":"Replace If Present Flag","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following replace if present flag values are defined: 0: Don't replace 1: Replace"},"serviceType":{"index":21,"kind":"parameter","displayName":"Service Type","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["CMT","CPT","VMN","VMA","WAP","USSD"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The service type parameter can be used to indicate the SMS Application service associated with the message. The following generic service_types are defined: CMT: Cellular Messaging CPT: Cellular Paging VMN: Voice Mail Notification VMA: Voice Mail Alerting WAP: Wireless Application Protocol USSD: Unstructured Supplementary Services Data"},"sourceAddr":{"index":22,"kind":"parameter","displayName":"Source Addr","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1616","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the address of SME (Short Message Entity) which originated this message."},"sourceAddrNpi":{"index":23,"kind":"parameter","displayName":"Source Addr Npi","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"sourceAddrTon":{"index":24,"kind":"parameter","displayName":"Source Addr Ton","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"typeOfNumber":{"index":25,"kind":"parameter","displayName":"Type Of Number","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"lazyStartProducer":{"index":26,"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."},"enquireLinkTimer":{"index":27,"kind":"parameter","displayName":"Enquire Link Timer","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the interval in milliseconds between the confidence checks. The confidence check is used to test the communication path between an ESME and an SMSC."},"interfaceVersion":{"index":28,"kind":"parameter","displayName":"Interface Version","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["legacy","3.3","3.4","5.0"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"3.4","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the interface version to be used in the binding request with the SMSC. The following values are allowed, as defined in the SMPP protocol (and the underlying implementation using the jSMPP library, respectively): legacy (0x00), 3.3 (0x33), 3.4 (0x34), and 5.0 (0x50). The default (fallback) value is version 3.4."},"pduProcessorDegree":{"index":29,"kind":"parameter","displayName":"Pdu Processor Degree","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sets the number of threads which can read PDU and process them in parallel."},"pduProcessorQueueCapacity":{"index":30,"kind":"parameter","displayName":"Pdu Processor Queue Capacity","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sets the capacity of the working queue for PDU processing."},"sessionStateListener":{"index":31,"kind":"parameter","displayName":"Session State Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.jsmpp.session.SessionStateListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed."},"singleDLR":{"index":32,"kind":"parameter","displayName":"Single DLR","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"When true, the SMSC delivery receipt would be requested only for the last segment of a multi-segment (long) message. For short messages, with only 1 segment the behaviour is unchanged."},"transactionTimer":{"index":33,"kind":"parameter","displayName":"Transaction Timer","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the maximum period of inactivity allowed after a transaction, after which an SMPP entity may assume that the session is no longer active. This timer may be active on either communicating SMPP entity (i.e. SMSC or ESME)."},"alphabet":{"index":34,"kind":"parameter","displayName":"Alphabet","group":"codec","label":"codec","required":false,"type":"integer","javaType":"byte","enum":["0","4","8"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2 Alphabet"},"dataCoding":{"index":35,"kind":"parameter","displayName":"Data Coding","group":"codec","label":"codec","required":false,"type":"integer","javaType":"byte","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the data coding according the SMPP 3.4 specification, section 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2 (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990)"},"encoding":{"index":36,"kind":"parameter","displayName":"Encoding","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ISO-8859-1","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the encoding scheme of the short message user data. Only for SubmitSm, ReplaceSm and SubmitMulti."},"httpProxyHost":{"index":37,"kind":"parameter","displayName":"Http Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If you need to tunnel SMPP through a HTTP proxy, set this attribute to the hostname or ip address of your HTTP proxy."},"httpProxyPassword":{"index":38,"kind":"parameter","displayName":"Http Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy."},"httpProxyPort":{"index":39,"kind":"parameter","displayName":"Http Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3128","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy."},"httpProxyUsername":{"index":40,"kind":"parameter","displayName":"Http Proxy Username","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy."},"proxyHeaders":{"index":41,"kind":"parameter","displayName":"Proxy Headers","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"These headers will be passed to the proxy server while establishing the connection."},"password":{"index":42,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The password for connecting to SMSC server."},"systemId":{"index":43,"kind":"parameter","displayName":"System Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"defaultValue":"smppclient","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The system id (username) for connecting to SMSC server."},"usingSSL":{"index":44,"kind":"parameter","displayName":"Using SSL","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Whether using SSL with the smpps protocol"}}} , -{"component":{"kind":"component","name":"smtp","title":"SMTP","description":"Send and receive emails using imap, pop3 and smtp protocols.","deprecated":false,"firstVersion":"1.0.0","label":"mail","javaType":"org.apache.camel.component.mail.MailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mail","version":"4.8.1","scheme":"smtp","extendsScheme":"","alternativeSchemes":"imap,imaps,pop3,pop3s,smtp,smtps","syntax":"smtp:host:port","alternativeSyntax":"smtp:username:password@host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"Subject":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Subject","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_SUBJECT"},"From":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"From","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_FROM"},"To":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_TO"},"Cc":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CC"},"Bcc":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Bcc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_BCC"},"Reply-To":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reply to","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_REPLY_TO"},"contentType":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CONTENT_TYPE"},"copyTo":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be copied to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_COPY_TO"},"moveTo":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be moved to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MOVE_TO"},"delete":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Deletes the messages after they have been processed.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_DELETE"},"CamelMailMessageId":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message ID.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MESSAGE_ID"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail server host name"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The port number of the mail server"},"closeFolder":{"index":2,"kind":"parameter","displayName":"Close Folder","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keeps the folder open between polls."},"copyTo":{"index":3,"kind":"parameter","displayName":"Copy To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime."},"decodeFilename":{"index":4,"kind":"parameter","displayName":"Decode Filename","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If set to true, the MimeUtility.decodeText method will be used to decode the filename. This is similar to setting JVM system property mail.mime.encodefilename."},"delete":{"index":5,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. You can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not."},"disconnect":{"index":6,"kind":"parameter","displayName":"Disconnect","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should disconnect after polling. If enabled, this forces Camel to connect on each poll."},"handleFailedMessage":{"index":7,"kind":"parameter","displayName":"Handle Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows handling the caused exception by the consumer's error handler. By enabling the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"maxMessagesPerPoll":{"index":8,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option."},"mimeDecodeHeaders":{"index":9,"kind":"parameter","displayName":"Mime Decode Headers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"This option enables transparent MIME decoding and unfolding for mail headers."},"moveTo":{"index":10,"kind":"parameter","displayName":"Move To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be moved to a mail folder with the given name. You can override this configuration value with a header with the key moveTo, allowing you to move messages to folder names configured at runtime."},"peek":{"index":11,"kind":"parameter","displayName":"Peek","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Will mark the jakarta.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek, the mail will not be eagerly marked as SEEN on the mail server, which allows us to roll back the mail message if there is a processing error in Camel."},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skipFailedMessage":{"index":13,"kind":"parameter","displayName":"Skip Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows skipping the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"unseen":{"index":14,"kind":"parameter","displayName":"Unseen","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to limit by unseen mails only."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"failOnDuplicateFileAttachment":{"index":18,"kind":"parameter","displayName":"Fail On Duplicate File Attachment","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to fail processing the mail if the mail message contains attachments with duplicate file names. If set to false, then the duplicate attachment is skipped and a WARN is logged. If set to true, then an exception is thrown failing to process the mail message."},"fetchSize":{"index":19,"kind":"parameter","displayName":"Fetch Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. The default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all."},"folderName":{"index":20,"kind":"parameter","displayName":"Folder Name","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INBOX","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The folder to poll."},"generateMissingAttachmentNames":{"index":21,"kind":"parameter","displayName":"Generate Missing Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set this to 'uuid' to set a UUID for the filename of the attachment if no filename was set"},"handleDuplicateAttachmentNames":{"index":22,"kind":"parameter","displayName":"Handle Duplicate Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set the strategy to handle duplicate filenames of attachments never: attachments that have a filename which is already present in the attachments will be ignored unless failOnDuplicateFileAttachment is set to true. uuidPrefix: this will prefix the duplicate attachment filenames each with an uuid and underscore (uuid_filename.fileextension). uuidSuffix: this will suffix the duplicate attachment filenames each with an underscore and uuid (filename_uuid.fileextension)."},"mailUidGenerator":{"index":23,"kind":"parameter","displayName":"Mail Uid Generator","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailUidGenerator","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message."},"mapMailMessage":{"index":24,"kind":"parameter","displayName":"Map Mail Message","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. If this option is set to false, then the IN message contains a raw jakarta.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(jakarta.mail.Message.class)."},"pollStrategy":{"index":25,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"postProcessAction":{"index":26,"kind":"parameter","displayName":"Post Process Action","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBoxPostProcessAction","deprecated":false,"autowired":false,"secret":false,"description":"Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended."},"bcc":{"index":27,"kind":"parameter","displayName":"Bcc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the BCC email address. Separate multiple email addresses with comma."},"cc":{"index":28,"kind":"parameter","displayName":"Cc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the CC email address. Separate multiple email addresses with comma."},"from":{"index":29,"kind":"parameter","displayName":"From","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel@localhost","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The from email address"},"replyTo":{"index":30,"kind":"parameter","displayName":"Reply To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma."},"subject":{"index":31,"kind":"parameter","displayName":"Subject","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option."},"to":{"index":32,"kind":"parameter","displayName":"To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the destination email address. Separate multiple email addresses with comma."},"javaMailSender":{"index":33,"kind":"parameter","displayName":"Java Mail Sender","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.JavaMailSender","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails."},"lazyStartProducer":{"index":34,"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."},"additionalJavaMailProperties":{"index":35,"kind":"parameter","displayName":"Additional Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","prefix":"mail.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets additional java mail properties, that will append/override any default properties that are set based on all the other options. This is useful if you need to add some special options but want to keep the others as is."},"alternativeBodyHeader":{"index":36,"kind":"parameter","displayName":"Alternative Body Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelMailAlternativeBody","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header."},"attachmentsContentTransferEncodingResolver":{"index":37,"kind":"parameter","displayName":"Attachments Content Transfer Encoding Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments."},"authenticator":{"index":38,"kind":"parameter","displayName":"Authenticator","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailAuthenticator","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The authenticator for login. If set then the password and username are ignored. It can be used for tokens which can expire and therefore must be read dynamically."},"binding":{"index":39,"kind":"parameter","displayName":"Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBinding","deprecated":false,"autowired":false,"secret":false,"description":"Sets the binding used to convert from a Camel message to and from a Mail message"},"connectionTimeout":{"index":40,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The connection timeout in milliseconds."},"contentType":{"index":41,"kind":"parameter","displayName":"Content Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"text/plain","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail message content type. Use text/html for HTML mails."},"contentTypeResolver":{"index":42,"kind":"parameter","displayName":"Content Type Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.ContentTypeResolver","deprecated":false,"autowired":false,"secret":false,"description":"Resolver to determine Content-Type for file attachments."},"debugMode":{"index":43,"kind":"parameter","displayName":"Debug Mode","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default."},"headerFilterStrategy":{"index":44,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."},"ignoreUnsupportedCharset":{"index":45,"kind":"parameter","displayName":"Ignore Unsupported Charset","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"ignoreUriScheme":{"index":46,"kind":"parameter","displayName":"Ignore Uri Scheme","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"javaMailProperties":{"index":47,"kind":"parameter","displayName":"Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the java mail options. Will clear any default properties and only use the properties provided for this method."},"session":{"index":48,"kind":"parameter","displayName":"Session","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.mail.Session","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session)."},"useInlineAttachments":{"index":49,"kind":"parameter","displayName":"Use Inline Attachments","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to use disposition inline or attachment."},"idempotentRepository":{"index":50,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use."},"idempotentRepositoryRemoveOnCommit":{"index":51,"kind":"parameter","displayName":"Idempotent Repository Remove On Commit","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have."},"searchTerm":{"index":52,"kind":"parameter","displayName":"Search Term","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"jakarta.mail.search.SearchTerm","prefix":"searchTerm.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Refers to a jakarta.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc."},"backoffErrorThreshold":{"index":53,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":54,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":55,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":56,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Milliseconds before the next poll."},"greedy":{"index":57,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":58,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":59,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":60,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":61,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":62,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":63,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":64,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":65,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":66,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":67,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The password for login. See also setAuthenticator(MailAuthenticator)."},"sslContextParameters":{"index":68,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters."},"username":{"index":69,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The username for login. See also setAuthenticator(MailAuthenticator)."},"sortTerm":{"index":70,"kind":"parameter","displayName":"Sort Term","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"org.eclipse.angus.mail.imap.SortTerm[]","deprecated":false,"autowired":false,"secret":false,"description":"Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability."}}} +{"component":{"kind":"component","name":"smtp","title":"SMTP","description":"Send and receive emails using imap, pop3 and smtp protocols.","deprecated":false,"firstVersion":"1.0.0","label":"mail","javaType":"org.apache.camel.component.mail.MailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mail","version":"4.8.2","scheme":"smtp","extendsScheme":"","alternativeSchemes":"imap,imaps,pop3,pop3s,smtp,smtps","syntax":"smtp:host:port","alternativeSyntax":"smtp:username:password@host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"Subject":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Subject","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_SUBJECT"},"From":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"From","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_FROM"},"To":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_TO"},"Cc":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CC"},"Bcc":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Bcc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_BCC"},"Reply-To":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reply to","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_REPLY_TO"},"contentType":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CONTENT_TYPE"},"copyTo":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be copied to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_COPY_TO"},"moveTo":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be moved to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MOVE_TO"},"delete":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Deletes the messages after they have been processed.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_DELETE"},"CamelMailMessageId":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message ID.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MESSAGE_ID"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail server host name"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The port number of the mail server"},"closeFolder":{"index":2,"kind":"parameter","displayName":"Close Folder","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keeps the folder open between polls."},"copyTo":{"index":3,"kind":"parameter","displayName":"Copy To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime."},"decodeFilename":{"index":4,"kind":"parameter","displayName":"Decode Filename","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If set to true, the MimeUtility.decodeText method will be used to decode the filename. This is similar to setting JVM system property mail.mime.encodefilename."},"delete":{"index":5,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. You can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not."},"disconnect":{"index":6,"kind":"parameter","displayName":"Disconnect","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should disconnect after polling. If enabled, this forces Camel to connect on each poll."},"handleFailedMessage":{"index":7,"kind":"parameter","displayName":"Handle Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows handling the caused exception by the consumer's error handler. By enabling the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"maxMessagesPerPoll":{"index":8,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option."},"mimeDecodeHeaders":{"index":9,"kind":"parameter","displayName":"Mime Decode Headers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"This option enables transparent MIME decoding and unfolding for mail headers."},"moveTo":{"index":10,"kind":"parameter","displayName":"Move To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be moved to a mail folder with the given name. You can override this configuration value with a header with the key moveTo, allowing you to move messages to folder names configured at runtime."},"peek":{"index":11,"kind":"parameter","displayName":"Peek","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Will mark the jakarta.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek, the mail will not be eagerly marked as SEEN on the mail server, which allows us to roll back the mail message if there is a processing error in Camel."},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skipFailedMessage":{"index":13,"kind":"parameter","displayName":"Skip Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows skipping the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"unseen":{"index":14,"kind":"parameter","displayName":"Unseen","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to limit by unseen mails only."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"failOnDuplicateFileAttachment":{"index":18,"kind":"parameter","displayName":"Fail On Duplicate File Attachment","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to fail processing the mail if the mail message contains attachments with duplicate file names. If set to false, then the duplicate attachment is skipped and a WARN is logged. If set to true, then an exception is thrown failing to process the mail message."},"fetchSize":{"index":19,"kind":"parameter","displayName":"Fetch Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. The default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all."},"folderName":{"index":20,"kind":"parameter","displayName":"Folder Name","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INBOX","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The folder to poll."},"generateMissingAttachmentNames":{"index":21,"kind":"parameter","displayName":"Generate Missing Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set this to 'uuid' to set a UUID for the filename of the attachment if no filename was set"},"handleDuplicateAttachmentNames":{"index":22,"kind":"parameter","displayName":"Handle Duplicate Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set the strategy to handle duplicate filenames of attachments never: attachments that have a filename which is already present in the attachments will be ignored unless failOnDuplicateFileAttachment is set to true. uuidPrefix: this will prefix the duplicate attachment filenames each with an uuid and underscore (uuid_filename.fileextension). uuidSuffix: this will suffix the duplicate attachment filenames each with an underscore and uuid (filename_uuid.fileextension)."},"mailUidGenerator":{"index":23,"kind":"parameter","displayName":"Mail Uid Generator","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailUidGenerator","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message."},"mapMailMessage":{"index":24,"kind":"parameter","displayName":"Map Mail Message","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. If this option is set to false, then the IN message contains a raw jakarta.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(jakarta.mail.Message.class)."},"pollStrategy":{"index":25,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"postProcessAction":{"index":26,"kind":"parameter","displayName":"Post Process Action","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBoxPostProcessAction","deprecated":false,"autowired":false,"secret":false,"description":"Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended."},"bcc":{"index":27,"kind":"parameter","displayName":"Bcc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the BCC email address. Separate multiple email addresses with comma."},"cc":{"index":28,"kind":"parameter","displayName":"Cc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the CC email address. Separate multiple email addresses with comma."},"from":{"index":29,"kind":"parameter","displayName":"From","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel@localhost","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The from email address"},"replyTo":{"index":30,"kind":"parameter","displayName":"Reply To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma."},"subject":{"index":31,"kind":"parameter","displayName":"Subject","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option."},"to":{"index":32,"kind":"parameter","displayName":"To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the destination email address. Separate multiple email addresses with comma."},"javaMailSender":{"index":33,"kind":"parameter","displayName":"Java Mail Sender","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.JavaMailSender","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails."},"lazyStartProducer":{"index":34,"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."},"additionalJavaMailProperties":{"index":35,"kind":"parameter","displayName":"Additional Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","prefix":"mail.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets additional java mail properties, that will append/override any default properties that are set based on all the other options. This is useful if you need to add some special options but want to keep the others as is."},"alternativeBodyHeader":{"index":36,"kind":"parameter","displayName":"Alternative Body Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelMailAlternativeBody","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header."},"attachmentsContentTransferEncodingResolver":{"index":37,"kind":"parameter","displayName":"Attachments Content Transfer Encoding Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments."},"authenticator":{"index":38,"kind":"parameter","displayName":"Authenticator","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailAuthenticator","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The authenticator for login. If set then the password and username are ignored. It can be used for tokens which can expire and therefore must be read dynamically."},"binding":{"index":39,"kind":"parameter","displayName":"Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBinding","deprecated":false,"autowired":false,"secret":false,"description":"Sets the binding used to convert from a Camel message to and from a Mail message"},"connectionTimeout":{"index":40,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The connection timeout in milliseconds."},"contentType":{"index":41,"kind":"parameter","displayName":"Content Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"text/plain","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail message content type. Use text/html for HTML mails."},"contentTypeResolver":{"index":42,"kind":"parameter","displayName":"Content Type Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.ContentTypeResolver","deprecated":false,"autowired":false,"secret":false,"description":"Resolver to determine Content-Type for file attachments."},"debugMode":{"index":43,"kind":"parameter","displayName":"Debug Mode","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default."},"headerFilterStrategy":{"index":44,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."},"ignoreUnsupportedCharset":{"index":45,"kind":"parameter","displayName":"Ignore Unsupported Charset","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"ignoreUriScheme":{"index":46,"kind":"parameter","displayName":"Ignore Uri Scheme","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"javaMailProperties":{"index":47,"kind":"parameter","displayName":"Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the java mail options. Will clear any default properties and only use the properties provided for this method."},"session":{"index":48,"kind":"parameter","displayName":"Session","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.mail.Session","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session)."},"useInlineAttachments":{"index":49,"kind":"parameter","displayName":"Use Inline Attachments","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to use disposition inline or attachment."},"idempotentRepository":{"index":50,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use."},"idempotentRepositoryRemoveOnCommit":{"index":51,"kind":"parameter","displayName":"Idempotent Repository Remove On Commit","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have."},"searchTerm":{"index":52,"kind":"parameter","displayName":"Search Term","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"jakarta.mail.search.SearchTerm","prefix":"searchTerm.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Refers to a jakarta.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc."},"backoffErrorThreshold":{"index":53,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":54,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":55,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":56,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Milliseconds before the next poll."},"greedy":{"index":57,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":58,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":59,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":60,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":61,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":62,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":63,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":64,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":65,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":66,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":67,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The password for login. See also setAuthenticator(MailAuthenticator)."},"sslContextParameters":{"index":68,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters."},"username":{"index":69,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The username for login. See also setAuthenticator(MailAuthenticator)."},"sortTerm":{"index":70,"kind":"parameter","displayName":"Sort Term","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"org.eclipse.angus.mail.imap.SortTerm[]","deprecated":false,"autowired":false,"secret":false,"description":"Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability."}}} , -{"component":{"kind":"component","name":"smtps","title":"SMTPS","description":"Send and receive emails using imap, pop3 and smtp protocols.","deprecated":false,"firstVersion":"1.0.0","label":"mail","javaType":"org.apache.camel.component.mail.MailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mail","version":"4.8.1","scheme":"smtps","extendsScheme":"","alternativeSchemes":"imap,imaps,pop3,pop3s,smtp,smtps","syntax":"smtps:host:port","alternativeSyntax":"smtps:username:password@host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"Subject":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Subject","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_SUBJECT"},"From":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"From","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_FROM"},"To":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_TO"},"Cc":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CC"},"Bcc":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Bcc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_BCC"},"Reply-To":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reply to","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_REPLY_TO"},"contentType":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CONTENT_TYPE"},"copyTo":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be copied to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_COPY_TO"},"moveTo":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be moved to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MOVE_TO"},"delete":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Deletes the messages after they have been processed.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_DELETE"},"CamelMailMessageId":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message ID.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MESSAGE_ID"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail server host name"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The port number of the mail server"},"closeFolder":{"index":2,"kind":"parameter","displayName":"Close Folder","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keeps the folder open between polls."},"copyTo":{"index":3,"kind":"parameter","displayName":"Copy To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime."},"decodeFilename":{"index":4,"kind":"parameter","displayName":"Decode Filename","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If set to true, the MimeUtility.decodeText method will be used to decode the filename. This is similar to setting JVM system property mail.mime.encodefilename."},"delete":{"index":5,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. You can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not."},"disconnect":{"index":6,"kind":"parameter","displayName":"Disconnect","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should disconnect after polling. If enabled, this forces Camel to connect on each poll."},"handleFailedMessage":{"index":7,"kind":"parameter","displayName":"Handle Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows handling the caused exception by the consumer's error handler. By enabling the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"maxMessagesPerPoll":{"index":8,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option."},"mimeDecodeHeaders":{"index":9,"kind":"parameter","displayName":"Mime Decode Headers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"This option enables transparent MIME decoding and unfolding for mail headers."},"moveTo":{"index":10,"kind":"parameter","displayName":"Move To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be moved to a mail folder with the given name. You can override this configuration value with a header with the key moveTo, allowing you to move messages to folder names configured at runtime."},"peek":{"index":11,"kind":"parameter","displayName":"Peek","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Will mark the jakarta.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek, the mail will not be eagerly marked as SEEN on the mail server, which allows us to roll back the mail message if there is a processing error in Camel."},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skipFailedMessage":{"index":13,"kind":"parameter","displayName":"Skip Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows skipping the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"unseen":{"index":14,"kind":"parameter","displayName":"Unseen","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to limit by unseen mails only."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"failOnDuplicateFileAttachment":{"index":18,"kind":"parameter","displayName":"Fail On Duplicate File Attachment","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to fail processing the mail if the mail message contains attachments with duplicate file names. If set to false, then the duplicate attachment is skipped and a WARN is logged. If set to true, then an exception is thrown failing to process the mail message."},"fetchSize":{"index":19,"kind":"parameter","displayName":"Fetch Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. The default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all."},"folderName":{"index":20,"kind":"parameter","displayName":"Folder Name","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INBOX","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The folder to poll."},"generateMissingAttachmentNames":{"index":21,"kind":"parameter","displayName":"Generate Missing Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set this to 'uuid' to set a UUID for the filename of the attachment if no filename was set"},"handleDuplicateAttachmentNames":{"index":22,"kind":"parameter","displayName":"Handle Duplicate Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set the strategy to handle duplicate filenames of attachments never: attachments that have a filename which is already present in the attachments will be ignored unless failOnDuplicateFileAttachment is set to true. uuidPrefix: this will prefix the duplicate attachment filenames each with an uuid and underscore (uuid_filename.fileextension). uuidSuffix: this will suffix the duplicate attachment filenames each with an underscore and uuid (filename_uuid.fileextension)."},"mailUidGenerator":{"index":23,"kind":"parameter","displayName":"Mail Uid Generator","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailUidGenerator","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message."},"mapMailMessage":{"index":24,"kind":"parameter","displayName":"Map Mail Message","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. If this option is set to false, then the IN message contains a raw jakarta.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(jakarta.mail.Message.class)."},"pollStrategy":{"index":25,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"postProcessAction":{"index":26,"kind":"parameter","displayName":"Post Process Action","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBoxPostProcessAction","deprecated":false,"autowired":false,"secret":false,"description":"Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended."},"bcc":{"index":27,"kind":"parameter","displayName":"Bcc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the BCC email address. Separate multiple email addresses with comma."},"cc":{"index":28,"kind":"parameter","displayName":"Cc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the CC email address. Separate multiple email addresses with comma."},"from":{"index":29,"kind":"parameter","displayName":"From","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel@localhost","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The from email address"},"replyTo":{"index":30,"kind":"parameter","displayName":"Reply To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma."},"subject":{"index":31,"kind":"parameter","displayName":"Subject","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option."},"to":{"index":32,"kind":"parameter","displayName":"To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the destination email address. Separate multiple email addresses with comma."},"javaMailSender":{"index":33,"kind":"parameter","displayName":"Java Mail Sender","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.JavaMailSender","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails."},"lazyStartProducer":{"index":34,"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."},"additionalJavaMailProperties":{"index":35,"kind":"parameter","displayName":"Additional Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","prefix":"mail.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets additional java mail properties, that will append/override any default properties that are set based on all the other options. This is useful if you need to add some special options but want to keep the others as is."},"alternativeBodyHeader":{"index":36,"kind":"parameter","displayName":"Alternative Body Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelMailAlternativeBody","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header."},"attachmentsContentTransferEncodingResolver":{"index":37,"kind":"parameter","displayName":"Attachments Content Transfer Encoding Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments."},"authenticator":{"index":38,"kind":"parameter","displayName":"Authenticator","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailAuthenticator","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The authenticator for login. If set then the password and username are ignored. It can be used for tokens which can expire and therefore must be read dynamically."},"binding":{"index":39,"kind":"parameter","displayName":"Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBinding","deprecated":false,"autowired":false,"secret":false,"description":"Sets the binding used to convert from a Camel message to and from a Mail message"},"connectionTimeout":{"index":40,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The connection timeout in milliseconds."},"contentType":{"index":41,"kind":"parameter","displayName":"Content Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"text/plain","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail message content type. Use text/html for HTML mails."},"contentTypeResolver":{"index":42,"kind":"parameter","displayName":"Content Type Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.ContentTypeResolver","deprecated":false,"autowired":false,"secret":false,"description":"Resolver to determine Content-Type for file attachments."},"debugMode":{"index":43,"kind":"parameter","displayName":"Debug Mode","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default."},"headerFilterStrategy":{"index":44,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."},"ignoreUnsupportedCharset":{"index":45,"kind":"parameter","displayName":"Ignore Unsupported Charset","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"ignoreUriScheme":{"index":46,"kind":"parameter","displayName":"Ignore Uri Scheme","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"javaMailProperties":{"index":47,"kind":"parameter","displayName":"Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the java mail options. Will clear any default properties and only use the properties provided for this method."},"session":{"index":48,"kind":"parameter","displayName":"Session","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.mail.Session","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session)."},"useInlineAttachments":{"index":49,"kind":"parameter","displayName":"Use Inline Attachments","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to use disposition inline or attachment."},"idempotentRepository":{"index":50,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use."},"idempotentRepositoryRemoveOnCommit":{"index":51,"kind":"parameter","displayName":"Idempotent Repository Remove On Commit","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have."},"searchTerm":{"index":52,"kind":"parameter","displayName":"Search Term","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"jakarta.mail.search.SearchTerm","prefix":"searchTerm.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Refers to a jakarta.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc."},"backoffErrorThreshold":{"index":53,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":54,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":55,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":56,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Milliseconds before the next poll."},"greedy":{"index":57,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":58,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":59,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":60,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":61,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":62,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":63,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":64,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":65,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":66,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":67,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The password for login. See also setAuthenticator(MailAuthenticator)."},"sslContextParameters":{"index":68,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters."},"username":{"index":69,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The username for login. See also setAuthenticator(MailAuthenticator)."},"sortTerm":{"index":70,"kind":"parameter","displayName":"Sort Term","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"org.eclipse.angus.mail.imap.SortTerm[]","deprecated":false,"autowired":false,"secret":false,"description":"Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability."}}} +{"component":{"kind":"component","name":"smtps","title":"SMTPS","description":"Send and receive emails using imap, pop3 and smtp protocols.","deprecated":false,"firstVersion":"1.0.0","label":"mail","javaType":"org.apache.camel.component.mail.MailComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mail","version":"4.8.2","scheme":"smtps","extendsScheme":"","alternativeSchemes":"imap,imaps,pop3,pop3s,smtp,smtps","syntax":"smtps:host:port","alternativeSyntax":"smtps:username:password@host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"Subject":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Subject","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_SUBJECT"},"From":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"From","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_FROM"},"To":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_TO"},"Cc":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Cc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CC"},"Bcc":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Bcc","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_BCC"},"Reply-To":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reply to","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_REPLY_TO"},"contentType":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_CONTENT_TYPE"},"copyTo":{"index":7,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be copied to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_COPY_TO"},"moveTo":{"index":8,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"After processing a mail message, it can be moved to a mail folder with the given name.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MOVE_TO"},"delete":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Deletes the messages after they have been processed.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_DELETE"},"CamelMailMessageId":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message ID.","constantName":"org.apache.camel.component.mail.MailConstants#MAIL_MESSAGE_ID"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail server host name"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The port number of the mail server"},"closeFolder":{"index":2,"kind":"parameter","displayName":"Close Folder","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keeps the folder open between polls."},"copyTo":{"index":3,"kind":"parameter","displayName":"Copy To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime."},"decodeFilename":{"index":4,"kind":"parameter","displayName":"Decode Filename","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If set to true, the MimeUtility.decodeText method will be used to decode the filename. This is similar to setting JVM system property mail.mime.encodefilename."},"delete":{"index":5,"kind":"parameter","displayName":"Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. You can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not."},"disconnect":{"index":6,"kind":"parameter","displayName":"Disconnect","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether the consumer should disconnect after polling. If enabled, this forces Camel to connect on each poll."},"handleFailedMessage":{"index":7,"kind":"parameter","displayName":"Handle Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows handling the caused exception by the consumer's error handler. By enabling the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"maxMessagesPerPoll":{"index":8,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option."},"mimeDecodeHeaders":{"index":9,"kind":"parameter","displayName":"Mime Decode Headers","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"This option enables transparent MIME decoding and unfolding for mail headers."},"moveTo":{"index":10,"kind":"parameter","displayName":"Move To","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"After processing a mail message, it can be moved to a mail folder with the given name. You can override this configuration value with a header with the key moveTo, allowing you to move messages to folder names configured at runtime."},"peek":{"index":11,"kind":"parameter","displayName":"Peek","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Will mark the jakarta.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek, the mail will not be eagerly marked as SEEN on the mail server, which allows us to roll back the mail message if there is a processing error in Camel."},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"skipFailedMessage":{"index":13,"kind":"parameter","displayName":"Skip Failed Message","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"If the mail consumer cannot retrieve a given mail message, then this option allows skipping the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."},"unseen":{"index":14,"kind":"parameter","displayName":"Unseen","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to limit by unseen mails only."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"failOnDuplicateFileAttachment":{"index":18,"kind":"parameter","displayName":"Fail On Duplicate File Attachment","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to fail processing the mail if the mail message contains attachments with duplicate file names. If set to false, then the duplicate attachment is skipped and a WARN is logged. If set to true, then an exception is thrown failing to process the mail message."},"fetchSize":{"index":19,"kind":"parameter","displayName":"Fetch Size","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. The default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all."},"folderName":{"index":20,"kind":"parameter","displayName":"Folder Name","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"INBOX","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The folder to poll."},"generateMissingAttachmentNames":{"index":21,"kind":"parameter","displayName":"Generate Missing Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set this to 'uuid' to set a UUID for the filename of the attachment if no filename was set"},"handleDuplicateAttachmentNames":{"index":22,"kind":"parameter","displayName":"Handle Duplicate Attachment Names","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Set the strategy to handle duplicate filenames of attachments never: attachments that have a filename which is already present in the attachments will be ignored unless failOnDuplicateFileAttachment is set to true. uuidPrefix: this will prefix the duplicate attachment filenames each with an uuid and underscore (uuid_filename.fileextension). uuidSuffix: this will suffix the duplicate attachment filenames each with an underscore and uuid (filename_uuid.fileextension)."},"mailUidGenerator":{"index":23,"kind":"parameter","displayName":"Mail Uid Generator","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailUidGenerator","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message."},"mapMailMessage":{"index":24,"kind":"parameter","displayName":"Map Mail Message","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. If this option is set to false, then the IN message contains a raw jakarta.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(jakarta.mail.Message.class)."},"pollStrategy":{"index":25,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"postProcessAction":{"index":26,"kind":"parameter","displayName":"Post Process Action","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBoxPostProcessAction","deprecated":false,"autowired":false,"secret":false,"description":"Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended."},"bcc":{"index":27,"kind":"parameter","displayName":"Bcc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the BCC email address. Separate multiple email addresses with comma."},"cc":{"index":28,"kind":"parameter","displayName":"Cc","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the CC email address. Separate multiple email addresses with comma."},"from":{"index":29,"kind":"parameter","displayName":"From","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel@localhost","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The from email address"},"replyTo":{"index":30,"kind":"parameter","displayName":"Reply To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma."},"subject":{"index":31,"kind":"parameter","displayName":"Subject","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option."},"to":{"index":32,"kind":"parameter","displayName":"To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the destination email address. Separate multiple email addresses with comma."},"javaMailSender":{"index":33,"kind":"parameter","displayName":"Java Mail Sender","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.JavaMailSender","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails."},"lazyStartProducer":{"index":34,"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."},"additionalJavaMailProperties":{"index":35,"kind":"parameter","displayName":"Additional Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","prefix":"mail.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets additional java mail properties, that will append/override any default properties that are set based on all the other options. This is useful if you need to add some special options but want to keep the others as is."},"alternativeBodyHeader":{"index":36,"kind":"parameter","displayName":"Alternative Body Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"CamelMailAlternativeBody","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header."},"attachmentsContentTransferEncodingResolver":{"index":37,"kind":"parameter","displayName":"Attachments Content Transfer Encoding Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments."},"authenticator":{"index":38,"kind":"parameter","displayName":"Authenticator","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailAuthenticator","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The authenticator for login. If set then the password and username are ignored. It can be used for tokens which can expire and therefore must be read dynamically."},"binding":{"index":39,"kind":"parameter","displayName":"Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.MailBinding","deprecated":false,"autowired":false,"secret":false,"description":"Sets the binding used to convert from a Camel message to and from a Mail message"},"connectionTimeout":{"index":40,"kind":"parameter","displayName":"Connection Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The connection timeout in milliseconds."},"contentType":{"index":41,"kind":"parameter","displayName":"Content Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"text/plain","configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The mail message content type. Use text/html for HTML mails."},"contentTypeResolver":{"index":42,"kind":"parameter","displayName":"Content Type Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mail.ContentTypeResolver","deprecated":false,"autowired":false,"secret":false,"description":"Resolver to determine Content-Type for file attachments."},"debugMode":{"index":43,"kind":"parameter","displayName":"Debug Mode","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default."},"headerFilterStrategy":{"index":44,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."},"ignoreUnsupportedCharset":{"index":45,"kind":"parameter","displayName":"Ignore Unsupported Charset","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"ignoreUriScheme":{"index":46,"kind":"parameter","displayName":"Ignore Uri Scheme","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported, then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type, and it relies on the platform default instead."},"javaMailProperties":{"index":47,"kind":"parameter","displayName":"Java Mail Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Sets the java mail options. Will clear any default properties and only use the properties provided for this method."},"session":{"index":48,"kind":"parameter","displayName":"Session","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"jakarta.mail.Session","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session)."},"useInlineAttachments":{"index":49,"kind":"parameter","displayName":"Use Inline Attachments","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"Whether to use disposition inline or attachment."},"idempotentRepository":{"index":50,"kind":"parameter","displayName":"Idempotent Repository","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"org.apache.camel.spi.IdempotentRepository","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use."},"idempotentRepositoryRemoveOnCommit":{"index":51,"kind":"parameter","displayName":"Idempotent Repository Remove On Commit","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have."},"searchTerm":{"index":52,"kind":"parameter","displayName":"Search Term","group":"filter","label":"consumer,filter","required":false,"type":"object","javaType":"jakarta.mail.search.SearchTerm","prefix":"searchTerm.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Refers to a jakarta.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc."},"backoffErrorThreshold":{"index":53,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":54,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":55,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":56,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Milliseconds before the next poll."},"greedy":{"index":57,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":58,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":59,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":60,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":61,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":62,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":63,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":64,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":65,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":66,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":67,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The password for login. See also setAuthenticator(MailAuthenticator)."},"sslContextParameters":{"index":68,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters."},"username":{"index":69,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.mail.MailConfiguration","configurationField":"configuration","description":"The username for login. See also setAuthenticator(MailAuthenticator)."},"sortTerm":{"index":70,"kind":"parameter","displayName":"Sort Term","group":"sort","label":"consumer,sort","required":false,"type":"object","javaType":"org.eclipse.angus.mail.imap.SortTerm[]","deprecated":false,"autowired":false,"secret":false,"description":"Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability."}}} , -{"component":{"kind":"component","name":"snmp","title":"SNMP","description":"Receive traps and poll SNMP (Simple Network Management Protocol) capable devices.","deprecated":false,"firstVersion":"2.1.0","label":"monitoring","javaType":"org.apache.camel.component.snmp.SnmpComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-snmp","version":"4.8.1","scheme":"snmp","extendsScheme":"","syntax":"snmp:host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname of the SNMP enabled device"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Port number of the SNMP enabled device"},"oids":{"index":2,"kind":"parameter","displayName":"Oids","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.snmp.OIDList","deprecated":false,"autowired":false,"secret":false,"description":"Defines which values you are interested in. Please have a look at the Wikipedia to get a better understanding. You may provide a single OID or a coma separated list of OIDs. Example: oids=1.3.6.1.2.1.1.3.0,1.3.6.1.2.1.25.3.2.1.5.1,1.3.6.1.2.1.25.3.5.1.1.1,1.3.6.1.2.1.43.5.1.1.11.1"},"protocol":{"index":3,"kind":"parameter","displayName":"Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["tcp","udp"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"udp","description":"Here you can select which protocol to use. You can use either udp or tcp."},"retries":{"index":4,"kind":"parameter","displayName":"Retries","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"description":"Defines how often a retry is made before canceling the request."},"snmpCommunity":{"index":5,"kind":"parameter","displayName":"Snmp Community","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"public","description":"Sets the community octet string for the snmp request."},"snmpContextEngineId":{"index":6,"kind":"parameter","displayName":"Snmp Context Engine Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the context engine ID field of the scoped PDU."},"snmpContextName":{"index":7,"kind":"parameter","displayName":"Snmp Context Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the context name field of this scoped PDU."},"snmpVersion":{"index":8,"kind":"parameter","displayName":"Snmp Version","group":"common","label":"","required":false,"type":"integer","javaType":"int","enum":["0","1","3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Sets the snmp version for the request. The value 0 means SNMPv1, 1 means SNMPv2c, and the value 3 means SNMPv3"},"timeout":{"index":9,"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1500,"description":"Sets the timeout value for the request in millis."},"type":{"index":10,"kind":"parameter","displayName":"Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.snmp.SnmpActionType","enum":["TRAP","POLL","GET_NEXT"],"deprecated":false,"autowired":false,"secret":false,"description":"Which operation to perform such as poll, trap, etc."},"delay":{"index":11,"kind":"parameter","displayName":"Delay","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Milliseconds before the next poll."},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"treeList":{"index":13,"kind":"parameter","displayName":"Tree List","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets the flag whether the scoped PDU will be displayed as the list if it has child elements in its tree"},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":17,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":18,"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."},"backoffErrorThreshold":{"index":19,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":20,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":21,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"greedy":{"index":22,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":23,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":24,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":25,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":26,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":27,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":28,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":29,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":30,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":31,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"authenticationPassphrase":{"index":32,"kind":"parameter","displayName":"Authentication Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The authentication passphrase. If not null, authenticationProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown."},"authenticationProtocol":{"index":33,"kind":"parameter","displayName":"Authentication Protocol","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","enum":["MD5","SHA1"],"deprecated":false,"autowired":false,"secret":false,"description":"Authentication protocol to use if security level is set to enable authentication The possible values are: MD5, SHA1"},"privacyPassphrase":{"index":34,"kind":"parameter","displayName":"Privacy Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The privacy passphrase. If not null, privacyProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown."},"privacyProtocol":{"index":35,"kind":"parameter","displayName":"Privacy Protocol","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The privacy protocol ID to be associated with this user. If set to null, this user only supports unencrypted messages."},"securityLevel":{"index":36,"kind":"parameter","displayName":"Security Level","group":"security","label":"security","required":false,"type":"integer","javaType":"int","enum":["1","2","3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":3,"description":"Sets the security level for this target. The supplied security level must be supported by the security model dependent information associated with the security name set for this target. The value 1 means: No authentication and no encryption. Anyone can create and read messages with this security level The value 2 means: Authentication and no encryption. Only the one with the right authentication key can create messages with this security level, but anyone can read the contents of the message. The value 3 means: Authentication and encryption. Only the one with the right authentication key can create messages with this security level, and only the one with the right encryption/decryption key can read the contents of the message."},"securityName":{"index":37,"kind":"parameter","displayName":"Security Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Sets the security name to be used with this target."}}} +{"component":{"kind":"component","name":"snmp","title":"SNMP","description":"Receive traps and poll SNMP (Simple Network Management Protocol) capable devices.","deprecated":false,"firstVersion":"2.1.0","label":"monitoring","javaType":"org.apache.camel.component.snmp.SnmpComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-snmp","version":"4.8.2","scheme":"snmp","extendsScheme":"","syntax":"snmp:host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname of the SNMP enabled device"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Port number of the SNMP enabled device"},"oids":{"index":2,"kind":"parameter","displayName":"Oids","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.snmp.OIDList","deprecated":false,"autowired":false,"secret":false,"description":"Defines which values you are interested in. Please have a look at the Wikipedia to get a better understanding. You may provide a single OID or a coma separated list of OIDs. Example: oids=1.3.6.1.2.1.1.3.0,1.3.6.1.2.1.25.3.2.1.5.1,1.3.6.1.2.1.25.3.5.1.1.1,1.3.6.1.2.1.43.5.1.1.11.1"},"protocol":{"index":3,"kind":"parameter","displayName":"Protocol","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["tcp","udp"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"udp","description":"Here you can select which protocol to use. You can use either udp or tcp."},"retries":{"index":4,"kind":"parameter","displayName":"Retries","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"description":"Defines how often a retry is made before canceling the request."},"snmpCommunity":{"index":5,"kind":"parameter","displayName":"Snmp Community","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"public","description":"Sets the community octet string for the snmp request."},"snmpContextEngineId":{"index":6,"kind":"parameter","displayName":"Snmp Context Engine Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the context engine ID field of the scoped PDU."},"snmpContextName":{"index":7,"kind":"parameter","displayName":"Snmp Context Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the context name field of this scoped PDU."},"snmpVersion":{"index":8,"kind":"parameter","displayName":"Snmp Version","group":"common","label":"","required":false,"type":"integer","javaType":"int","enum":["0","1","3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Sets the snmp version for the request. The value 0 means SNMPv1, 1 means SNMPv2c, and the value 3 means SNMPv3"},"timeout":{"index":9,"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1500,"description":"Sets the timeout value for the request in millis."},"type":{"index":10,"kind":"parameter","displayName":"Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.snmp.SnmpActionType","enum":["TRAP","POLL","GET_NEXT"],"deprecated":false,"autowired":false,"secret":false,"description":"Which operation to perform such as poll, trap, etc."},"delay":{"index":11,"kind":"parameter","displayName":"Delay","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","description":"Milliseconds before the next poll."},"sendEmptyMessageWhenIdle":{"index":12,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"treeList":{"index":13,"kind":"parameter","displayName":"Tree List","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets the flag whether the scoped PDU will be displayed as the list if it has child elements in its tree"},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":17,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":18,"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."},"backoffErrorThreshold":{"index":19,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":20,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":21,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"greedy":{"index":22,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":23,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":24,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":25,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":26,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":27,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":28,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":29,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":30,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":31,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"authenticationPassphrase":{"index":32,"kind":"parameter","displayName":"Authentication Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The authentication passphrase. If not null, authenticationProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown."},"authenticationProtocol":{"index":33,"kind":"parameter","displayName":"Authentication Protocol","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","enum":["MD5","SHA1"],"deprecated":false,"autowired":false,"secret":false,"description":"Authentication protocol to use if security level is set to enable authentication The possible values are: MD5, SHA1"},"privacyPassphrase":{"index":34,"kind":"parameter","displayName":"Privacy Passphrase","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The privacy passphrase. If not null, privacyProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown."},"privacyProtocol":{"index":35,"kind":"parameter","displayName":"Privacy Protocol","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"The privacy protocol ID to be associated with this user. If set to null, this user only supports unencrypted messages."},"securityLevel":{"index":36,"kind":"parameter","displayName":"Security Level","group":"security","label":"security","required":false,"type":"integer","javaType":"int","enum":["1","2","3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":3,"description":"Sets the security level for this target. The supplied security level must be supported by the security model dependent information associated with the security name set for this target. The value 1 means: No authentication and no encryption. Anyone can create and read messages with this security level The value 2 means: Authentication and no encryption. Only the one with the right authentication key can create messages with this security level, but anyone can read the contents of the message. The value 3 means: Authentication and encryption. Only the one with the right authentication key can create messages with this security level, and only the one with the right encryption/decryption key can read the contents of the message."},"securityName":{"index":37,"kind":"parameter","displayName":"Security Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Sets the security name to be used with this target."}}} , -{"component":{"kind":"component","name":"solr","title":"Solr","description":"Perform operations against Apache Lucene Solr.","deprecated":false,"firstVersion":"4.8.0","label":"monitoring,search","javaType":"org.apache.camel.component.solr.SolrComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-solr","version":"4.8.1","scheme":"solr","extendsScheme":"","alternativeSchemes":"solr,solrs,solrCloud","syntax":"solr:url","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelSolrClient":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.solr.client.solrj.SolrClient","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The client.","constantName":"org.apache.camel.component.solr.SolrConstants#CLIENT"},"CamelSolrCollection":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection to execute the request again.","constantName":"org.apache.camel.component.solr.SolrConstants#COLLECTION"},"SolrOperation":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.solr.SolrConstants#OPERATION"},"CamelSolrQueryString":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query to execute.","constantName":"org.apache.camel.component.solr.SolrConstants#QUERY_STRING"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type.","constantName":"org.apache.camel.component.solr.SolrConstants#CONTENT_TYPE"}},"properties":{"url":{"index":0,"kind":"path","displayName":"Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Hostname and port for the Solr server(s). Multiple hosts can be specified, separated with a comma. See the solrClient parameter for more information on the SolrClient used to connect to Solr."},"autoCommit":{"index":1,"kind":"parameter","displayName":"Auto Commit","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"If true, each producer operation will be automatically followed by a commit"},"connectionTimeout":{"index":2,"kind":"parameter","displayName":"Connection Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the connection timeout on the SolrClient"},"defaultMaxConnectionsPerHost":{"index":3,"kind":"parameter","displayName":"Default Max Connections Per Host","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"maxConnectionsPerHost on the underlying HttpConnectionManager"},"httpClient":{"index":4,"kind":"parameter","displayName":"Http Client","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.http.client.HttpClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the http client to be used by the solrClient. This is only applicable when solrClient is not set."},"maxRetries":{"index":5,"kind":"parameter","displayName":"Max Retries","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Maximum number of retries to attempt in the event of transient errors"},"maxTotalConnections":{"index":6,"kind":"parameter","displayName":"Max Total Connections","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"maxTotalConnection on the underlying HttpConnectionManager"},"requestHandler":{"index":7,"kind":"parameter","displayName":"Request Handler","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the request handler to be used"},"solrClient":{"index":8,"kind":"parameter","displayName":"Solr Client","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.solr.client.solrj.SolrClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Uses the provided solr client to connect to solr. When this parameter is not specified, camel applies the following rules to determine the SolrClient: 1) when zkHost or zkChroot (=zookeeper root) parameter is set, then the CloudSolrClient is used. 2) when multiple hosts are specified in the uri (separated with a comma), then the CloudSolrClient (uri scheme is 'solrCloud') or the LBHttpSolrClient (uri scheme is not 'solrCloud') is used. 3) when the solr operation is INSERT_STREAMING, then the ConcurrentUpdateSolrClient is used. 4) otherwise, the HttpSolrClient is used. Note: A CloudSolrClient should point to zookeeper endpoint(s); other clients point to Solr endpoint(s). The SolrClient can also be set via the exchange header 'CamelSolrClient'."},"soTimeout":{"index":9,"kind":"parameter","displayName":"So Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the socket timeout on the SolrClient"},"streamingQueueSize":{"index":10,"kind":"parameter","displayName":"Streaming Queue Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the queue size for the ConcurrentUpdateSolrClient"},"streamingThreadCount":{"index":11,"kind":"parameter","displayName":"Streaming Thread Count","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the number of threads for the ConcurrentUpdateSolrClient"},"lazyStartProducer":{"index":12,"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."},"collection":{"index":13,"kind":"parameter","displayName":"Collection","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the default collection for SolrCloud"},"zkChroot":{"index":14,"kind":"parameter","displayName":"Zk Chroot","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the chroot of the zookeeper connection (include the leading slash; e.g. '/mychroot')"},"zkHost":{"index":15,"kind":"parameter","displayName":"Zk Host","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the ZooKeeper host(s) urls which the CloudSolrClient uses, e.g. zkHost=localhost:2181,localhost:2182. Optionally add the chroot, e.g. zkHost=localhost:2181,localhost:2182/rootformysolr. In case the first part of the url path (='contextroot') is set to 'solr' (e.g. 'localhost:2181/solr' or 'localhost:2181/solr/..'), then that path is not considered as zookeeper chroot for backward compatibility reasons (this behaviour can be overridden via zkChroot parameter)."},"allowCompression":{"index":16,"kind":"parameter","displayName":"Allow Compression","group":"HttpSolrClient","label":"HttpSolrClient","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Server side must support gzip or deflate for this to have any effect"},"followRedirects":{"index":17,"kind":"parameter","displayName":"Follow Redirects","group":"HttpSolrClient","label":"HttpSolrClient","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Indicates whether redirects are used to get to the Solr server"},"password":{"index":18,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets password for basic auth plugin enabled servers"},"username":{"index":19,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets username for basic auth plugin enabled servers"}}} +{"component":{"kind":"component","name":"solr","title":"Solr","description":"Perform operations against Apache Lucene Solr.","deprecated":false,"firstVersion":"4.8.0","label":"monitoring,search","javaType":"org.apache.camel.component.solr.SolrComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-solr","version":"4.8.2","scheme":"solr","extendsScheme":"","alternativeSchemes":"solr,solrs,solrCloud","syntax":"solr:url","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelSolrClient":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.solr.client.solrj.SolrClient","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The client.","constantName":"org.apache.camel.component.solr.SolrConstants#CLIENT"},"CamelSolrCollection":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection to execute the request again.","constantName":"org.apache.camel.component.solr.SolrConstants#COLLECTION"},"SolrOperation":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.solr.SolrConstants#OPERATION"},"CamelSolrQueryString":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query to execute.","constantName":"org.apache.camel.component.solr.SolrConstants#QUERY_STRING"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type.","constantName":"org.apache.camel.component.solr.SolrConstants#CONTENT_TYPE"}},"properties":{"url":{"index":0,"kind":"path","displayName":"Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Hostname and port for the Solr server(s). Multiple hosts can be specified, separated with a comma. See the solrClient parameter for more information on the SolrClient used to connect to Solr."},"autoCommit":{"index":1,"kind":"parameter","displayName":"Auto Commit","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"If true, each producer operation will be automatically followed by a commit"},"connectionTimeout":{"index":2,"kind":"parameter","displayName":"Connection Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the connection timeout on the SolrClient"},"defaultMaxConnectionsPerHost":{"index":3,"kind":"parameter","displayName":"Default Max Connections Per Host","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"maxConnectionsPerHost on the underlying HttpConnectionManager"},"httpClient":{"index":4,"kind":"parameter","displayName":"Http Client","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.http.client.HttpClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the http client to be used by the solrClient. This is only applicable when solrClient is not set."},"maxRetries":{"index":5,"kind":"parameter","displayName":"Max Retries","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Maximum number of retries to attempt in the event of transient errors"},"maxTotalConnections":{"index":6,"kind":"parameter","displayName":"Max Total Connections","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"maxTotalConnection on the underlying HttpConnectionManager"},"requestHandler":{"index":7,"kind":"parameter","displayName":"Request Handler","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the request handler to be used"},"solrClient":{"index":8,"kind":"parameter","displayName":"Solr Client","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.solr.client.solrj.SolrClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Uses the provided solr client to connect to solr. When this parameter is not specified, camel applies the following rules to determine the SolrClient: 1) when zkHost or zkChroot (=zookeeper root) parameter is set, then the CloudSolrClient is used. 2) when multiple hosts are specified in the uri (separated with a comma), then the CloudSolrClient (uri scheme is 'solrCloud') or the LBHttpSolrClient (uri scheme is not 'solrCloud') is used. 3) when the solr operation is INSERT_STREAMING, then the ConcurrentUpdateSolrClient is used. 4) otherwise, the HttpSolrClient is used. Note: A CloudSolrClient should point to zookeeper endpoint(s); other clients point to Solr endpoint(s). The SolrClient can also be set via the exchange header 'CamelSolrClient'."},"soTimeout":{"index":9,"kind":"parameter","displayName":"So Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the socket timeout on the SolrClient"},"streamingQueueSize":{"index":10,"kind":"parameter","displayName":"Streaming Queue Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the queue size for the ConcurrentUpdateSolrClient"},"streamingThreadCount":{"index":11,"kind":"parameter","displayName":"Streaming Thread Count","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the number of threads for the ConcurrentUpdateSolrClient"},"lazyStartProducer":{"index":12,"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."},"collection":{"index":13,"kind":"parameter","displayName":"Collection","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the default collection for SolrCloud"},"zkChroot":{"index":14,"kind":"parameter","displayName":"Zk Chroot","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the chroot of the zookeeper connection (include the leading slash; e.g. '/mychroot')"},"zkHost":{"index":15,"kind":"parameter","displayName":"Zk Host","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the ZooKeeper host(s) urls which the CloudSolrClient uses, e.g. zkHost=localhost:2181,localhost:2182. Optionally add the chroot, e.g. zkHost=localhost:2181,localhost:2182/rootformysolr. In case the first part of the url path (='contextroot') is set to 'solr' (e.g. 'localhost:2181/solr' or 'localhost:2181/solr/..'), then that path is not considered as zookeeper chroot for backward compatibility reasons (this behaviour can be overridden via zkChroot parameter)."},"allowCompression":{"index":16,"kind":"parameter","displayName":"Allow Compression","group":"HttpSolrClient","label":"HttpSolrClient","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Server side must support gzip or deflate for this to have any effect"},"followRedirects":{"index":17,"kind":"parameter","displayName":"Follow Redirects","group":"HttpSolrClient","label":"HttpSolrClient","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Indicates whether redirects are used to get to the Solr server"},"password":{"index":18,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets password for basic auth plugin enabled servers"},"username":{"index":19,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets username for basic auth plugin enabled servers"}}} , -{"component":{"kind":"component","name":"solrCloud","title":"Solr","description":"Perform operations against Apache Lucene Solr.","deprecated":false,"firstVersion":"4.8.0","label":"monitoring,search","javaType":"org.apache.camel.component.solr.SolrComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-solr","version":"4.8.1","scheme":"solrCloud","extendsScheme":"","alternativeSchemes":"solr,solrs,solrCloud","syntax":"solrCloud:url","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelSolrClient":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.solr.client.solrj.SolrClient","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The client.","constantName":"org.apache.camel.component.solr.SolrConstants#CLIENT"},"CamelSolrCollection":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection to execute the request again.","constantName":"org.apache.camel.component.solr.SolrConstants#COLLECTION"},"SolrOperation":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.solr.SolrConstants#OPERATION"},"CamelSolrQueryString":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query to execute.","constantName":"org.apache.camel.component.solr.SolrConstants#QUERY_STRING"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type.","constantName":"org.apache.camel.component.solr.SolrConstants#CONTENT_TYPE"}},"properties":{"url":{"index":0,"kind":"path","displayName":"Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Hostname and port for the Solr server(s). Multiple hosts can be specified, separated with a comma. See the solrClient parameter for more information on the SolrClient used to connect to Solr."},"autoCommit":{"index":1,"kind":"parameter","displayName":"Auto Commit","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"If true, each producer operation will be automatically followed by a commit"},"connectionTimeout":{"index":2,"kind":"parameter","displayName":"Connection Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the connection timeout on the SolrClient"},"defaultMaxConnectionsPerHost":{"index":3,"kind":"parameter","displayName":"Default Max Connections Per Host","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"maxConnectionsPerHost on the underlying HttpConnectionManager"},"httpClient":{"index":4,"kind":"parameter","displayName":"Http Client","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.http.client.HttpClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the http client to be used by the solrClient. This is only applicable when solrClient is not set."},"maxRetries":{"index":5,"kind":"parameter","displayName":"Max Retries","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Maximum number of retries to attempt in the event of transient errors"},"maxTotalConnections":{"index":6,"kind":"parameter","displayName":"Max Total Connections","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"maxTotalConnection on the underlying HttpConnectionManager"},"requestHandler":{"index":7,"kind":"parameter","displayName":"Request Handler","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the request handler to be used"},"solrClient":{"index":8,"kind":"parameter","displayName":"Solr Client","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.solr.client.solrj.SolrClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Uses the provided solr client to connect to solr. When this parameter is not specified, camel applies the following rules to determine the SolrClient: 1) when zkHost or zkChroot (=zookeeper root) parameter is set, then the CloudSolrClient is used. 2) when multiple hosts are specified in the uri (separated with a comma), then the CloudSolrClient (uri scheme is 'solrCloud') or the LBHttpSolrClient (uri scheme is not 'solrCloud') is used. 3) when the solr operation is INSERT_STREAMING, then the ConcurrentUpdateSolrClient is used. 4) otherwise, the HttpSolrClient is used. Note: A CloudSolrClient should point to zookeeper endpoint(s); other clients point to Solr endpoint(s). The SolrClient can also be set via the exchange header 'CamelSolrClient'."},"soTimeout":{"index":9,"kind":"parameter","displayName":"So Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the socket timeout on the SolrClient"},"streamingQueueSize":{"index":10,"kind":"parameter","displayName":"Streaming Queue Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the queue size for the ConcurrentUpdateSolrClient"},"streamingThreadCount":{"index":11,"kind":"parameter","displayName":"Streaming Thread Count","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the number of threads for the ConcurrentUpdateSolrClient"},"lazyStartProducer":{"index":12,"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."},"collection":{"index":13,"kind":"parameter","displayName":"Collection","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the default collection for SolrCloud"},"zkChroot":{"index":14,"kind":"parameter","displayName":"Zk Chroot","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the chroot of the zookeeper connection (include the leading slash; e.g. '/mychroot')"},"zkHost":{"index":15,"kind":"parameter","displayName":"Zk Host","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the ZooKeeper host(s) urls which the CloudSolrClient uses, e.g. zkHost=localhost:2181,localhost:2182. Optionally add the chroot, e.g. zkHost=localhost:2181,localhost:2182/rootformysolr. In case the first part of the url path (='contextroot') is set to 'solr' (e.g. 'localhost:2181/solr' or 'localhost:2181/solr/..'), then that path is not considered as zookeeper chroot for backward compatibility reasons (this behaviour can be overridden via zkChroot parameter)."},"allowCompression":{"index":16,"kind":"parameter","displayName":"Allow Compression","group":"HttpSolrClient","label":"HttpSolrClient","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Server side must support gzip or deflate for this to have any effect"},"followRedirects":{"index":17,"kind":"parameter","displayName":"Follow Redirects","group":"HttpSolrClient","label":"HttpSolrClient","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Indicates whether redirects are used to get to the Solr server"},"password":{"index":18,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets password for basic auth plugin enabled servers"},"username":{"index":19,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets username for basic auth plugin enabled servers"}}} +{"component":{"kind":"component","name":"solrCloud","title":"Solr","description":"Perform operations against Apache Lucene Solr.","deprecated":false,"firstVersion":"4.8.0","label":"monitoring,search","javaType":"org.apache.camel.component.solr.SolrComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-solr","version":"4.8.2","scheme":"solrCloud","extendsScheme":"","alternativeSchemes":"solr,solrs,solrCloud","syntax":"solrCloud:url","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelSolrClient":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.solr.client.solrj.SolrClient","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The client.","constantName":"org.apache.camel.component.solr.SolrConstants#CLIENT"},"CamelSolrCollection":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection to execute the request again.","constantName":"org.apache.camel.component.solr.SolrConstants#COLLECTION"},"SolrOperation":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.solr.SolrConstants#OPERATION"},"CamelSolrQueryString":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query to execute.","constantName":"org.apache.camel.component.solr.SolrConstants#QUERY_STRING"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type.","constantName":"org.apache.camel.component.solr.SolrConstants#CONTENT_TYPE"}},"properties":{"url":{"index":0,"kind":"path","displayName":"Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Hostname and port for the Solr server(s). Multiple hosts can be specified, separated with a comma. See the solrClient parameter for more information on the SolrClient used to connect to Solr."},"autoCommit":{"index":1,"kind":"parameter","displayName":"Auto Commit","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"If true, each producer operation will be automatically followed by a commit"},"connectionTimeout":{"index":2,"kind":"parameter","displayName":"Connection Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the connection timeout on the SolrClient"},"defaultMaxConnectionsPerHost":{"index":3,"kind":"parameter","displayName":"Default Max Connections Per Host","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"maxConnectionsPerHost on the underlying HttpConnectionManager"},"httpClient":{"index":4,"kind":"parameter","displayName":"Http Client","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.http.client.HttpClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the http client to be used by the solrClient. This is only applicable when solrClient is not set."},"maxRetries":{"index":5,"kind":"parameter","displayName":"Max Retries","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Maximum number of retries to attempt in the event of transient errors"},"maxTotalConnections":{"index":6,"kind":"parameter","displayName":"Max Total Connections","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"maxTotalConnection on the underlying HttpConnectionManager"},"requestHandler":{"index":7,"kind":"parameter","displayName":"Request Handler","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the request handler to be used"},"solrClient":{"index":8,"kind":"parameter","displayName":"Solr Client","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.solr.client.solrj.SolrClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Uses the provided solr client to connect to solr. When this parameter is not specified, camel applies the following rules to determine the SolrClient: 1) when zkHost or zkChroot (=zookeeper root) parameter is set, then the CloudSolrClient is used. 2) when multiple hosts are specified in the uri (separated with a comma), then the CloudSolrClient (uri scheme is 'solrCloud') or the LBHttpSolrClient (uri scheme is not 'solrCloud') is used. 3) when the solr operation is INSERT_STREAMING, then the ConcurrentUpdateSolrClient is used. 4) otherwise, the HttpSolrClient is used. Note: A CloudSolrClient should point to zookeeper endpoint(s); other clients point to Solr endpoint(s). The SolrClient can also be set via the exchange header 'CamelSolrClient'."},"soTimeout":{"index":9,"kind":"parameter","displayName":"So Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the socket timeout on the SolrClient"},"streamingQueueSize":{"index":10,"kind":"parameter","displayName":"Streaming Queue Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the queue size for the ConcurrentUpdateSolrClient"},"streamingThreadCount":{"index":11,"kind":"parameter","displayName":"Streaming Thread Count","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the number of threads for the ConcurrentUpdateSolrClient"},"lazyStartProducer":{"index":12,"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."},"collection":{"index":13,"kind":"parameter","displayName":"Collection","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the default collection for SolrCloud"},"zkChroot":{"index":14,"kind":"parameter","displayName":"Zk Chroot","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the chroot of the zookeeper connection (include the leading slash; e.g. '/mychroot')"},"zkHost":{"index":15,"kind":"parameter","displayName":"Zk Host","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the ZooKeeper host(s) urls which the CloudSolrClient uses, e.g. zkHost=localhost:2181,localhost:2182. Optionally add the chroot, e.g. zkHost=localhost:2181,localhost:2182/rootformysolr. In case the first part of the url path (='contextroot') is set to 'solr' (e.g. 'localhost:2181/solr' or 'localhost:2181/solr/..'), then that path is not considered as zookeeper chroot for backward compatibility reasons (this behaviour can be overridden via zkChroot parameter)."},"allowCompression":{"index":16,"kind":"parameter","displayName":"Allow Compression","group":"HttpSolrClient","label":"HttpSolrClient","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Server side must support gzip or deflate for this to have any effect"},"followRedirects":{"index":17,"kind":"parameter","displayName":"Follow Redirects","group":"HttpSolrClient","label":"HttpSolrClient","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Indicates whether redirects are used to get to the Solr server"},"password":{"index":18,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets password for basic auth plugin enabled servers"},"username":{"index":19,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets username for basic auth plugin enabled servers"}}} , -{"component":{"kind":"component","name":"solrs","title":"Solr (Secure)","description":"Perform operations against Apache Lucene Solr.","deprecated":false,"firstVersion":"4.8.0","label":"monitoring,search","javaType":"org.apache.camel.component.solr.SolrComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-solr","version":"4.8.1","scheme":"solrs","extendsScheme":"","alternativeSchemes":"solr,solrs,solrCloud","syntax":"solrs:url","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelSolrClient":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.solr.client.solrj.SolrClient","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The client.","constantName":"org.apache.camel.component.solr.SolrConstants#CLIENT"},"CamelSolrCollection":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection to execute the request again.","constantName":"org.apache.camel.component.solr.SolrConstants#COLLECTION"},"SolrOperation":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.solr.SolrConstants#OPERATION"},"CamelSolrQueryString":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query to execute.","constantName":"org.apache.camel.component.solr.SolrConstants#QUERY_STRING"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type.","constantName":"org.apache.camel.component.solr.SolrConstants#CONTENT_TYPE"}},"properties":{"url":{"index":0,"kind":"path","displayName":"Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Hostname and port for the Solr server(s). Multiple hosts can be specified, separated with a comma. See the solrClient parameter for more information on the SolrClient used to connect to Solr."},"autoCommit":{"index":1,"kind":"parameter","displayName":"Auto Commit","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"If true, each producer operation will be automatically followed by a commit"},"connectionTimeout":{"index":2,"kind":"parameter","displayName":"Connection Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the connection timeout on the SolrClient"},"defaultMaxConnectionsPerHost":{"index":3,"kind":"parameter","displayName":"Default Max Connections Per Host","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"maxConnectionsPerHost on the underlying HttpConnectionManager"},"httpClient":{"index":4,"kind":"parameter","displayName":"Http Client","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.http.client.HttpClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the http client to be used by the solrClient. This is only applicable when solrClient is not set."},"maxRetries":{"index":5,"kind":"parameter","displayName":"Max Retries","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Maximum number of retries to attempt in the event of transient errors"},"maxTotalConnections":{"index":6,"kind":"parameter","displayName":"Max Total Connections","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"maxTotalConnection on the underlying HttpConnectionManager"},"requestHandler":{"index":7,"kind":"parameter","displayName":"Request Handler","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the request handler to be used"},"solrClient":{"index":8,"kind":"parameter","displayName":"Solr Client","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.solr.client.solrj.SolrClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Uses the provided solr client to connect to solr. When this parameter is not specified, camel applies the following rules to determine the SolrClient: 1) when zkHost or zkChroot (=zookeeper root) parameter is set, then the CloudSolrClient is used. 2) when multiple hosts are specified in the uri (separated with a comma), then the CloudSolrClient (uri scheme is 'solrCloud') or the LBHttpSolrClient (uri scheme is not 'solrCloud') is used. 3) when the solr operation is INSERT_STREAMING, then the ConcurrentUpdateSolrClient is used. 4) otherwise, the HttpSolrClient is used. Note: A CloudSolrClient should point to zookeeper endpoint(s); other clients point to Solr endpoint(s). The SolrClient can also be set via the exchange header 'CamelSolrClient'."},"soTimeout":{"index":9,"kind":"parameter","displayName":"So Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the socket timeout on the SolrClient"},"streamingQueueSize":{"index":10,"kind":"parameter","displayName":"Streaming Queue Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the queue size for the ConcurrentUpdateSolrClient"},"streamingThreadCount":{"index":11,"kind":"parameter","displayName":"Streaming Thread Count","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the number of threads for the ConcurrentUpdateSolrClient"},"lazyStartProducer":{"index":12,"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."},"collection":{"index":13,"kind":"parameter","displayName":"Collection","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the default collection for SolrCloud"},"zkChroot":{"index":14,"kind":"parameter","displayName":"Zk Chroot","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the chroot of the zookeeper connection (include the leading slash; e.g. '/mychroot')"},"zkHost":{"index":15,"kind":"parameter","displayName":"Zk Host","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the ZooKeeper host(s) urls which the CloudSolrClient uses, e.g. zkHost=localhost:2181,localhost:2182. Optionally add the chroot, e.g. zkHost=localhost:2181,localhost:2182/rootformysolr. In case the first part of the url path (='contextroot') is set to 'solr' (e.g. 'localhost:2181/solr' or 'localhost:2181/solr/..'), then that path is not considered as zookeeper chroot for backward compatibility reasons (this behaviour can be overridden via zkChroot parameter)."},"allowCompression":{"index":16,"kind":"parameter","displayName":"Allow Compression","group":"HttpSolrClient","label":"HttpSolrClient","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Server side must support gzip or deflate for this to have any effect"},"followRedirects":{"index":17,"kind":"parameter","displayName":"Follow Redirects","group":"HttpSolrClient","label":"HttpSolrClient","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Indicates whether redirects are used to get to the Solr server"},"password":{"index":18,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets password for basic auth plugin enabled servers"},"username":{"index":19,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets username for basic auth plugin enabled servers"}}} +{"component":{"kind":"component","name":"solrs","title":"Solr (Secure)","description":"Perform operations against Apache Lucene Solr.","deprecated":false,"firstVersion":"4.8.0","label":"monitoring,search","javaType":"org.apache.camel.component.solr.SolrComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-solr","version":"4.8.2","scheme":"solrs","extendsScheme":"","alternativeSchemes":"solr,solrs,solrCloud","syntax":"solrs:url","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelSolrClient":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.solr.client.solrj.SolrClient","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The client.","constantName":"org.apache.camel.component.solr.SolrConstants#CLIENT"},"CamelSolrCollection":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection to execute the request again.","constantName":"org.apache.camel.component.solr.SolrConstants#COLLECTION"},"SolrOperation":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.solr.SolrConstants#OPERATION"},"CamelSolrQueryString":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query to execute.","constantName":"org.apache.camel.component.solr.SolrConstants#QUERY_STRING"},"Content-Type":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type.","constantName":"org.apache.camel.component.solr.SolrConstants#CONTENT_TYPE"}},"properties":{"url":{"index":0,"kind":"path","displayName":"Url","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Hostname and port for the Solr server(s). Multiple hosts can be specified, separated with a comma. See the solrClient parameter for more information on the SolrClient used to connect to Solr."},"autoCommit":{"index":1,"kind":"parameter","displayName":"Auto Commit","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"If true, each producer operation will be automatically followed by a commit"},"connectionTimeout":{"index":2,"kind":"parameter","displayName":"Connection Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the connection timeout on the SolrClient"},"defaultMaxConnectionsPerHost":{"index":3,"kind":"parameter","displayName":"Default Max Connections Per Host","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"maxConnectionsPerHost on the underlying HttpConnectionManager"},"httpClient":{"index":4,"kind":"parameter","displayName":"Http Client","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.http.client.HttpClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the http client to be used by the solrClient. This is only applicable when solrClient is not set."},"maxRetries":{"index":5,"kind":"parameter","displayName":"Max Retries","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Maximum number of retries to attempt in the event of transient errors"},"maxTotalConnections":{"index":6,"kind":"parameter","displayName":"Max Total Connections","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":true,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"maxTotalConnection on the underlying HttpConnectionManager"},"requestHandler":{"index":7,"kind":"parameter","displayName":"Request Handler","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the request handler to be used"},"solrClient":{"index":8,"kind":"parameter","displayName":"Solr Client","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.solr.client.solrj.SolrClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Uses the provided solr client to connect to solr. When this parameter is not specified, camel applies the following rules to determine the SolrClient: 1) when zkHost or zkChroot (=zookeeper root) parameter is set, then the CloudSolrClient is used. 2) when multiple hosts are specified in the uri (separated with a comma), then the CloudSolrClient (uri scheme is 'solrCloud') or the LBHttpSolrClient (uri scheme is not 'solrCloud') is used. 3) when the solr operation is INSERT_STREAMING, then the ConcurrentUpdateSolrClient is used. 4) otherwise, the HttpSolrClient is used. Note: A CloudSolrClient should point to zookeeper endpoint(s); other clients point to Solr endpoint(s). The SolrClient can also be set via the exchange header 'CamelSolrClient'."},"soTimeout":{"index":9,"kind":"parameter","displayName":"So Timeout","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the socket timeout on the SolrClient"},"streamingQueueSize":{"index":10,"kind":"parameter","displayName":"Streaming Queue Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the queue size for the ConcurrentUpdateSolrClient"},"streamingThreadCount":{"index":11,"kind":"parameter","displayName":"Streaming Thread Count","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets the number of threads for the ConcurrentUpdateSolrClient"},"lazyStartProducer":{"index":12,"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."},"collection":{"index":13,"kind":"parameter","displayName":"Collection","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the default collection for SolrCloud"},"zkChroot":{"index":14,"kind":"parameter","displayName":"Zk Chroot","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the chroot of the zookeeper connection (include the leading slash; e.g. '/mychroot')"},"zkHost":{"index":15,"kind":"parameter","displayName":"Zk Host","group":"CloudSolrClient","label":"CloudSolrClient","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Set the ZooKeeper host(s) urls which the CloudSolrClient uses, e.g. zkHost=localhost:2181,localhost:2182. Optionally add the chroot, e.g. zkHost=localhost:2181,localhost:2182/rootformysolr. In case the first part of the url path (='contextroot') is set to 'solr' (e.g. 'localhost:2181/solr' or 'localhost:2181/solr/..'), then that path is not considered as zookeeper chroot for backward compatibility reasons (this behaviour can be overridden via zkChroot parameter)."},"allowCompression":{"index":16,"kind":"parameter","displayName":"Allow Compression","group":"HttpSolrClient","label":"HttpSolrClient","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Server side must support gzip or deflate for this to have any effect"},"followRedirects":{"index":17,"kind":"parameter","displayName":"Follow Redirects","group":"HttpSolrClient","label":"HttpSolrClient","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Indicates whether redirects are used to get to the Solr server"},"password":{"index":18,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets password for basic auth plugin enabled servers"},"username":{"index":19,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.solr.SolrConfiguration","configurationField":"solrConfiguration","description":"Sets username for basic auth plugin enabled servers"}}} , -{"component":{"kind":"component","name":"splunk","title":"Splunk","description":"Publish or search for events in Splunk.","deprecated":false,"firstVersion":"2.13.0","label":"iot,monitoring","javaType":"org.apache.camel.component.splunk.SplunkComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-splunk","version":"4.8.1","scheme":"splunk","extendsScheme":"","syntax":"splunk:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Name has no purpose"},"app":{"index":1,"kind":"parameter","displayName":"App","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk app"},"connectionTimeout":{"index":2,"kind":"parameter","displayName":"Connection Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Timeout in MS when connecting to Splunk server"},"host":{"index":3,"kind":"parameter","displayName":"Host","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk host."},"owner":{"index":4,"kind":"parameter","displayName":"Owner","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk owner"},"port":{"index":5,"kind":"parameter","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8089,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk port"},"scheme":{"index":6,"kind":"parameter","displayName":"Scheme","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https","configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk scheme"},"count":{"index":7,"kind":"parameter","displayName":"Count","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"A number that indicates the maximum number of entities to return."},"earliestTime":{"index":8,"kind":"parameter","displayName":"Earliest Time","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Earliest time of the search time window."},"initEarliestTime":{"index":9,"kind":"parameter","displayName":"Init Earliest Time","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Initial start offset of the first search"},"latestTime":{"index":10,"kind":"parameter","displayName":"Latest Time","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Latest time of the search time window."},"savedSearch":{"index":11,"kind":"parameter","displayName":"Saved Search","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"The name of the query saved in Splunk to run"},"search":{"index":12,"kind":"parameter","displayName":"Search","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"The Splunk query to run"},"sendEmptyMessageWhenIdle":{"index":13,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"streaming":{"index":14,"kind":"parameter","displayName":"Streaming","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Sets streaming mode. Streaming mode sends exchanges as they are received, rather than in a batch."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":18,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"eventHost":{"index":19,"kind":"parameter","displayName":"Event Host","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Override the default Splunk event host field"},"index":{"index":20,"kind":"parameter","displayName":"Index","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk index to write to"},"raw":{"index":21,"kind":"parameter","displayName":"Raw","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Should the payload be inserted raw"},"source":{"index":22,"kind":"parameter","displayName":"Source","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk source argument"},"sourceType":{"index":23,"kind":"parameter","displayName":"Source Type","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk sourcetype argument"},"tcpReceiverLocalPort":{"index":24,"kind":"parameter","displayName":"Tcp Receiver Local Port","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk tcp receiver port defined locally on splunk server. (For example if splunk port 9997 is mapped to 12345, tcpReceiverLocalPort has to be 9997)"},"tcpReceiverPort":{"index":25,"kind":"parameter","displayName":"Tcp Receiver Port","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk tcp receiver port"},"lazyStartProducer":{"index":26,"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."},"backoffErrorThreshold":{"index":27,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":28,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":29,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":30,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":31,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":32,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":33,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":34,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":35,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":36,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":37,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":38,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":39,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":40,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":41,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Password for Splunk"},"sslProtocol":{"index":42,"kind":"parameter","displayName":"Ssl Protocol","group":"security","label":"security","required":false,"type":"object","javaType":"com.splunk.SSLSecurityProtocol","enum":["TLSv1.2","TLSv1.1","TLSv1","SSLv3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TLSv1.2","configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Set the ssl protocol to use"},"token":{"index":43,"kind":"parameter","displayName":"Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"User's token for Splunk. This takes precedence over password when both are set"},"username":{"index":44,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Username for Splunk"},"useSunHttpsHandler":{"index":45,"kind":"parameter","displayName":"Use Sun Https Handler","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. Can be useful when running in application servers to avoid app. server https handling."},"validateCertificates":{"index":46,"kind":"parameter","displayName":"Validate Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Sets client's certificate validation mode. Value false makes SSL vulnerable and is not recommended for the production environment."}}} +{"component":{"kind":"component","name":"splunk","title":"Splunk","description":"Publish or search for events in Splunk.","deprecated":false,"firstVersion":"2.13.0","label":"iot,monitoring","javaType":"org.apache.camel.component.splunk.SplunkComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-splunk","version":"4.8.2","scheme":"splunk","extendsScheme":"","syntax":"splunk:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Name has no purpose"},"app":{"index":1,"kind":"parameter","displayName":"App","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk app"},"connectionTimeout":{"index":2,"kind":"parameter","displayName":"Connection Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Timeout in MS when connecting to Splunk server"},"host":{"index":3,"kind":"parameter","displayName":"Host","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk host."},"owner":{"index":4,"kind":"parameter","displayName":"Owner","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk owner"},"port":{"index":5,"kind":"parameter","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":8089,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk port"},"scheme":{"index":6,"kind":"parameter","displayName":"Scheme","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"https","configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk scheme"},"count":{"index":7,"kind":"parameter","displayName":"Count","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"A number that indicates the maximum number of entities to return."},"earliestTime":{"index":8,"kind":"parameter","displayName":"Earliest Time","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Earliest time of the search time window."},"initEarliestTime":{"index":9,"kind":"parameter","displayName":"Init Earliest Time","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Initial start offset of the first search"},"latestTime":{"index":10,"kind":"parameter","displayName":"Latest Time","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Latest time of the search time window."},"savedSearch":{"index":11,"kind":"parameter","displayName":"Saved Search","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"The name of the query saved in Splunk to run"},"search":{"index":12,"kind":"parameter","displayName":"Search","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"The Splunk query to run"},"sendEmptyMessageWhenIdle":{"index":13,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"streaming":{"index":14,"kind":"parameter","displayName":"Streaming","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Sets streaming mode. Streaming mode sends exchanges as they are received, rather than in a batch."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":18,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"eventHost":{"index":19,"kind":"parameter","displayName":"Event Host","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Override the default Splunk event host field"},"index":{"index":20,"kind":"parameter","displayName":"Index","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk index to write to"},"raw":{"index":21,"kind":"parameter","displayName":"Raw","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Should the payload be inserted raw"},"source":{"index":22,"kind":"parameter","displayName":"Source","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk source argument"},"sourceType":{"index":23,"kind":"parameter","displayName":"Source Type","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk sourcetype argument"},"tcpReceiverLocalPort":{"index":24,"kind":"parameter","displayName":"Tcp Receiver Local Port","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk tcp receiver port defined locally on splunk server. (For example if splunk port 9997 is mapped to 12345, tcpReceiverLocalPort has to be 9997)"},"tcpReceiverPort":{"index":25,"kind":"parameter","displayName":"Tcp Receiver Port","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Splunk tcp receiver port"},"lazyStartProducer":{"index":26,"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."},"backoffErrorThreshold":{"index":27,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":28,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":29,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":30,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":31,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":32,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":33,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":34,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":35,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":36,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":37,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":38,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":39,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":40,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"password":{"index":41,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Password for Splunk"},"sslProtocol":{"index":42,"kind":"parameter","displayName":"Ssl Protocol","group":"security","label":"security","required":false,"type":"object","javaType":"com.splunk.SSLSecurityProtocol","enum":["TLSv1.2","TLSv1.1","TLSv1","SSLv3"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TLSv1.2","configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Set the ssl protocol to use"},"token":{"index":43,"kind":"parameter","displayName":"Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"User's token for Splunk. This takes precedence over password when both are set"},"username":{"index":44,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Username for Splunk"},"useSunHttpsHandler":{"index":45,"kind":"parameter","displayName":"Use Sun Https Handler","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. Can be useful when running in application servers to avoid app. server https handling."},"validateCertificates":{"index":46,"kind":"parameter","displayName":"Validate Certificates","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.splunk.SplunkConfiguration","configurationField":"configuration","description":"Sets client's certificate validation mode. Value false makes SSL vulnerable and is not recommended for the production environment."}}} , -{"component":{"kind":"component","name":"splunk-hec","title":"Splunk HEC","description":"The splunk component allows publishing events in Splunk using the HTTP Event Collector.","deprecated":false,"firstVersion":"3.3.0","label":"monitoring","javaType":"org.apache.camel.component.splunkhec.SplunkHECComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-splunk-hec","version":"4.8.1","scheme":"splunk-hec","extendsScheme":"","syntax":"splunk-hec:splunkURL","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelSplunkHECIndexTime":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Epoch-formatted time. Specify with the time query string parameter. Sets a default for all events in the request. The default time can be overridden.","constantName":"org.apache.camel.component.splunkhec.SplunkHECConstants#INDEX_TIME"}},"properties":{"splunkURL":{"index":0,"kind":"path","displayName":"Splunk URL","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Splunk Host and Port (example: my_splunk_server:8089)"},"bodyOnly":{"index":1,"kind":"parameter","displayName":"Body Only","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Send only the message body"},"headersOnly":{"index":2,"kind":"parameter","displayName":"Headers Only","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Send only message headers"},"host":{"index":3,"kind":"parameter","displayName":"Host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Splunk host field of the event message. This is not the Splunk host to connect to."},"index":{"index":4,"kind":"parameter","displayName":"Index","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel","configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Splunk index to write to"},"source":{"index":5,"kind":"parameter","displayName":"Source","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel","configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Splunk source argument"},"sourceType":{"index":6,"kind":"parameter","displayName":"Source Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel","configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Splunk sourcetype argument"},"splunkEndpoint":{"index":7,"kind":"parameter","displayName":"Splunk Endpoint","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"/services/collector/event","configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Splunk endpoint Defaults to /services/collector/event To write RAW data like JSON use /services/collector/raw For a list of all endpoints refer to splunk documentation (HTTP Event Collector REST API endpoints) Example for Spunk 8.2.x: https://docs.splunk.com/Documentation/SplunkCloud/8.2.2203/Data/HECRESTendpoints To extract timestamps in Splunk8.0 /services/collector/eventauto_extract_timestamp=true Remember to utilize RAW{} for questionmarks or slashes in parameters."},"sslContextParameters":{"index":8,"kind":"parameter","displayName":"Ssl Context Parameters","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"SSL configuration"},"time":{"index":9,"kind":"parameter","displayName":"Time","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Time this even occurred. By default, the time will be when this event hits the splunk server."},"lazyStartProducer":{"index":10,"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."},"https":{"index":11,"kind":"parameter","displayName":"Https","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Contact HEC over https."},"skipTlsVerify":{"index":12,"kind":"parameter","displayName":"Skip Tls Verify","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Splunk HEC TLS verification."},"token":{"index":13,"kind":"parameter","displayName":"Token","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Splunk HEC token (this is the token created for HEC and not the user's token)"}}} +{"component":{"kind":"component","name":"splunk-hec","title":"Splunk HEC","description":"The splunk component allows publishing events in Splunk using the HTTP Event Collector.","deprecated":false,"firstVersion":"3.3.0","label":"monitoring","javaType":"org.apache.camel.component.splunkhec.SplunkHECComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-splunk-hec","version":"4.8.2","scheme":"splunk-hec","extendsScheme":"","syntax":"splunk-hec:splunkURL","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelSplunkHECIndexTime":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Epoch-formatted time. Specify with the time query string parameter. Sets a default for all events in the request. The default time can be overridden.","constantName":"org.apache.camel.component.splunkhec.SplunkHECConstants#INDEX_TIME"}},"properties":{"splunkURL":{"index":0,"kind":"path","displayName":"Splunk URL","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Splunk Host and Port (example: my_splunk_server:8089)"},"bodyOnly":{"index":1,"kind":"parameter","displayName":"Body Only","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Send only the message body"},"headersOnly":{"index":2,"kind":"parameter","displayName":"Headers Only","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Send only message headers"},"host":{"index":3,"kind":"parameter","displayName":"Host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Splunk host field of the event message. This is not the Splunk host to connect to."},"index":{"index":4,"kind":"parameter","displayName":"Index","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel","configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Splunk index to write to"},"source":{"index":5,"kind":"parameter","displayName":"Source","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel","configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Splunk source argument"},"sourceType":{"index":6,"kind":"parameter","displayName":"Source Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"camel","configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Splunk sourcetype argument"},"splunkEndpoint":{"index":7,"kind":"parameter","displayName":"Splunk Endpoint","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"/services/collector/event","configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Splunk endpoint Defaults to /services/collector/event To write RAW data like JSON use /services/collector/raw For a list of all endpoints refer to splunk documentation (HTTP Event Collector REST API endpoints) Example for Spunk 8.2.x: https://docs.splunk.com/Documentation/SplunkCloud/8.2.2203/Data/HECRESTendpoints To extract timestamps in Splunk8.0 /services/collector/eventauto_extract_timestamp=true Remember to utilize RAW{} for questionmarks or slashes in parameters."},"sslContextParameters":{"index":8,"kind":"parameter","displayName":"Ssl Context Parameters","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"SSL configuration"},"time":{"index":9,"kind":"parameter","displayName":"Time","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Time this even occurred. By default, the time will be when this event hits the splunk server."},"lazyStartProducer":{"index":10,"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."},"https":{"index":11,"kind":"parameter","displayName":"Https","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Contact HEC over https."},"skipTlsVerify":{"index":12,"kind":"parameter","displayName":"Skip Tls Verify","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Splunk HEC TLS verification."},"token":{"index":13,"kind":"parameter","displayName":"Token","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.splunkhec.SplunkHECConfiguration","configurationField":"configuration","description":"Splunk HEC token (this is the token created for HEC and not the user's token)"}}} , -{"component":{"kind":"component","name":"spring-batch","title":"Spring Batch","description":"Send messages to Spring Batch for further processing.","deprecated":false,"firstVersion":"2.10.0","label":"workflow","javaType":"org.apache.camel.component.spring.batch.SpringBatchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-spring-batch","version":"4.8.1","scheme":"spring-batch","extendsScheme":"","syntax":"spring-batch:jobName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"jobName":{"index":0,"kind":"path","displayName":"Job Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the Spring Batch job located in the registry."},"jobFromHeader":{"index":1,"kind":"parameter","displayName":"Job From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Explicitly defines if the jobName should be taken from the headers instead of the URI."},"jobLauncher":{"index":2,"kind":"parameter","displayName":"Job Launcher","group":"producer","label":"","required":false,"type":"object","javaType":"org.springframework.batch.core.launch.JobLauncher","deprecated":false,"autowired":false,"secret":false,"description":"Explicitly specifies a JobLauncher to be used."},"jobRegistry":{"index":3,"kind":"parameter","displayName":"Job Registry","group":"producer","label":"","required":false,"type":"object","javaType":"org.springframework.batch.core.configuration.JobRegistry","deprecated":false,"autowired":false,"secret":false,"description":"Explicitly specifies a JobRegistry to be used."},"lazyStartProducer":{"index":4,"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."}}} +{"component":{"kind":"component","name":"spring-batch","title":"Spring Batch","description":"Send messages to Spring Batch for further processing.","deprecated":false,"firstVersion":"2.10.0","label":"workflow","javaType":"org.apache.camel.component.spring.batch.SpringBatchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-spring-batch","version":"4.8.2","scheme":"spring-batch","extendsScheme":"","syntax":"spring-batch:jobName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"jobName":{"index":0,"kind":"path","displayName":"Job Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the Spring Batch job located in the registry."},"jobFromHeader":{"index":1,"kind":"parameter","displayName":"Job From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Explicitly defines if the jobName should be taken from the headers instead of the URI."},"jobLauncher":{"index":2,"kind":"parameter","displayName":"Job Launcher","group":"producer","label":"","required":false,"type":"object","javaType":"org.springframework.batch.core.launch.JobLauncher","deprecated":false,"autowired":false,"secret":false,"description":"Explicitly specifies a JobLauncher to be used."},"jobRegistry":{"index":3,"kind":"parameter","displayName":"Job Registry","group":"producer","label":"","required":false,"type":"object","javaType":"org.springframework.batch.core.configuration.JobRegistry","deprecated":false,"autowired":false,"secret":false,"description":"Explicitly specifies a JobRegistry to be used."},"lazyStartProducer":{"index":4,"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."}}} , -{"component":{"kind":"component","name":"spring-event","title":"Spring Event","description":"Listen for Spring Application Events.","deprecated":false,"firstVersion":"1.4.0","label":"messaging","javaType":"org.apache.camel.component.event.EventComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-spring","version":"4.8.1","scheme":"spring-event","extendsScheme":"","syntax":"spring-event:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Name of endpoint"},"bridgeErrorHandler":{"index":1,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":2,"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":{"index":3,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":4,"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."}}} +{"component":{"kind":"component","name":"spring-event","title":"Spring Event","description":"Listen for Spring Application Events.","deprecated":false,"firstVersion":"1.4.0","label":"messaging","javaType":"org.apache.camel.component.event.EventComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-spring","version":"4.8.2","scheme":"spring-event","extendsScheme":"","syntax":"spring-event:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Name of endpoint"},"bridgeErrorHandler":{"index":1,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":2,"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":{"index":3,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":4,"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."}}} , -{"component":{"kind":"component","name":"spring-jdbc","title":"Spring JDBC","description":"Access databases through SQL and JDBC with Spring Transaction support.","deprecated":false,"firstVersion":"3.10.0","label":"database","javaType":"org.apache.camel.component.spring.jdbc.SpringJdbcComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-spring-jdbc","version":"4.8.1","scheme":"spring-jdbc","extendsScheme":"","syntax":"spring-jdbc:dataSourceName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelJdbcUpdateCount":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the query is an UPDATE, query the update count is returned in this OUT header.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_UPDATE_COUNT"},"CamelJdbcRowCount":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the query is a SELECT, query the row count is returned in this OUT header.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_ROW_COUNT"},"CamelJdbcColumnNames":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The column names from the ResultSet as a java.util.Set type.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_COLUMN_NAMES"},"CamelJdbcParameters":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A java.util.Map which has the headers to be used if useHeadersAsParameters has been enabled.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_PARAMETERS"},"CamelRetrieveGeneratedKeys":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Set its value to true to retrieve generated keys","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_RETRIEVE_GENERATED_KEYS"},"CamelGeneratedColumns":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String[] or int[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set it to specify the expected generated columns","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_GENERATED_COLUMNS"},"CamelGeneratedKeysRowCount":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of rows in the header that contains generated keys.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_GENERATED_KEYS_ROW_COUNT"},"CamelGeneratedKeysRows":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Rows that contains the generated keys.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_GENERATED_KEYS_DATA"}},"properties":{"dataSourceName":{"index":0,"kind":"path","displayName":"Data Source Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of DataSource to lookup in the Registry. If the name is dataSource or default, then Camel will attempt to lookup a default DataSource from the registry, meaning if there is a only one instance of DataSource found, then this DataSource will be used."},"allowNamedParameters":{"index":1,"kind":"parameter","displayName":"Allow Named Parameters","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to allow using named parameters in the queries."},"outputClass":{"index":2,"kind":"parameter","displayName":"Output Class","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList."},"outputType":{"index":3,"kind":"parameter","displayName":"Output Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.JdbcOutputType","enum":["SelectOne","SelectList","StreamList"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SelectList","description":"Determines the output the producer should use."},"parameters":{"index":4,"kind":"parameter","displayName":"Parameters","group":"producer","label":"","required":false,"type":"object","javaType":"java.util.Map","prefix":"statement.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Optional parameters to the java.sql.Statement. For example to set maxRows, fetchSize etc."},"readSize":{"index":5,"kind":"parameter","displayName":"Read Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The default maximum number of rows that can be read by a polling query. The default value is 0."},"resetAutoCommit":{"index":6,"kind":"parameter","displayName":"Reset Auto Commit","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Camel will set the autoCommit on the JDBC connection to be false, commit the change after executed the statement and reset the autoCommit flag of the connection at the end, if the resetAutoCommit is true. If the JDBC connection doesn't support to reset the autoCommit flag, you can set the resetAutoCommit flag to be false, and Camel will not try to reset the autoCommit flag. When used with XA transactions you most likely need to set it to false so that the transaction manager is in charge of committing this tx."},"transacted":{"index":7,"kind":"parameter","displayName":"Transacted","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether transactions are in use."},"useGetBytesForBlob":{"index":8,"kind":"parameter","displayName":"Use Get Bytes For Blob","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To read BLOB columns as bytes instead of string data. This may be needed for certain databases such as Oracle where you must read BLOB columns as bytes."},"useHeadersAsParameters":{"index":9,"kind":"parameter","displayName":"Use Headers As Parameters","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Set this option to true to use the prepareStatementStrategy with named parameters. This allows to define queries with named placeholders, and use headers with the dynamic values for the query placeholders."},"useJDBC4ColumnNameAndLabelSemantics":{"index":10,"kind":"parameter","displayName":"Use JDBC4 Column Name And Label Semantics","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name. JDBC 4.0 uses columnLabel to get the column name where as JDBC 3.0 uses both columnName or columnLabel. Unfortunately JDBC drivers behave differently so you can use this option to work out issues around your JDBC driver if you get problem using this component This option is default true."},"lazyStartProducer":{"index":11,"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."},"beanRowMapper":{"index":12,"kind":"parameter","displayName":"Bean Row Mapper","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.BeanRowMapper","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.component.jdbc.BeanRowMapper when using outputClass. The default implementation will lower case the row names and skip underscores, and dashes. For example CUST_ID is mapped as custId."},"connectionStrategy":{"index":13,"kind":"parameter","displayName":"Connection Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.ConnectionStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom strategy for working with connections. Do not use a custom strategy when using the spring-jdbc component because a special Spring ConnectionStrategy is used by default to support Spring Transactions."},"prepareStatementStrategy":{"index":14,"kind":"parameter","displayName":"Prepare Statement Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Allows the plugin to use a custom org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy to control preparation of the query and prepared statement."}}} +{"component":{"kind":"component","name":"spring-jdbc","title":"Spring JDBC","description":"Access databases through SQL and JDBC with Spring Transaction support.","deprecated":false,"firstVersion":"3.10.0","label":"database","javaType":"org.apache.camel.component.spring.jdbc.SpringJdbcComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-spring-jdbc","version":"4.8.2","scheme":"spring-jdbc","extendsScheme":"","syntax":"spring-jdbc:dataSourceName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelJdbcUpdateCount":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the query is an UPDATE, query the update count is returned in this OUT header.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_UPDATE_COUNT"},"CamelJdbcRowCount":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If the query is a SELECT, query the row count is returned in this OUT header.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_ROW_COUNT"},"CamelJdbcColumnNames":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The column names from the ResultSet as a java.util.Set type.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_COLUMN_NAMES"},"CamelJdbcParameters":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A java.util.Map which has the headers to be used if useHeadersAsParameters has been enabled.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_PARAMETERS"},"CamelRetrieveGeneratedKeys":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Set its value to true to retrieve generated keys","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_RETRIEVE_GENERATED_KEYS"},"CamelGeneratedColumns":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String[] or int[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set it to specify the expected generated columns","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_GENERATED_COLUMNS"},"CamelGeneratedKeysRowCount":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of rows in the header that contains generated keys.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_GENERATED_KEYS_ROW_COUNT"},"CamelGeneratedKeysRows":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Rows that contains the generated keys.","constantName":"org.apache.camel.component.jdbc.JdbcConstants#JDBC_GENERATED_KEYS_DATA"}},"properties":{"dataSourceName":{"index":0,"kind":"path","displayName":"Data Source Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of DataSource to lookup in the Registry. If the name is dataSource or default, then Camel will attempt to lookup a default DataSource from the registry, meaning if there is a only one instance of DataSource found, then this DataSource will be used."},"allowNamedParameters":{"index":1,"kind":"parameter","displayName":"Allow Named Parameters","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to allow using named parameters in the queries."},"outputClass":{"index":2,"kind":"parameter","displayName":"Output Class","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList."},"outputType":{"index":3,"kind":"parameter","displayName":"Output Type","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.JdbcOutputType","enum":["SelectOne","SelectList","StreamList"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SelectList","description":"Determines the output the producer should use."},"parameters":{"index":4,"kind":"parameter","displayName":"Parameters","group":"producer","label":"","required":false,"type":"object","javaType":"java.util.Map","prefix":"statement.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Optional parameters to the java.sql.Statement. For example to set maxRows, fetchSize etc."},"readSize":{"index":5,"kind":"parameter","displayName":"Read Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The default maximum number of rows that can be read by a polling query. The default value is 0."},"resetAutoCommit":{"index":6,"kind":"parameter","displayName":"Reset Auto Commit","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Camel will set the autoCommit on the JDBC connection to be false, commit the change after executed the statement and reset the autoCommit flag of the connection at the end, if the resetAutoCommit is true. If the JDBC connection doesn't support to reset the autoCommit flag, you can set the resetAutoCommit flag to be false, and Camel will not try to reset the autoCommit flag. When used with XA transactions you most likely need to set it to false so that the transaction manager is in charge of committing this tx."},"transacted":{"index":7,"kind":"parameter","displayName":"Transacted","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether transactions are in use."},"useGetBytesForBlob":{"index":8,"kind":"parameter","displayName":"Use Get Bytes For Blob","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To read BLOB columns as bytes instead of string data. This may be needed for certain databases such as Oracle where you must read BLOB columns as bytes."},"useHeadersAsParameters":{"index":9,"kind":"parameter","displayName":"Use Headers As Parameters","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Set this option to true to use the prepareStatementStrategy with named parameters. This allows to define queries with named placeholders, and use headers with the dynamic values for the query placeholders."},"useJDBC4ColumnNameAndLabelSemantics":{"index":10,"kind":"parameter","displayName":"Use JDBC4 Column Name And Label Semantics","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name. JDBC 4.0 uses columnLabel to get the column name where as JDBC 3.0 uses both columnName or columnLabel. Unfortunately JDBC drivers behave differently so you can use this option to work out issues around your JDBC driver if you get problem using this component This option is default true."},"lazyStartProducer":{"index":11,"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."},"beanRowMapper":{"index":12,"kind":"parameter","displayName":"Bean Row Mapper","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.BeanRowMapper","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.component.jdbc.BeanRowMapper when using outputClass. The default implementation will lower case the row names and skip underscores, and dashes. For example CUST_ID is mapped as custId."},"connectionStrategy":{"index":13,"kind":"parameter","displayName":"Connection Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.ConnectionStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom strategy for working with connections. Do not use a custom strategy when using the spring-jdbc component because a special Spring ConnectionStrategy is used by default to support Spring Transactions."},"prepareStatementStrategy":{"index":14,"kind":"parameter","displayName":"Prepare Statement Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Allows the plugin to use a custom org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy to control preparation of the query and prepared statement."}}} , -{"component":{"kind":"component","name":"spring-ldap","title":"Spring LDAP","description":"Perform searches in LDAP servers using filters as the message payload.","deprecated":false,"firstVersion":"2.11.0","label":"security","javaType":"org.apache.camel.component.springldap.SpringLdapComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-spring-ldap","version":"4.8.1","scheme":"spring-ldap","extendsScheme":"","syntax":"spring-ldap:templateName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"templateName":{"index":0,"kind":"path","displayName":"Template Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the Spring LDAP Template bean"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.springldap.LdapOperation","enum":["SEARCH","BIND","UNBIND","AUTHENTICATE","MODIFY_ATTRIBUTES","FUNCTION_DRIVEN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The LDAP operation to be performed."},"scope":{"index":2,"kind":"parameter","displayName":"Scope","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["object","onelevel","subtree"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"subtree","description":"The scope of the search operation."},"lazyStartProducer":{"index":3,"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."}}} +{"component":{"kind":"component","name":"spring-ldap","title":"Spring LDAP","description":"Perform searches in LDAP servers using filters as the message payload.","deprecated":false,"firstVersion":"2.11.0","label":"security","javaType":"org.apache.camel.component.springldap.SpringLdapComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-spring-ldap","version":"4.8.2","scheme":"spring-ldap","extendsScheme":"","syntax":"spring-ldap:templateName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"properties":{"templateName":{"index":0,"kind":"path","displayName":"Template Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the Spring LDAP Template bean"},"operation":{"index":1,"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.springldap.LdapOperation","enum":["SEARCH","BIND","UNBIND","AUTHENTICATE","MODIFY_ATTRIBUTES","FUNCTION_DRIVEN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The LDAP operation to be performed."},"scope":{"index":2,"kind":"parameter","displayName":"Scope","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["object","onelevel","subtree"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"subtree","description":"The scope of the search operation."},"lazyStartProducer":{"index":3,"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."}}} , -{"component":{"kind":"component","name":"spring-rabbitmq","title":"Spring RabbitMQ","description":"Send and receive messages from RabbitMQ using the Spring RabbitMQ client.","deprecated":false,"firstVersion":"3.8.0","label":"messaging","javaType":"org.apache.camel.component.springrabbit.SpringRabbitMQComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-spring-rabbitmq","version":"4.8.1","scheme":"spring-rabbitmq","extendsScheme":"","syntax":"spring-rabbitmq:exchangeName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelSpringRabbitmqRoutingOverrideKey":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To override the endpoint configuration's routing key.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#ROUTING_OVERRIDE_KEY"},"CamelSpringRabbitmqExchangeOverrideName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To override the endpoint configuration's exchange name.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#EXCHANGE_OVERRIDE_NAME"},"CamelSpringRabbitmqRedelivered":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Whether the message was previously delivered and requeued.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#REDELIVERED"},"CamelSpringRabbitmqDeliveryTag":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Delivery tag for manual acknowledge mode.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#DELIVERY_TAG"},"CamelSpringRabbitmqExchangeName":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The exchange name that was used when publishing the message.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#EXCHANGE_NAME"},"CamelSpringRabbitmqRoutingKey":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The routing key that was used when publishing the message.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#ROUTING_KEY"},"CamelSpringRabbitmqDeliveryMode":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"MessageDeliveryMode","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message delivery mode.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#DELIVERY_MODE"},"CamelSpringRabbitmqType":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Application-specific message type.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#TYPE"},"CamelSpringRabbitmqContentType":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message content type.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#CONTENT_TYPE"},"CamelSpringRabbitmqContentLength":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message content length.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#CONTENT_LENGTH"},"CamelSpringRabbitmqContentEncoding":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content encoding used by applications.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#CONTENT_ENCODING"},"CamelSpringRabbitmqMessageId":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Arbitrary message id.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#MESSAGE_ID"},"CamelSpringRabbitmqCorrelationId":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Identifier to correlate RPC responses with requests.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#CORRELATION_ID"},"CamelSpringRabbitmqReplyTo":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Commonly used to name a callback queue.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#REPLY_TO"},"CamelSpringRabbitmqExpiration":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Per-message TTL.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#EXPIRATION"},"CamelSpringRabbitmqTimestamp":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Application-provided timestamp.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#TIMESTAMP"},"CamelSpringRabbitmqUserId":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Validated user id.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#USER_ID"},"CamelSpringRabbitmqAppId":{"index":17,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The application name.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#APP_ID"},"CamelSpringRabbitmqPriority":{"index":18,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message priority.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#PRIORITY"},"CamelSpringRabbitmqClusterId":{"index":19,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cluster id.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#CLUSTER_ID"}},"properties":{"exchangeName":{"index":0,"kind":"path","displayName":"Exchange Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The exchange name determines the exchange to which the produced messages will be sent to. In the case of consumers, the exchange name determines the exchange the queue will be bound to. Note: to use default exchange then do not use empty name, but use default instead."},"connectionFactory":{"index":1,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"common","required":false,"type":"object","javaType":"org.springframework.amqp.rabbit.connection.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"deadLetterExchange":{"index":2,"kind":"parameter","displayName":"Dead Letter Exchange","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the dead letter exchange"},"deadLetterExchangeType":{"index":3,"kind":"parameter","displayName":"Dead Letter Exchange Type","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","enum":["direct","fanout","headers","topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"direct","description":"The type of the dead letter exchange"},"deadLetterQueue":{"index":4,"kind":"parameter","displayName":"Dead Letter Queue","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the dead letter queue"},"deadLetterRoutingKey":{"index":5,"kind":"parameter","displayName":"Dead Letter Routing Key","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The routing key for the dead letter exchange"},"disableReplyTo":{"index":6,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether Camel ignores the ReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the ReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."},"queues":{"index":7,"kind":"parameter","displayName":"Queues","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The queue(s) to use for consuming or producing messages. Multiple queue names can be separated by comma. If none has been configured then Camel will generate an unique id as the queue name."},"routingKey":{"index":8,"kind":"parameter","displayName":"Routing Key","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The value of a routing key to use. Default is empty which is not helpful when using the default (or any direct) exchange, but fine if the exchange is a headers exchange for instance."},"testConnectionOnStartup":{"index":9,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"acknowledgeMode":{"index":10,"kind":"parameter","displayName":"Acknowledge Mode","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.springframework.amqp.core.AcknowledgeMode","enum":["NONE","MANUAL","AUTO"],"deprecated":false,"autowired":false,"secret":false,"description":"Flag controlling the behaviour of the container with respect to message acknowledgement. The most common usage is to let the container handle the acknowledgements (so the listener doesn't need to know about the channel or the message). Set to AcknowledgeMode.MANUAL if the listener will send the acknowledgements itself using Channel.basicAck(long, boolean). Manual acks are consistent with either a transactional or non-transactional channel, but if you are doing no other work on the channel at the same other than receiving a single message then the transaction is probably unnecessary. Set to AcknowledgeMode.NONE to tell the broker not to expect any acknowledgements, and it will assume all messages are acknowledged as soon as they are sent (this is autoack in native Rabbit broker terms). If AcknowledgeMode.NONE then the channel cannot be transactional (so the container will fail on start up if that flag is accidentally set)."},"asyncConsumer":{"index":11,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the consumer processes the Exchange asynchronously. If enabled then the consumer may pickup the next message from the queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the consumer will pickup the next message from the queue."},"autoDeclare":{"index":12,"kind":"parameter","displayName":"Auto Declare","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether the consumer should auto declare binding between exchange, queue and routing key when starting."},"autoStartup":{"index":13,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether the consumer container should auto-startup."},"exchangeType":{"index":14,"kind":"parameter","displayName":"Exchange Type","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["direct","fanout","headers","topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"direct","description":"The type of the exchange"},"exclusive":{"index":15,"kind":"parameter","displayName":"Exclusive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Set to true for an exclusive consumer"},"maximumRetryAttempts":{"index":16,"kind":"parameter","displayName":"Maximum Retry Attempts","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5,"description":"How many times a Rabbitmq consumer will try the same message if Camel failed to process the message (The number of attempts includes the initial try)"},"noLocal":{"index":17,"kind":"parameter","displayName":"No Local","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Set to true for an no-local consumer"},"rejectAndDontRequeue":{"index":18,"kind":"parameter","displayName":"Reject And Dont Requeue","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether a Rabbitmq consumer should reject the message without requeuing. This enables failed messages to be sent to a Dead Letter Exchange/Queue, if the broker is so configured."},"retryDelay":{"index":19,"kind":"parameter","displayName":"Retry Delay","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Delay in millis a Rabbitmq consumer will wait before redelivering a message that Camel failed to process"},"bridgeErrorHandler":{"index":20,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"concurrentConsumers":{"index":21,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The number of consumers"},"exceptionHandler":{"index":22,"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":{"index":23,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"maxConcurrentConsumers":{"index":24,"kind":"parameter","displayName":"Max Concurrent Consumers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The maximum number of consumers (available only with SMLC)"},"messageListenerContainerType":{"index":25,"kind":"parameter","displayName":"Message Listener Container Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["DMLC","SMLC"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DMLC","description":"The type of the MessageListenerContainer"},"prefetchCount":{"index":26,"kind":"parameter","displayName":"Prefetch Count","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"Tell the broker how many messages to send in a single request. Often this can be set quite high to improve throughput."},"retry":{"index":27,"kind":"parameter","displayName":"Retry","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.springframework.retry.interceptor.RetryOperationsInterceptor","deprecated":false,"autowired":false,"secret":false,"description":"Custom retry configuration to use. If this is configured then the other settings such as maximumRetryAttempts for retry are not in use."},"allowNullBody":{"index":28,"kind":"parameter","displayName":"Allow Null Body","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an MessageConversionException is thrown."},"autoDeclareProducer":{"index":29,"kind":"parameter","displayName":"Auto Declare Producer","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether the producer should auto declare binding between exchange, queue and routing key when starting."},"confirm":{"index":30,"kind":"parameter","displayName":"Confirm","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["auto","enabled","disabled"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"auto","description":"Controls whether to wait for confirms. The connection factory must be configured for publisher confirms and this method. auto = Camel detects if the connection factory uses confirms or not. disabled = Confirms is disabled. enabled = Confirms is enabled."},"confirmTimeout":{"index":31,"kind":"parameter","displayName":"Confirm Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","description":"Specify the timeout in milliseconds to be used when waiting for a message sent to be confirmed by RabbitMQ when doing send only messaging (InOnly). The default value is 5 seconds. A negative value indicates an indefinite timeout."},"replyTimeout":{"index":32,"kind":"parameter","displayName":"Reply Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Specify the timeout in milliseconds to be used when waiting for a reply message when doing request/reply (InOut) messaging. The default value is 30 seconds. A negative value indicates an indefinite timeout (Beware that this will cause a memory leak if a reply is not received)."},"skipBindQueue":{"index":33,"kind":"parameter","displayName":"Skip Bind Queue","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true the queue will not be bound to the exchange after declaring it."},"skipDeclareExchange":{"index":34,"kind":"parameter","displayName":"Skip Declare Exchange","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This can be used if we need to declare the queue but not the exchange."},"skipDeclareQueue":{"index":35,"kind":"parameter","displayName":"Skip Declare Queue","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key."},"usePublisherConnection":{"index":36,"kind":"parameter","displayName":"Use Publisher Connection","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Use a separate connection for publishers and consumers"},"lazyStartProducer":{"index":37,"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."},"args":{"index":38,"kind":"parameter","displayName":"Args","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"arg.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Specify arguments for configuring the different RabbitMQ concepts, a different prefix is required for each element: arg.consumer. arg.exchange. arg.queue. arg.binding. arg.dlq.exchange. arg.dlq.queue. arg.dlq.binding. For example to declare a queue with message ttl argument: args=arg.queue.x-message-ttl=60000"},"messageConverter":{"index":39,"kind":"parameter","displayName":"Message Converter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.amqp.support.converter.MessageConverter","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom MessageConverter so you can be in control how to map to/from a org.springframework.amqp.core.Message."},"messagePropertiesConverter":{"index":40,"kind":"parameter","displayName":"Message Properties Converter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.springrabbit.MessagePropertiesConverter","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom MessagePropertiesConverter so you can be in control how to map to/from a org.springframework.amqp.core.MessageProperties."},"synchronous":{"index":41,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"}}} +{"component":{"kind":"component","name":"spring-rabbitmq","title":"Spring RabbitMQ","description":"Send and receive messages from RabbitMQ using the Spring RabbitMQ client.","deprecated":false,"firstVersion":"3.8.0","label":"messaging","javaType":"org.apache.camel.component.springrabbit.SpringRabbitMQComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-spring-rabbitmq","version":"4.8.2","scheme":"spring-rabbitmq","extendsScheme":"","syntax":"spring-rabbitmq:exchangeName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelSpringRabbitmqRoutingOverrideKey":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To override the endpoint configuration's routing key.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#ROUTING_OVERRIDE_KEY"},"CamelSpringRabbitmqExchangeOverrideName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To override the endpoint configuration's exchange name.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#EXCHANGE_OVERRIDE_NAME"},"CamelSpringRabbitmqRedelivered":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Whether the message was previously delivered and requeued.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#REDELIVERED"},"CamelSpringRabbitmqDeliveryTag":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Delivery tag for manual acknowledge mode.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#DELIVERY_TAG"},"CamelSpringRabbitmqExchangeName":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The exchange name that was used when publishing the message.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#EXCHANGE_NAME"},"CamelSpringRabbitmqRoutingKey":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The routing key that was used when publishing the message.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#ROUTING_KEY"},"CamelSpringRabbitmqDeliveryMode":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"MessageDeliveryMode","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message delivery mode.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#DELIVERY_MODE"},"CamelSpringRabbitmqType":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Application-specific message type.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#TYPE"},"CamelSpringRabbitmqContentType":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message content type.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#CONTENT_TYPE"},"CamelSpringRabbitmqContentLength":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message content length.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#CONTENT_LENGTH"},"CamelSpringRabbitmqContentEncoding":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Content encoding used by applications.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#CONTENT_ENCODING"},"CamelSpringRabbitmqMessageId":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Arbitrary message id.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#MESSAGE_ID"},"CamelSpringRabbitmqCorrelationId":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Identifier to correlate RPC responses with requests.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#CORRELATION_ID"},"CamelSpringRabbitmqReplyTo":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Commonly used to name a callback queue.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#REPLY_TO"},"CamelSpringRabbitmqExpiration":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Per-message TTL.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#EXPIRATION"},"CamelSpringRabbitmqTimestamp":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Application-provided timestamp.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#TIMESTAMP"},"CamelSpringRabbitmqUserId":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Validated user id.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#USER_ID"},"CamelSpringRabbitmqAppId":{"index":17,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The application name.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#APP_ID"},"CamelSpringRabbitmqPriority":{"index":18,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message priority.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#PRIORITY"},"CamelSpringRabbitmqClusterId":{"index":19,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cluster id.","constantName":"org.apache.camel.component.springrabbit.SpringRabbitMQConstants#CLUSTER_ID"}},"properties":{"exchangeName":{"index":0,"kind":"path","displayName":"Exchange Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The exchange name determines the exchange to which the produced messages will be sent to. In the case of consumers, the exchange name determines the exchange the queue will be bound to. Note: to use default exchange then do not use empty name, but use default instead."},"connectionFactory":{"index":1,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"common","required":false,"type":"object","javaType":"org.springframework.amqp.rabbit.connection.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"deadLetterExchange":{"index":2,"kind":"parameter","displayName":"Dead Letter Exchange","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the dead letter exchange"},"deadLetterExchangeType":{"index":3,"kind":"parameter","displayName":"Dead Letter Exchange Type","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","enum":["direct","fanout","headers","topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"direct","description":"The type of the dead letter exchange"},"deadLetterQueue":{"index":4,"kind":"parameter","displayName":"Dead Letter Queue","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the dead letter queue"},"deadLetterRoutingKey":{"index":5,"kind":"parameter","displayName":"Dead Letter Routing Key","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The routing key for the dead letter exchange"},"disableReplyTo":{"index":6,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether Camel ignores the ReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the ReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."},"queues":{"index":7,"kind":"parameter","displayName":"Queues","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The queue(s) to use for consuming or producing messages. Multiple queue names can be separated by comma. If none has been configured then Camel will generate an unique id as the queue name."},"routingKey":{"index":8,"kind":"parameter","displayName":"Routing Key","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The value of a routing key to use. Default is empty which is not helpful when using the default (or any direct) exchange, but fine if the exchange is a headers exchange for instance."},"testConnectionOnStartup":{"index":9,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"acknowledgeMode":{"index":10,"kind":"parameter","displayName":"Acknowledge Mode","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.springframework.amqp.core.AcknowledgeMode","enum":["NONE","MANUAL","AUTO"],"deprecated":false,"autowired":false,"secret":false,"description":"Flag controlling the behaviour of the container with respect to message acknowledgement. The most common usage is to let the container handle the acknowledgements (so the listener doesn't need to know about the channel or the message). Set to AcknowledgeMode.MANUAL if the listener will send the acknowledgements itself using Channel.basicAck(long, boolean). Manual acks are consistent with either a transactional or non-transactional channel, but if you are doing no other work on the channel at the same other than receiving a single message then the transaction is probably unnecessary. Set to AcknowledgeMode.NONE to tell the broker not to expect any acknowledgements, and it will assume all messages are acknowledged as soon as they are sent (this is autoack in native Rabbit broker terms). If AcknowledgeMode.NONE then the channel cannot be transactional (so the container will fail on start up if that flag is accidentally set)."},"asyncConsumer":{"index":11,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the consumer processes the Exchange asynchronously. If enabled then the consumer may pickup the next message from the queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the consumer will pickup the next message from the queue."},"autoDeclare":{"index":12,"kind":"parameter","displayName":"Auto Declare","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether the consumer should auto declare binding between exchange, queue and routing key when starting."},"autoStartup":{"index":13,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether the consumer container should auto-startup."},"exchangeType":{"index":14,"kind":"parameter","displayName":"Exchange Type","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["direct","fanout","headers","topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"direct","description":"The type of the exchange"},"exclusive":{"index":15,"kind":"parameter","displayName":"Exclusive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Set to true for an exclusive consumer"},"maximumRetryAttempts":{"index":16,"kind":"parameter","displayName":"Maximum Retry Attempts","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5,"description":"How many times a Rabbitmq consumer will try the same message if Camel failed to process the message (The number of attempts includes the initial try)"},"noLocal":{"index":17,"kind":"parameter","displayName":"No Local","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Set to true for an no-local consumer"},"rejectAndDontRequeue":{"index":18,"kind":"parameter","displayName":"Reject And Dont Requeue","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether a Rabbitmq consumer should reject the message without requeuing. This enables failed messages to be sent to a Dead Letter Exchange/Queue, if the broker is so configured."},"retryDelay":{"index":19,"kind":"parameter","displayName":"Retry Delay","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Delay in millis a Rabbitmq consumer will wait before redelivering a message that Camel failed to process"},"bridgeErrorHandler":{"index":20,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"concurrentConsumers":{"index":21,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The number of consumers"},"exceptionHandler":{"index":22,"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":{"index":23,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"maxConcurrentConsumers":{"index":24,"kind":"parameter","displayName":"Max Concurrent Consumers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The maximum number of consumers (available only with SMLC)"},"messageListenerContainerType":{"index":25,"kind":"parameter","displayName":"Message Listener Container Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["DMLC","SMLC"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DMLC","description":"The type of the MessageListenerContainer"},"prefetchCount":{"index":26,"kind":"parameter","displayName":"Prefetch Count","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"Tell the broker how many messages to send in a single request. Often this can be set quite high to improve throughput."},"retry":{"index":27,"kind":"parameter","displayName":"Retry","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.springframework.retry.interceptor.RetryOperationsInterceptor","deprecated":false,"autowired":false,"secret":false,"description":"Custom retry configuration to use. If this is configured then the other settings such as maximumRetryAttempts for retry are not in use."},"allowNullBody":{"index":28,"kind":"parameter","displayName":"Allow Null Body","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an MessageConversionException is thrown."},"autoDeclareProducer":{"index":29,"kind":"parameter","displayName":"Auto Declare Producer","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether the producer should auto declare binding between exchange, queue and routing key when starting."},"confirm":{"index":30,"kind":"parameter","displayName":"Confirm","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["auto","enabled","disabled"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"auto","description":"Controls whether to wait for confirms. The connection factory must be configured for publisher confirms and this method. auto = Camel detects if the connection factory uses confirms or not. disabled = Confirms is disabled. enabled = Confirms is enabled."},"confirmTimeout":{"index":31,"kind":"parameter","displayName":"Confirm Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5000","description":"Specify the timeout in milliseconds to be used when waiting for a message sent to be confirmed by RabbitMQ when doing send only messaging (InOnly). The default value is 5 seconds. A negative value indicates an indefinite timeout."},"replyTimeout":{"index":32,"kind":"parameter","displayName":"Reply Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Specify the timeout in milliseconds to be used when waiting for a reply message when doing request/reply (InOut) messaging. The default value is 30 seconds. A negative value indicates an indefinite timeout (Beware that this will cause a memory leak if a reply is not received)."},"skipBindQueue":{"index":33,"kind":"parameter","displayName":"Skip Bind Queue","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true the queue will not be bound to the exchange after declaring it."},"skipDeclareExchange":{"index":34,"kind":"parameter","displayName":"Skip Declare Exchange","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This can be used if we need to declare the queue but not the exchange."},"skipDeclareQueue":{"index":35,"kind":"parameter","displayName":"Skip Declare Queue","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key."},"usePublisherConnection":{"index":36,"kind":"parameter","displayName":"Use Publisher Connection","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Use a separate connection for publishers and consumers"},"lazyStartProducer":{"index":37,"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."},"args":{"index":38,"kind":"parameter","displayName":"Args","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"arg.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Specify arguments for configuring the different RabbitMQ concepts, a different prefix is required for each element: arg.consumer. arg.exchange. arg.queue. arg.binding. arg.dlq.exchange. arg.dlq.queue. arg.dlq.binding. For example to declare a queue with message ttl argument: args=arg.queue.x-message-ttl=60000"},"messageConverter":{"index":39,"kind":"parameter","displayName":"Message Converter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.springframework.amqp.support.converter.MessageConverter","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom MessageConverter so you can be in control how to map to/from a org.springframework.amqp.core.Message."},"messagePropertiesConverter":{"index":40,"kind":"parameter","displayName":"Message Properties Converter","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.springrabbit.MessagePropertiesConverter","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom MessagePropertiesConverter so you can be in control how to map to/from a org.springframework.amqp.core.MessageProperties."},"synchronous":{"index":41,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"}}} , -{"component":{"kind":"component","name":"spring-redis","title":"Spring Redis","description":"Send and receive messages from Redis.","deprecated":false,"firstVersion":"2.11.0","label":"cache","javaType":"org.apache.camel.component.redis.RedisComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-spring-redis","version":"4.8.1","scheme":"spring-redis","extendsScheme":"","syntax":"spring-redis:host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelRedis.Command":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The command to perform.","constantName":"org.apache.camel.component.redis.RedisConstants#COMMAND"},"CamelRedis.Key":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key.","constantName":"org.apache.camel.component.redis.RedisConstants#KEY"},"CamelRedis.Keys":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The keys.","constantName":"org.apache.camel.component.redis.RedisConstants#KEYS"},"CamelRedis.Field":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The field.","constantName":"org.apache.camel.component.redis.RedisConstants#FIELD"},"CamelRedis.Fields":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The fields.","constantName":"org.apache.camel.component.redis.RedisConstants#FIELDS"},"CamelRedis.Value":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value.","constantName":"org.apache.camel.component.redis.RedisConstants#VALUE"},"CamelRedis.Values":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map or Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The values.","constantName":"org.apache.camel.component.redis.RedisConstants#VALUES"},"CamelRedis.Start":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Start","constantName":"org.apache.camel.component.redis.RedisConstants#START"},"CamelRedis.End":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"End","constantName":"org.apache.camel.component.redis.RedisConstants#END"},"CamelRedis.Timeout":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timeout.","constantName":"org.apache.camel.component.redis.RedisConstants#TIMEOUT"},"CamelRedis.Offset":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The offset.","constantName":"org.apache.camel.component.redis.RedisConstants#OFFSET"},"CamelRedis.Destination":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The destination.","constantName":"org.apache.camel.component.redis.RedisConstants#DESTINATION"},"CamelRedis.Channel":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[] or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channel.","constantName":"org.apache.camel.component.redis.RedisConstants#CHANNEL"},"CamelRedis.Message":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message.","constantName":"org.apache.camel.component.redis.RedisConstants#MESSAGE"},"CamelRedis.Index":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index.","constantName":"org.apache.camel.component.redis.RedisConstants#INDEX"},"CamelRedis.Position":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The position.","constantName":"org.apache.camel.component.redis.RedisConstants#POSITION"},"CamelRedis.Pivot":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The pivot.","constantName":"org.apache.camel.component.redis.RedisConstants#PIVOT"},"CamelRedis.Count":{"index":17,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Count","constantName":"org.apache.camel.component.redis.RedisConstants#COUNT"},"CamelRedis.Timestamp":{"index":18,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp.","constantName":"org.apache.camel.component.redis.RedisConstants#TIMESTAMP"},"CamelRedis.Pattern":{"index":19,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[] or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The pattern.","constantName":"org.apache.camel.component.redis.RedisConstants#PATTERN"},"CamelRedis.Db":{"index":20,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The db.","constantName":"org.apache.camel.component.redis.RedisConstants#DB"},"CamelRedis.Score":{"index":21,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The score.","constantName":"org.apache.camel.component.redis.RedisConstants#SCORE"},"CamelRedis.Min":{"index":22,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The min.","constantName":"org.apache.camel.component.redis.RedisConstants#MIN"},"CamelRedis.Max":{"index":23,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The max.","constantName":"org.apache.camel.component.redis.RedisConstants#MAX"},"CamelRedis.Increment":{"index":24,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Increment.","constantName":"org.apache.camel.component.redis.RedisConstants#INCREMENT"},"CamelRedis.WithScore":{"index":25,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"WithScore.","constantName":"org.apache.camel.component.redis.RedisConstants#WITHSCORE"},"CamelRedis.Latitude":{"index":26,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Latitude.","constantName":"org.apache.camel.component.redis.RedisConstants#LATITUDE"},"CamelRedis.Longitude":{"index":27,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Longitude.","constantName":"org.apache.camel.component.redis.RedisConstants#LONGITUDE"},"CamelRedis.Radius":{"index":28,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Radius.","constantName":"org.apache.camel.component.redis.RedisConstants#RADIUS"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"The host where Redis server is running."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"Redis server port number"},"channels":{"index":2,"kind":"parameter","displayName":"Channels","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"List of topic names or name patterns to subscribe to. Multiple names can be separated by comma."},"command":{"index":3,"kind":"parameter","displayName":"Command","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.redis.Command","enum":["PING","SET","GET","QUIT","EXISTS","DEL","TYPE","FLUSHDB","KEYS","RANDOMKEY","RENAME","RENAMENX","RENAMEX","DBSIZE","EXPIRE","EXPIREAT","TTL","SELECT","MOVE","FLUSHALL","GETSET","MGET","SETNX","SETEX","MSET","MSETNX","DECRBY","DECR","INCRBY","INCR","APPEND","SUBSTR","HSET","HGET","HSETNX","HMSET","HMGET","HINCRBY","HEXISTS","HDEL","HLEN","HKEYS","HVALS","HGETALL","RPUSH","LPUSH","LLEN","LRANGE","LTRIM","LINDEX","LSET","LREM","LPOP","RPOP","RPOPLPUSH","SADD","SMEMBERS","SREM","SPOP","SMOVE","SCARD","SISMEMBER","SINTER","SINTERSTORE","SUNION","SUNIONSTORE","SDIFF","SDIFFSTORE","SRANDMEMBER","ZADD","ZRANGE","ZREM","ZINCRBY","ZRANK","ZREVRANK","ZREVRANGE","ZCARD","ZSCORE","MULTI","DISCARD","EXEC","WATCH","UNWATCH","SORT","BLPOP","BRPOP","AUTH","SUBSCRIBE","PUBLISH","UNSUBSCRIBE","PSUBSCRIBE","PUNSUBSCRIBE","ZCOUNT","ZRANGEBYSCORE","ZREVRANGEBYSCORE","ZREMRANGEBYRANK","ZREMRANGEBYSCORE","ZUNIONSTORE","ZINTERSTORE","SAVE","BGSAVE","BGREWRITEAOF","LASTSAVE","SHUTDOWN","INFO","MONITOR","SLAVEOF","CONFIG","STRLEN","SYNC","LPUSHX","PERSIST","RPUSHX","ECHO","LINSERT","DEBUG","BRPOPLPUSH","SETBIT","GETBIT","SETRANGE","GETRANGE","PEXPIRE","PEXPIREAT","GEOADD","GEODIST","GEOHASH","GEOPOS","GEORADIUS","GEORADIUSBYMEMBER"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SET","configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"Default command, which can be overridden by message header. Notice the consumer only supports the following commands: PSUBSCRIBE and SUBSCRIBE"},"connectionFactory":{"index":4,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"","required":false,"type":"object","javaType":"org.springframework.data.redis.connection.RedisConnectionFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"Reference to a pre-configured RedisConnectionFactory instance to use."},"redisTemplate":{"index":5,"kind":"parameter","displayName":"Redis Template","group":"common","label":"","required":false,"type":"object","javaType":"org.springframework.data.redis.core.RedisTemplate","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"Reference to a pre-configured RedisTemplate instance to use."},"serializer":{"index":6,"kind":"parameter","displayName":"Serializer","group":"common","label":"","required":false,"type":"object","javaType":"org.springframework.data.redis.serializer.RedisSerializer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"Reference to a pre-configured RedisSerializer instance to use."},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"listenerContainer":{"index":10,"kind":"parameter","displayName":"Listener Container","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.springframework.data.redis.listener.RedisMessageListenerContainer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"Reference to a pre-configured RedisMessageListenerContainer instance to use."},"lazyStartProducer":{"index":11,"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."}}} +{"component":{"kind":"component","name":"spring-redis","title":"Spring Redis","description":"Send and receive messages from Redis.","deprecated":false,"firstVersion":"2.11.0","label":"cache","javaType":"org.apache.camel.component.redis.RedisComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-spring-redis","version":"4.8.2","scheme":"spring-redis","extendsScheme":"","syntax":"spring-redis:host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelRedis.Command":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The command to perform.","constantName":"org.apache.camel.component.redis.RedisConstants#COMMAND"},"CamelRedis.Key":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key.","constantName":"org.apache.camel.component.redis.RedisConstants#KEY"},"CamelRedis.Keys":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The keys.","constantName":"org.apache.camel.component.redis.RedisConstants#KEYS"},"CamelRedis.Field":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The field.","constantName":"org.apache.camel.component.redis.RedisConstants#FIELD"},"CamelRedis.Fields":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The fields.","constantName":"org.apache.camel.component.redis.RedisConstants#FIELDS"},"CamelRedis.Value":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value.","constantName":"org.apache.camel.component.redis.RedisConstants#VALUE"},"CamelRedis.Values":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map or Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The values.","constantName":"org.apache.camel.component.redis.RedisConstants#VALUES"},"CamelRedis.Start":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Start","constantName":"org.apache.camel.component.redis.RedisConstants#START"},"CamelRedis.End":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"End","constantName":"org.apache.camel.component.redis.RedisConstants#END"},"CamelRedis.Timeout":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timeout.","constantName":"org.apache.camel.component.redis.RedisConstants#TIMEOUT"},"CamelRedis.Offset":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The offset.","constantName":"org.apache.camel.component.redis.RedisConstants#OFFSET"},"CamelRedis.Destination":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The destination.","constantName":"org.apache.camel.component.redis.RedisConstants#DESTINATION"},"CamelRedis.Channel":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[] or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The channel.","constantName":"org.apache.camel.component.redis.RedisConstants#CHANNEL"},"CamelRedis.Message":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message.","constantName":"org.apache.camel.component.redis.RedisConstants#MESSAGE"},"CamelRedis.Index":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index.","constantName":"org.apache.camel.component.redis.RedisConstants#INDEX"},"CamelRedis.Position":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The position.","constantName":"org.apache.camel.component.redis.RedisConstants#POSITION"},"CamelRedis.Pivot":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The pivot.","constantName":"org.apache.camel.component.redis.RedisConstants#PIVOT"},"CamelRedis.Count":{"index":17,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Count","constantName":"org.apache.camel.component.redis.RedisConstants#COUNT"},"CamelRedis.Timestamp":{"index":18,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp.","constantName":"org.apache.camel.component.redis.RedisConstants#TIMESTAMP"},"CamelRedis.Pattern":{"index":19,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[] or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The pattern.","constantName":"org.apache.camel.component.redis.RedisConstants#PATTERN"},"CamelRedis.Db":{"index":20,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The db.","constantName":"org.apache.camel.component.redis.RedisConstants#DB"},"CamelRedis.Score":{"index":21,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The score.","constantName":"org.apache.camel.component.redis.RedisConstants#SCORE"},"CamelRedis.Min":{"index":22,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The min.","constantName":"org.apache.camel.component.redis.RedisConstants#MIN"},"CamelRedis.Max":{"index":23,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The max.","constantName":"org.apache.camel.component.redis.RedisConstants#MAX"},"CamelRedis.Increment":{"index":24,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Increment.","constantName":"org.apache.camel.component.redis.RedisConstants#INCREMENT"},"CamelRedis.WithScore":{"index":25,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"WithScore.","constantName":"org.apache.camel.component.redis.RedisConstants#WITHSCORE"},"CamelRedis.Latitude":{"index":26,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Latitude.","constantName":"org.apache.camel.component.redis.RedisConstants#LATITUDE"},"CamelRedis.Longitude":{"index":27,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Longitude.","constantName":"org.apache.camel.component.redis.RedisConstants#LONGITUDE"},"CamelRedis.Radius":{"index":28,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Radius.","constantName":"org.apache.camel.component.redis.RedisConstants#RADIUS"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"The host where Redis server is running."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"Redis server port number"},"channels":{"index":2,"kind":"parameter","displayName":"Channels","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"List of topic names or name patterns to subscribe to. Multiple names can be separated by comma."},"command":{"index":3,"kind":"parameter","displayName":"Command","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.redis.Command","enum":["PING","SET","GET","QUIT","EXISTS","DEL","TYPE","FLUSHDB","KEYS","RANDOMKEY","RENAME","RENAMENX","RENAMEX","DBSIZE","EXPIRE","EXPIREAT","TTL","SELECT","MOVE","FLUSHALL","GETSET","MGET","SETNX","SETEX","MSET","MSETNX","DECRBY","DECR","INCRBY","INCR","APPEND","SUBSTR","HSET","HGET","HSETNX","HMSET","HMGET","HINCRBY","HEXISTS","HDEL","HLEN","HKEYS","HVALS","HGETALL","RPUSH","LPUSH","LLEN","LRANGE","LTRIM","LINDEX","LSET","LREM","LPOP","RPOP","RPOPLPUSH","SADD","SMEMBERS","SREM","SPOP","SMOVE","SCARD","SISMEMBER","SINTER","SINTERSTORE","SUNION","SUNIONSTORE","SDIFF","SDIFFSTORE","SRANDMEMBER","ZADD","ZRANGE","ZREM","ZINCRBY","ZRANK","ZREVRANK","ZREVRANGE","ZCARD","ZSCORE","MULTI","DISCARD","EXEC","WATCH","UNWATCH","SORT","BLPOP","BRPOP","AUTH","SUBSCRIBE","PUBLISH","UNSUBSCRIBE","PSUBSCRIBE","PUNSUBSCRIBE","ZCOUNT","ZRANGEBYSCORE","ZREVRANGEBYSCORE","ZREMRANGEBYRANK","ZREMRANGEBYSCORE","ZUNIONSTORE","ZINTERSTORE","SAVE","BGSAVE","BGREWRITEAOF","LASTSAVE","SHUTDOWN","INFO","MONITOR","SLAVEOF","CONFIG","STRLEN","SYNC","LPUSHX","PERSIST","RPUSHX","ECHO","LINSERT","DEBUG","BRPOPLPUSH","SETBIT","GETBIT","SETRANGE","GETRANGE","PEXPIRE","PEXPIREAT","GEOADD","GEODIST","GEOHASH","GEOPOS","GEORADIUS","GEORADIUSBYMEMBER"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SET","configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"Default command, which can be overridden by message header. Notice the consumer only supports the following commands: PSUBSCRIBE and SUBSCRIBE"},"connectionFactory":{"index":4,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"","required":false,"type":"object","javaType":"org.springframework.data.redis.connection.RedisConnectionFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"Reference to a pre-configured RedisConnectionFactory instance to use."},"redisTemplate":{"index":5,"kind":"parameter","displayName":"Redis Template","group":"common","label":"","required":false,"type":"object","javaType":"org.springframework.data.redis.core.RedisTemplate","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"Reference to a pre-configured RedisTemplate instance to use."},"serializer":{"index":6,"kind":"parameter","displayName":"Serializer","group":"common","label":"","required":false,"type":"object","javaType":"org.springframework.data.redis.serializer.RedisSerializer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"Reference to a pre-configured RedisSerializer instance to use."},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"listenerContainer":{"index":10,"kind":"parameter","displayName":"Listener Container","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.springframework.data.redis.listener.RedisMessageListenerContainer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.redis.RedisConfiguration","configurationField":"configuration","description":"Reference to a pre-configured RedisMessageListenerContainer instance to use."},"lazyStartProducer":{"index":11,"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."}}} , -{"component":{"kind":"component","name":"spring-ws","title":"Spring WebService","description":"Access external web services as a client or expose your own web services.","deprecated":false,"firstVersion":"2.6.0","label":"webservice","javaType":"org.apache.camel.component.spring.ws.SpringWebserviceComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-spring-ws","version":"4.8.1","scheme":"spring-ws","extendsScheme":"","syntax":"spring-ws:type:lookupKey:webServiceEndpointUri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelSpringWebserviceEndpointUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The endpoint URI","constantName":"org.apache.camel.component.spring.ws.SpringWebserviceConstants#SPRING_WS_ENDPOINT_URI"},"CamelSpringWebserviceSoapAction":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"SOAP action to include inside a SOAP request when accessing remote web services","constantName":"org.apache.camel.component.spring.ws.SpringWebserviceConstants#SPRING_WS_SOAP_ACTION"},"CamelSpringWebserviceSoapHeader":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"javax.xml.transform.Source","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The soap header source","constantName":"org.apache.camel.component.spring.ws.SpringWebserviceConstants#SPRING_WS_SOAP_HEADER"},"CamelSpringWebserviceAddressingAction":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"WS-Addressing 1.0 action header to include when accessing web services. The To header is set to the address of the web service as specified in the endpoint URI (default Spring-WS behavior).","constantName":"org.apache.camel.component.spring.ws.SpringWebserviceConstants#SPRING_WS_ADDRESSING_ACTION"},"CamelSpringWebserviceAddressingFaultTo":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details.","constantName":"org.apache.camel.component.spring.ws.SpringWebserviceConstants#SPRING_WS_ADDRESSING_PRODUCER_FAULT_TO"},"CamelSpringWebserviceAddressingReplyTo":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details.","constantName":"org.apache.camel.component.spring.ws.SpringWebserviceConstants#SPRING_WS_ADDRESSING_PRODUCER_REPLY_TO"},"breadcrumbId":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The breadcrumb id.","constantName":"org.apache.camel.component.spring.ws.SpringWebserviceConstants#BREADCRUMB_ID"}},"properties":{"type":{"index":0,"kind":"path","displayName":"Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.spring.ws.type.EndpointMappingType","enum":["ROOT_QNAME","ACTION","TO","SOAP_ACTION","XPATHRESULT","URI","URI_PATH","BEANNAME"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Endpoint mapping type if endpoint mapping is used. rootqname - Offers the option to map web service requests based on the qualified name of the root element contained in the message. soapaction - Used to map web service requests based on the SOAP action specified in the header of the message. uri - In order to map web service requests that target a specific URI. xpathresult - Used to map web service requests based on the evaluation of an XPath expression against the incoming message. The result of the evaluation should match the XPath result specified in the endpoint URI. beanname - Allows you to reference an org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher object in order to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping, SoapActionEndpointMapping, etc"},"lookupKey":{"index":1,"kind":"path","displayName":"Lookup Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Endpoint mapping key if endpoint mapping is used"},"webServiceEndpointUri":{"index":2,"kind":"path","displayName":"Web Service Endpoint Uri","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"The default Web Service endpoint uri to use for the producer."},"messageFilter":{"index":3,"kind":"parameter","displayName":"Message Filter","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.spring.ws.filter.MessageFilter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Option to provide a custom MessageFilter. For example when you want to process your headers or attachments by your own."},"messageIdStrategy":{"index":4,"kind":"parameter","displayName":"Message Id Strategy","group":"common","label":"common","required":false,"type":"object","javaType":"org.springframework.ws.soap.addressing.messageid.MessageIdStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Option to provide a custom MessageIdStrategy to control generation of WS-Addressing unique message ids."},"endpointDispatcher":{"index":5,"kind":"parameter","displayName":"Endpoint Dispatcher","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Spring org.springframework.ws.server.endpoint.MessageEndpoint for dispatching messages received by Spring-WS to a Camel endpoint, to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping, SoapActionEndpointMapping, etc."},"endpointMapping":{"index":6,"kind":"parameter","displayName":"Endpoint Mapping","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.spring.ws.bean.CamelSpringWSEndpointMapping","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Reference to an instance of org.apache.camel.component.spring.ws.bean.CamelEndpointMapping in the Registry/ApplicationContext. Only one bean is required in the registry to serve all Camel/Spring-WS endpoints. This bean is auto-discovered by the MessageDispatcher and used to map requests to Camel endpoints based on characteristics specified on the endpoint (like root QName, SOAP action, etc)"},"expression":{"index":7,"kind":"parameter","displayName":"Expression","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"The XPath expression to use when option type=xpathresult. Then this option is required to be configured."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"allowResponseAttachmentOverride":{"index":11,"kind":"parameter","displayName":"Allow Response Attachment Override","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Option to override soap response attachments in in/out exchange with attachments from the actual service layer. If the invoked service appends or rewrites the soap attachments this option when set to true, allows the modified soap attachments to be overwritten in in/out message attachments"},"allowResponseHeaderOverride":{"index":12,"kind":"parameter","displayName":"Allow Response Header Override","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Option to override soap response header in in/out exchange with header info from the actual service layer. If the invoked service appends or rewrites the soap header this option when set to true, allows the modified soap header to be overwritten in in/out message headers"},"faultAction":{"index":13,"kind":"parameter","displayName":"Fault Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Signifies the value for the faultAction response WS-Addressing Fault Action header that is provided by the method. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details."},"faultTo":{"index":14,"kind":"parameter","displayName":"Fault To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details."},"messageFactory":{"index":15,"kind":"parameter","displayName":"Message Factory","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.springframework.ws.WebServiceMessageFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Option to provide a custom WebServiceMessageFactory."},"messageSender":{"index":16,"kind":"parameter","displayName":"Message Sender","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.springframework.ws.transport.WebServiceMessageSender","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Option to provide a custom WebServiceMessageSender. For example to perform authentication or use alternative transports"},"outputAction":{"index":17,"kind":"parameter","displayName":"Output Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Signifies the value for the response WS-Addressing Action header that is provided by the method. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details."},"replyTo":{"index":18,"kind":"parameter","displayName":"Reply To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details."},"soapAction":{"index":19,"kind":"parameter","displayName":"Soap Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"SOAP action to include inside a SOAP request when accessing remote web services"},"timeout":{"index":20,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Sets the socket read timeout (in milliseconds) while invoking a webservice using the producer, see URLConnection.setReadTimeout() and CommonsHttpMessageSender.setReadTimeout(). This option works when using the built-in message sender implementations: CommonsHttpMessageSender and HttpUrlConnectionMessageSender. One of these implementations will be used by default for HTTP based services unless you customize the Spring WS configuration options supplied to the component. If you are using a non-standard sender, it is assumed that you will handle your own timeout configuration. The built-in message sender HttpComponentsMessageSender is considered instead of CommonsHttpMessageSender which has been deprecated, see HttpComponentsMessageSender.setReadTimeout()."},"webServiceTemplate":{"index":21,"kind":"parameter","displayName":"Web Service Template","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.springframework.ws.client.core.WebServiceTemplate","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Option to provide a custom WebServiceTemplate. This allows for full control over client-side web services handling; like adding a custom interceptor or specifying a fault resolver, message sender or message factory."},"wsAddressingAction":{"index":22,"kind":"parameter","displayName":"Ws Addressing Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"WS-Addressing 1.0 action header to include when accessing web services. The To header is set to the address of the web service as specified in the endpoint URI (default Spring-WS behavior)."},"lazyStartProducer":{"index":23,"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."},"sslContextParameters":{"index":24,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}}} +{"component":{"kind":"component","name":"spring-ws","title":"Spring WebService","description":"Access external web services as a client or expose your own web services.","deprecated":false,"firstVersion":"2.6.0","label":"webservice","javaType":"org.apache.camel.component.spring.ws.SpringWebserviceComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-spring-ws","version":"4.8.2","scheme":"spring-ws","extendsScheme":"","syntax":"spring-ws:type:lookupKey:webServiceEndpointUri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelSpringWebserviceEndpointUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The endpoint URI","constantName":"org.apache.camel.component.spring.ws.SpringWebserviceConstants#SPRING_WS_ENDPOINT_URI"},"CamelSpringWebserviceSoapAction":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"SOAP action to include inside a SOAP request when accessing remote web services","constantName":"org.apache.camel.component.spring.ws.SpringWebserviceConstants#SPRING_WS_SOAP_ACTION"},"CamelSpringWebserviceSoapHeader":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"javax.xml.transform.Source","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The soap header source","constantName":"org.apache.camel.component.spring.ws.SpringWebserviceConstants#SPRING_WS_SOAP_HEADER"},"CamelSpringWebserviceAddressingAction":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"WS-Addressing 1.0 action header to include when accessing web services. The To header is set to the address of the web service as specified in the endpoint URI (default Spring-WS behavior).","constantName":"org.apache.camel.component.spring.ws.SpringWebserviceConstants#SPRING_WS_ADDRESSING_ACTION"},"CamelSpringWebserviceAddressingFaultTo":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details.","constantName":"org.apache.camel.component.spring.ws.SpringWebserviceConstants#SPRING_WS_ADDRESSING_PRODUCER_FAULT_TO"},"CamelSpringWebserviceAddressingReplyTo":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details.","constantName":"org.apache.camel.component.spring.ws.SpringWebserviceConstants#SPRING_WS_ADDRESSING_PRODUCER_REPLY_TO"},"breadcrumbId":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The breadcrumb id.","constantName":"org.apache.camel.component.spring.ws.SpringWebserviceConstants#BREADCRUMB_ID"}},"properties":{"type":{"index":0,"kind":"path","displayName":"Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.spring.ws.type.EndpointMappingType","enum":["ROOT_QNAME","ACTION","TO","SOAP_ACTION","XPATHRESULT","URI","URI_PATH","BEANNAME"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Endpoint mapping type if endpoint mapping is used. rootqname - Offers the option to map web service requests based on the qualified name of the root element contained in the message. soapaction - Used to map web service requests based on the SOAP action specified in the header of the message. uri - In order to map web service requests that target a specific URI. xpathresult - Used to map web service requests based on the evaluation of an XPath expression against the incoming message. The result of the evaluation should match the XPath result specified in the endpoint URI. beanname - Allows you to reference an org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher object in order to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping, SoapActionEndpointMapping, etc"},"lookupKey":{"index":1,"kind":"path","displayName":"Lookup Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Endpoint mapping key if endpoint mapping is used"},"webServiceEndpointUri":{"index":2,"kind":"path","displayName":"Web Service Endpoint Uri","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"The default Web Service endpoint uri to use for the producer."},"messageFilter":{"index":3,"kind":"parameter","displayName":"Message Filter","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.spring.ws.filter.MessageFilter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Option to provide a custom MessageFilter. For example when you want to process your headers or attachments by your own."},"messageIdStrategy":{"index":4,"kind":"parameter","displayName":"Message Id Strategy","group":"common","label":"common","required":false,"type":"object","javaType":"org.springframework.ws.soap.addressing.messageid.MessageIdStrategy","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Option to provide a custom MessageIdStrategy to control generation of WS-Addressing unique message ids."},"endpointDispatcher":{"index":5,"kind":"parameter","displayName":"Endpoint Dispatcher","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Spring org.springframework.ws.server.endpoint.MessageEndpoint for dispatching messages received by Spring-WS to a Camel endpoint, to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping, SoapActionEndpointMapping, etc."},"endpointMapping":{"index":6,"kind":"parameter","displayName":"Endpoint Mapping","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.spring.ws.bean.CamelSpringWSEndpointMapping","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Reference to an instance of org.apache.camel.component.spring.ws.bean.CamelEndpointMapping in the Registry/ApplicationContext. Only one bean is required in the registry to serve all Camel/Spring-WS endpoints. This bean is auto-discovered by the MessageDispatcher and used to map requests to Camel endpoints based on characteristics specified on the endpoint (like root QName, SOAP action, etc)"},"expression":{"index":7,"kind":"parameter","displayName":"Expression","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"The XPath expression to use when option type=xpathresult. Then this option is required to be configured."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"allowResponseAttachmentOverride":{"index":11,"kind":"parameter","displayName":"Allow Response Attachment Override","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Option to override soap response attachments in in/out exchange with attachments from the actual service layer. If the invoked service appends or rewrites the soap attachments this option when set to true, allows the modified soap attachments to be overwritten in in/out message attachments"},"allowResponseHeaderOverride":{"index":12,"kind":"parameter","displayName":"Allow Response Header Override","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Option to override soap response header in in/out exchange with header info from the actual service layer. If the invoked service appends or rewrites the soap header this option when set to true, allows the modified soap header to be overwritten in in/out message headers"},"faultAction":{"index":13,"kind":"parameter","displayName":"Fault Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Signifies the value for the faultAction response WS-Addressing Fault Action header that is provided by the method. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details."},"faultTo":{"index":14,"kind":"parameter","displayName":"Fault To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details."},"messageFactory":{"index":15,"kind":"parameter","displayName":"Message Factory","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.springframework.ws.WebServiceMessageFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Option to provide a custom WebServiceMessageFactory."},"messageSender":{"index":16,"kind":"parameter","displayName":"Message Sender","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.springframework.ws.transport.WebServiceMessageSender","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Option to provide a custom WebServiceMessageSender. For example to perform authentication or use alternative transports"},"outputAction":{"index":17,"kind":"parameter","displayName":"Output Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Signifies the value for the response WS-Addressing Action header that is provided by the method. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details."},"replyTo":{"index":18,"kind":"parameter","displayName":"Reply To","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details."},"soapAction":{"index":19,"kind":"parameter","displayName":"Soap Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"SOAP action to include inside a SOAP request when accessing remote web services"},"timeout":{"index":20,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Sets the socket read timeout (in milliseconds) while invoking a webservice using the producer, see URLConnection.setReadTimeout() and CommonsHttpMessageSender.setReadTimeout(). This option works when using the built-in message sender implementations: CommonsHttpMessageSender and HttpUrlConnectionMessageSender. One of these implementations will be used by default for HTTP based services unless you customize the Spring WS configuration options supplied to the component. If you are using a non-standard sender, it is assumed that you will handle your own timeout configuration. The built-in message sender HttpComponentsMessageSender is considered instead of CommonsHttpMessageSender which has been deprecated, see HttpComponentsMessageSender.setReadTimeout()."},"webServiceTemplate":{"index":21,"kind":"parameter","displayName":"Web Service Template","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.springframework.ws.client.core.WebServiceTemplate","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"Option to provide a custom WebServiceTemplate. This allows for full control over client-side web services handling; like adding a custom interceptor or specifying a fault resolver, message sender or message factory."},"wsAddressingAction":{"index":22,"kind":"parameter","displayName":"Ws Addressing Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"WS-Addressing 1.0 action header to include when accessing web services. The To header is set to the address of the web service as specified in the endpoint URI (default Spring-WS behavior)."},"lazyStartProducer":{"index":23,"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."},"sslContextParameters":{"index":24,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.spring.ws.SpringWebserviceConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}}} , -{"component":{"kind":"component","name":"sql","title":"SQL","description":"Perform SQL queries using Spring JDBC.","deprecated":false,"firstVersion":"1.4.0","label":"database","javaType":"org.apache.camel.component.sql.SqlComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-sql","version":"4.8.1","scheme":"sql","extendsScheme":"","syntax":"sql:query","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelSqlQuery":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Query to execute. This query takes precedence over the query specified in the endpoint URI. Note that query parameters in the header _are_ represented by a instead of a pass:# symbol","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_QUERY"},"CamelSqlUpdateCount":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of rows updated for update operations, returned as an Integer object. This header is not provided when using outputType=StreamList.","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_UPDATE_COUNT"},"CamelSqlRowCount":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of rows returned for select operations, returned as an Integer object. This header is not provided when using outputType=StreamList.","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_ROW_COUNT"},"CamelSqlRetrieveGeneratedKeys":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Set its value to true to retrieve generated keys","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_RETRIEVE_GENERATED_KEYS"},"CamelSqlGeneratedColumns":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String[] or int[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set it to specify the expected generated columns","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_GENERATED_COLUMNS"},"CamelSqlGeneratedKeysRowCount":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of rows in the header that contains generated keys.","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_GENERATED_KEYS_ROW_COUNT"},"CamelSqlGeneratedKeyRows":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Rows that contains the generated keys (a list of maps of keys).","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_GENERATED_KEYS_DATA"},"CamelSqlParameters":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Iterator","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SQL parameters when using the option useMessageBodyForSql","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_PARAMETERS"}},"properties":{"query":{"index":0,"kind":"path","displayName":"Query","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"largeInput":true,"inputLanguage":"sql","description":"Sets the SQL query to perform. You can externalize the query by using file: or classpath: as prefix and specify the location of the file."},"allowNamedParameters":{"index":1,"kind":"parameter","displayName":"Allow Named Parameters","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to allow using named parameters in the queries."},"dataSource":{"index":2,"kind":"parameter","displayName":"Data Source","group":"common","label":"","required":false,"type":"object","javaType":"javax.sql.DataSource","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"description":"Sets the DataSource to use to communicate with the database at endpoint level."},"outputClass":{"index":3,"kind":"parameter","displayName":"Output Class","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specify the full package and class name to use as conversion when outputType=SelectOne."},"outputHeader":{"index":4,"kind":"parameter","displayName":"Output Header","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Store the query result in a header instead of the message body. By default, outputHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If outputHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved."},"outputType":{"index":5,"kind":"parameter","displayName":"Output Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.sql.SqlOutputType","enum":["SelectOne","SelectList","StreamList"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SelectList","description":"Make the output of consumer or producer to SelectList as List of Map, or SelectOne as single Java object in the following way: a) If the query has only single column, then that JDBC Column object is returned. (such as SELECT COUNT( ) FROM PROJECT will return a Long object. b) If the query has more than one column, then it will return a Map of that result. c) If the outputClass is set, then it will convert the query result into an Java bean object by calling all the setters that match the column names. It will assume your class has a default constructor to create instance with. d) If the query resulted in more than one rows, it throws an non-unique result exception. StreamList streams the result of the query using an Iterator. This can be used with the Splitter EIP in streaming mode to process the ResultSet in streaming fashion."},"separator":{"index":6,"kind":"parameter","displayName":"Separator","group":"common","label":"","required":false,"type":"string","javaType":"char","deprecated":false,"autowired":false,"secret":false,"defaultValue":",","description":"The separator to use when parameter values is taken from message body (if the body is a String type), to be inserted at # placeholders. Notice if you use named parameters, then a Map type is used instead. The default value is comma"},"breakBatchOnConsumeFail":{"index":7,"kind":"parameter","displayName":"Break Batch On Consume Fail","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to break batch if onConsume failed."},"expectedUpdateCount":{"index":8,"kind":"parameter","displayName":"Expected Update Count","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Sets an expected update count to validate when using onConsume."},"maxMessagesPerPoll":{"index":9,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Sets the maximum number of messages to poll"},"onConsume":{"index":10,"kind":"parameter","displayName":"On Consume","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"After processing each row then this query can be executed, if the Exchange was processed successfully, for example to mark the row as processed. The query can have parameter."},"onConsumeBatchComplete":{"index":11,"kind":"parameter","displayName":"On Consume Batch Complete","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"After processing the entire batch, this query can be executed to bulk update rows etc. The query cannot have parameters."},"onConsumeFailed":{"index":12,"kind":"parameter","displayName":"On Consume Failed","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"After processing each row then this query can be executed, if the Exchange failed, for example to mark the row as failed. The query can have parameter."},"routeEmptyResultSet":{"index":13,"kind":"parameter","displayName":"Route Empty Result Set","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether empty resultset should be allowed to be sent to the next hop. Defaults to false. So the empty resultset will be filtered out."},"sendEmptyMessageWhenIdle":{"index":14,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"transacted":{"index":15,"kind":"parameter","displayName":"Transacted","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enables or disables transaction. If enabled then if processing an exchange failed then the consumer breaks out processing any further exchanges to cause a rollback eager."},"useIterator":{"index":16,"kind":"parameter","displayName":"Use Iterator","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true."},"bridgeErrorHandler":{"index":17,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":18,"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":{"index":19,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":20,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"processingStrategy":{"index":21,"kind":"parameter","displayName":"Processing Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sql.SqlProcessingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch."},"batch":{"index":22,"kind":"parameter","displayName":"Batch","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enables or disables batch mode"},"noop":{"index":23,"kind":"parameter","displayName":"Noop","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set, will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing"},"useMessageBodyForSql":{"index":24,"kind":"parameter","displayName":"Use Message Body For Sql","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used. Note that query parameters in the message body are represented by a question mark instead of a # symbol."},"lazyStartProducer":{"index":25,"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."},"alwaysPopulateStatement":{"index":26,"kind":"parameter","displayName":"Always Populate Statement","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled then the populateStatement method from org.apache.camel.component.sql.SqlPrepareStatementStrategy is always invoked, also if there is no expected parameters to be prepared. When this is false then the populateStatement is only invoked if there is 1 or more expected parameters to be set; for example this avoids reading the message body/headers for SQL queries with no parameters."},"parametersCount":{"index":27,"kind":"parameter","displayName":"Parameters Count","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"If set greater than zero, then Camel will use this count value of parameters to replace instead of querying via JDBC metadata API. This is useful if the JDBC vendor could not return correct parameters count, then user may override instead."},"placeholder":{"index":28,"kind":"parameter","displayName":"Placeholder","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"#","description":"Specifies a character that will be replaced to in SQL query. Notice, that it is simple String.replaceAll() operation and no SQL parsing is involved (quoted strings will also change)."},"prepareStatementStrategy":{"index":29,"kind":"parameter","displayName":"Prepare Statement Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sql.SqlPrepareStatementStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement."},"rowMapperFactory":{"index":30,"kind":"parameter","displayName":"Row Mapper Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sql.RowMapperFactory","deprecated":false,"autowired":false,"secret":false,"description":"Factory for creating RowMapper"},"templateOptions":{"index":31,"kind":"parameter","displayName":"Template Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"template.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Configures the Spring JdbcTemplate with the key/values from the Map"},"usePlaceholder":{"index":32,"kind":"parameter","displayName":"Use Placeholder","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries."},"backoffErrorThreshold":{"index":33,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":34,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":35,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":36,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":37,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":38,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":39,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":40,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":41,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":42,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":43,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":44,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":45,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":46,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} +{"component":{"kind":"component","name":"sql","title":"SQL","description":"Perform SQL queries using Spring JDBC.","deprecated":false,"firstVersion":"1.4.0","label":"database","javaType":"org.apache.camel.component.sql.SqlComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-sql","version":"4.8.2","scheme":"sql","extendsScheme":"","syntax":"sql:query","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelSqlQuery":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Query to execute. This query takes precedence over the query specified in the endpoint URI. Note that query parameters in the header _are_ represented by a instead of a pass:# symbol","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_QUERY"},"CamelSqlUpdateCount":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of rows updated for update operations, returned as an Integer object. This header is not provided when using outputType=StreamList.","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_UPDATE_COUNT"},"CamelSqlRowCount":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of rows returned for select operations, returned as an Integer object. This header is not provided when using outputType=StreamList.","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_ROW_COUNT"},"CamelSqlRetrieveGeneratedKeys":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Set its value to true to retrieve generated keys","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_RETRIEVE_GENERATED_KEYS"},"CamelSqlGeneratedColumns":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String[] or int[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Set it to specify the expected generated columns","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_GENERATED_COLUMNS"},"CamelSqlGeneratedKeysRowCount":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of rows in the header that contains generated keys.","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_GENERATED_KEYS_ROW_COUNT"},"CamelSqlGeneratedKeyRows":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Rows that contains the generated keys (a list of maps of keys).","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_GENERATED_KEYS_DATA"},"CamelSqlParameters":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Iterator","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SQL parameters when using the option useMessageBodyForSql","constantName":"org.apache.camel.component.sql.SqlConstants#SQL_PARAMETERS"}},"properties":{"query":{"index":0,"kind":"path","displayName":"Query","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"largeInput":true,"inputLanguage":"sql","description":"Sets the SQL query to perform. You can externalize the query by using file: or classpath: as prefix and specify the location of the file."},"allowNamedParameters":{"index":1,"kind":"parameter","displayName":"Allow Named Parameters","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to allow using named parameters in the queries."},"dataSource":{"index":2,"kind":"parameter","displayName":"Data Source","group":"common","label":"","required":false,"type":"object","javaType":"javax.sql.DataSource","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"description":"Sets the DataSource to use to communicate with the database at endpoint level."},"outputClass":{"index":3,"kind":"parameter","displayName":"Output Class","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specify the full package and class name to use as conversion when outputType=SelectOne."},"outputHeader":{"index":4,"kind":"parameter","displayName":"Output Header","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Store the query result in a header instead of the message body. By default, outputHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If outputHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved."},"outputType":{"index":5,"kind":"parameter","displayName":"Output Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.sql.SqlOutputType","enum":["SelectOne","SelectList","StreamList"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SelectList","description":"Make the output of consumer or producer to SelectList as List of Map, or SelectOne as single Java object in the following way: a) If the query has only single column, then that JDBC Column object is returned. (such as SELECT COUNT( ) FROM PROJECT will return a Long object. b) If the query has more than one column, then it will return a Map of that result. c) If the outputClass is set, then it will convert the query result into an Java bean object by calling all the setters that match the column names. It will assume your class has a default constructor to create instance with. d) If the query resulted in more than one rows, it throws an non-unique result exception. StreamList streams the result of the query using an Iterator. This can be used with the Splitter EIP in streaming mode to process the ResultSet in streaming fashion."},"separator":{"index":6,"kind":"parameter","displayName":"Separator","group":"common","label":"","required":false,"type":"string","javaType":"char","deprecated":false,"autowired":false,"secret":false,"defaultValue":",","description":"The separator to use when parameter values is taken from message body (if the body is a String type), to be inserted at # placeholders. Notice if you use named parameters, then a Map type is used instead. The default value is comma"},"breakBatchOnConsumeFail":{"index":7,"kind":"parameter","displayName":"Break Batch On Consume Fail","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to break batch if onConsume failed."},"expectedUpdateCount":{"index":8,"kind":"parameter","displayName":"Expected Update Count","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"description":"Sets an expected update count to validate when using onConsume."},"maxMessagesPerPoll":{"index":9,"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Sets the maximum number of messages to poll"},"onConsume":{"index":10,"kind":"parameter","displayName":"On Consume","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"After processing each row then this query can be executed, if the Exchange was processed successfully, for example to mark the row as processed. The query can have parameter."},"onConsumeBatchComplete":{"index":11,"kind":"parameter","displayName":"On Consume Batch Complete","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"After processing the entire batch, this query can be executed to bulk update rows etc. The query cannot have parameters."},"onConsumeFailed":{"index":12,"kind":"parameter","displayName":"On Consume Failed","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"After processing each row then this query can be executed, if the Exchange failed, for example to mark the row as failed. The query can have parameter."},"routeEmptyResultSet":{"index":13,"kind":"parameter","displayName":"Route Empty Result Set","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether empty resultset should be allowed to be sent to the next hop. Defaults to false. So the empty resultset will be filtered out."},"sendEmptyMessageWhenIdle":{"index":14,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"transacted":{"index":15,"kind":"parameter","displayName":"Transacted","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enables or disables transaction. If enabled then if processing an exchange failed then the consumer breaks out processing any further exchanges to cause a rollback eager."},"useIterator":{"index":16,"kind":"parameter","displayName":"Use Iterator","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true."},"bridgeErrorHandler":{"index":17,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":18,"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":{"index":19,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":20,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"processingStrategy":{"index":21,"kind":"parameter","displayName":"Processing Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sql.SqlProcessingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch."},"batch":{"index":22,"kind":"parameter","displayName":"Batch","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enables or disables batch mode"},"noop":{"index":23,"kind":"parameter","displayName":"Noop","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set, will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing"},"useMessageBodyForSql":{"index":24,"kind":"parameter","displayName":"Use Message Body For Sql","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used. Note that query parameters in the message body are represented by a question mark instead of a # symbol."},"lazyStartProducer":{"index":25,"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."},"alwaysPopulateStatement":{"index":26,"kind":"parameter","displayName":"Always Populate Statement","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If enabled then the populateStatement method from org.apache.camel.component.sql.SqlPrepareStatementStrategy is always invoked, also if there is no expected parameters to be prepared. When this is false then the populateStatement is only invoked if there is 1 or more expected parameters to be set; for example this avoids reading the message body/headers for SQL queries with no parameters."},"parametersCount":{"index":27,"kind":"parameter","displayName":"Parameters Count","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"If set greater than zero, then Camel will use this count value of parameters to replace instead of querying via JDBC metadata API. This is useful if the JDBC vendor could not return correct parameters count, then user may override instead."},"placeholder":{"index":28,"kind":"parameter","displayName":"Placeholder","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"#","description":"Specifies a character that will be replaced to in SQL query. Notice, that it is simple String.replaceAll() operation and no SQL parsing is involved (quoted strings will also change)."},"prepareStatementStrategy":{"index":29,"kind":"parameter","displayName":"Prepare Statement Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sql.SqlPrepareStatementStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement."},"rowMapperFactory":{"index":30,"kind":"parameter","displayName":"Row Mapper Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.sql.RowMapperFactory","deprecated":false,"autowired":false,"secret":false,"description":"Factory for creating RowMapper"},"templateOptions":{"index":31,"kind":"parameter","displayName":"Template Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"template.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Configures the Spring JdbcTemplate with the key/values from the Map"},"usePlaceholder":{"index":32,"kind":"parameter","displayName":"Use Placeholder","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries."},"backoffErrorThreshold":{"index":33,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":34,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":35,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":36,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":37,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":38,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":39,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":40,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":41,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":42,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":43,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":44,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":45,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":46,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} , -{"component":{"kind":"component","name":"sql-stored","title":"SQL Stored Procedure","description":"Perform SQL queries as a JDBC Stored Procedures using Spring JDBC.","deprecated":false,"firstVersion":"2.17.0","label":"database","javaType":"org.apache.camel.component.sql.stored.SqlStoredComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-sql","version":"4.8.1","scheme":"sql-stored","extendsScheme":"","syntax":"sql-stored:template","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelSqlStoredTemplate":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template","constantName":"org.apache.camel.component.sql.stored.SqlStoredConstants#SQL_STORED_TEMPLATE"},"CamelSqlStoredParameters":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Iterator","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parameters","constantName":"org.apache.camel.component.sql.stored.SqlStoredConstants#SQL_STORED_PARAMETERS"},"CamelSqlStoredUpdateCount":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The update count","constantName":"org.apache.camel.component.sql.stored.SqlStoredConstants#SQL_STORED_UPDATE_COUNT"}},"properties":{"template":{"index":0,"kind":"path","displayName":"Template","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"largeInput":true,"inputLanguage":"sql","description":"Sets the stored procedure template to perform. You can externalize the template by using file: or classpath: as prefix and specify the location of the file."},"batch":{"index":1,"kind":"parameter","displayName":"Batch","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enables or disables batch mode"},"dataSource":{"index":2,"kind":"parameter","displayName":"Data Source","group":"producer","label":"","required":false,"type":"object","javaType":"javax.sql.DataSource","deprecated":false,"autowired":false,"secret":false,"description":"Sets the DataSource to use to communicate with the database."},"function":{"index":3,"kind":"parameter","displayName":"Function","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether this call is for a function."},"noop":{"index":4,"kind":"parameter","displayName":"Noop","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set, will ignore the results of the stored procedure template and use the existing IN message as the OUT message for the continuation of processing"},"outputHeader":{"index":5,"kind":"parameter","displayName":"Output Header","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Store the template result in a header instead of the message body. By default, outputHeader == null and the template result is stored in the message body, any existing content in the message body is discarded. If outputHeader is set, the value is used as the name of the header to store the template result and the original message body is preserved."},"useMessageBodyForTemplate":{"index":6,"kind":"parameter","displayName":"Use Message Body For Template","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to use the message body as the stored procedure template and then headers for parameters. If this option is enabled then the template in the uri is not used."},"lazyStartProducer":{"index":7,"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."},"templateOptions":{"index":8,"kind":"parameter","displayName":"Template Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"template.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Configures the Spring JdbcTemplate with the key/values from the Map"}}} +{"component":{"kind":"component","name":"sql-stored","title":"SQL Stored Procedure","description":"Perform SQL queries as a JDBC Stored Procedures using Spring JDBC.","deprecated":false,"firstVersion":"2.17.0","label":"database","javaType":"org.apache.camel.component.sql.stored.SqlStoredComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-sql","version":"4.8.2","scheme":"sql-stored","extendsScheme":"","syntax":"sql-stored:template","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelSqlStoredTemplate":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template","constantName":"org.apache.camel.component.sql.stored.SqlStoredConstants#SQL_STORED_TEMPLATE"},"CamelSqlStoredParameters":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Iterator","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parameters","constantName":"org.apache.camel.component.sql.stored.SqlStoredConstants#SQL_STORED_PARAMETERS"},"CamelSqlStoredUpdateCount":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The update count","constantName":"org.apache.camel.component.sql.stored.SqlStoredConstants#SQL_STORED_UPDATE_COUNT"}},"properties":{"template":{"index":0,"kind":"path","displayName":"Template","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"largeInput":true,"inputLanguage":"sql","description":"Sets the stored procedure template to perform. You can externalize the template by using file: or classpath: as prefix and specify the location of the file."},"batch":{"index":1,"kind":"parameter","displayName":"Batch","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enables or disables batch mode"},"dataSource":{"index":2,"kind":"parameter","displayName":"Data Source","group":"producer","label":"","required":false,"type":"object","javaType":"javax.sql.DataSource","deprecated":false,"autowired":false,"secret":false,"description":"Sets the DataSource to use to communicate with the database."},"function":{"index":3,"kind":"parameter","displayName":"Function","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether this call is for a function."},"noop":{"index":4,"kind":"parameter","displayName":"Noop","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set, will ignore the results of the stored procedure template and use the existing IN message as the OUT message for the continuation of processing"},"outputHeader":{"index":5,"kind":"parameter","displayName":"Output Header","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Store the template result in a header instead of the message body. By default, outputHeader == null and the template result is stored in the message body, any existing content in the message body is discarded. If outputHeader is set, the value is used as the name of the header to store the template result and the original message body is preserved."},"useMessageBodyForTemplate":{"index":6,"kind":"parameter","displayName":"Use Message Body For Template","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to use the message body as the stored procedure template and then headers for parameters. If this option is enabled then the template in the uri is not used."},"lazyStartProducer":{"index":7,"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."},"templateOptions":{"index":8,"kind":"parameter","displayName":"Template Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","prefix":"template.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Configures the Spring JdbcTemplate with the key/values from the Map"}}} , -{"component":{"kind":"component","name":"ssh","title":"SSH","description":"Execute commands on remote hosts using SSH.","deprecated":false,"firstVersion":"2.10.0","label":"file","javaType":"org.apache.camel.component.ssh.SshComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ssh","version":"4.8.1","scheme":"ssh","extendsScheme":"","syntax":"ssh:host:port","alternativeSyntax":"ssh:username:password@host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelSshUsername":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user name","constantName":"org.apache.camel.component.ssh.SshConstants#USERNAME_HEADER"},"CamelSshPassword":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password","constantName":"org.apache.camel.component.ssh.SshConstants#PASSWORD_HEADER"},"CamelSshStderr":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"InputStream","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of this header is a InputStream with the standard error stream of the executable.","constantName":"org.apache.camel.component.ssh.SshConstants#STDERR"},"CamelSshExitValue":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of this header is the exit value that is returned, after the execution. By convention a non-zero status exit value indicates abnormal termination. Note that the exit value is OS dependent.","constantName":"org.apache.camel.component.ssh.SshConstants#EXIT_VALUE"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the hostname of the remote SSH server."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":22,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the port number for the remote SSH server."},"failOnUnknownHost":{"index":2,"kind":"parameter","displayName":"Fail On Unknown Host","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Specifies whether a connection to an unknown host should fail or not. This value is only checked when the property knownHosts is set."},"knownHostsResource":{"index":3,"kind":"parameter","displayName":"Known Hosts Resource","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the resource path for a known_hosts file"},"timeout":{"index":4,"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds."},"pollCommand":{"index":5,"kind":"parameter","displayName":"Poll Command","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer, i.e. from(ssh://...) You may need to end your command with a newline, and that must be URL encoded %0A"},"sendEmptyMessageWhenIdle":{"index":6,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":10,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":11,"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."},"channelType":{"index":12,"kind":"parameter","displayName":"Channel Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"exec","configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the channel type to pass to the Channel as part of command execution. Defaults to exec."},"clientBuilder":{"index":13,"kind":"parameter","displayName":"Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.sshd.client.ClientBuilder","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Instance of ClientBuilder used by the producer or consumer to create a new SshClient"},"compressions":{"index":14,"kind":"parameter","displayName":"Compressions","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Whether to use compression, and if so which."},"shellPrompt":{"index":15,"kind":"parameter","displayName":"Shell Prompt","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the shellPrompt to be dropped when response is read after command execution"},"sleepForShellPrompt":{"index":16,"kind":"parameter","displayName":"Sleep For Shell Prompt","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the sleep period in milliseconds to wait reading response from shell prompt. Defaults to 100 milliseconds."},"backoffErrorThreshold":{"index":17,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":18,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":19,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":20,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":21,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":22,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":23,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":24,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":25,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":26,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":27,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":28,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":29,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":30,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"certResource":{"index":31,"kind":"parameter","displayName":"Cert Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate, and depends on keyType setting."},"certResourcePassword":{"index":32,"kind":"parameter","displayName":"Cert Resource Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the password to use in loading certResource, if certResource is an encrypted key."},"ciphers":{"index":33,"kind":"parameter","displayName":"Ciphers","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Comma-separated list of allowed/supported ciphers in their order of preference."},"kex":{"index":34,"kind":"parameter","displayName":"Kex","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Comma-separated list of allowed/supported key exchange algorithms in their order of preference."},"keyPairProvider":{"index":35,"kind":"parameter","displayName":"Key Pair Provider","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.sshd.common.keyprovider.KeyPairProvider","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server."},"keyType":{"index":36,"kind":"parameter","displayName":"Key Type","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. From Camel 3.0.0 / 2.25.0, by default Camel will select the first available KeyPair that is loaded. Prior to this, a KeyType of 'ssh-rsa' was enforced by default."},"macs":{"index":37,"kind":"parameter","displayName":"Macs","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Comma-separated list of allowed/supported message authentication code algorithms in their order of preference. The MAC algorithm is used for data integrity protection."},"password":{"index":38,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null."},"signatures":{"index":39,"kind":"parameter","displayName":"Signatures","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Comma-separated list of allowed/supported signature algorithms in their order of preference."},"username":{"index":40,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the username to use in logging into the remote SSH server."}}} +{"component":{"kind":"component","name":"ssh","title":"SSH","description":"Execute commands on remote hosts using SSH.","deprecated":false,"firstVersion":"2.10.0","label":"file","javaType":"org.apache.camel.component.ssh.SshComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ssh","version":"4.8.2","scheme":"ssh","extendsScheme":"","syntax":"ssh:host:port","alternativeSyntax":"ssh:username:password@host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelSshUsername":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user name","constantName":"org.apache.camel.component.ssh.SshConstants#USERNAME_HEADER"},"CamelSshPassword":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password","constantName":"org.apache.camel.component.ssh.SshConstants#PASSWORD_HEADER"},"CamelSshStderr":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"InputStream","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of this header is a InputStream with the standard error stream of the executable.","constantName":"org.apache.camel.component.ssh.SshConstants#STDERR"},"CamelSshExitValue":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of this header is the exit value that is returned, after the execution. By convention a non-zero status exit value indicates abnormal termination. Note that the exit value is OS dependent.","constantName":"org.apache.camel.component.ssh.SshConstants#EXIT_VALUE"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the hostname of the remote SSH server."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":22,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the port number for the remote SSH server."},"failOnUnknownHost":{"index":2,"kind":"parameter","displayName":"Fail On Unknown Host","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Specifies whether a connection to an unknown host should fail or not. This value is only checked when the property knownHosts is set."},"knownHostsResource":{"index":3,"kind":"parameter","displayName":"Known Hosts Resource","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the resource path for a known_hosts file"},"timeout":{"index":4,"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds."},"pollCommand":{"index":5,"kind":"parameter","displayName":"Poll Command","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer, i.e. from(ssh://...) You may need to end your command with a newline, and that must be URL encoded %0A"},"sendEmptyMessageWhenIdle":{"index":6,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":10,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":11,"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."},"channelType":{"index":12,"kind":"parameter","displayName":"Channel Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"exec","configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the channel type to pass to the Channel as part of command execution. Defaults to exec."},"clientBuilder":{"index":13,"kind":"parameter","displayName":"Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.sshd.client.ClientBuilder","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Instance of ClientBuilder used by the producer or consumer to create a new SshClient"},"compressions":{"index":14,"kind":"parameter","displayName":"Compressions","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Whether to use compression, and if so which."},"shellPrompt":{"index":15,"kind":"parameter","displayName":"Shell Prompt","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the shellPrompt to be dropped when response is read after command execution"},"sleepForShellPrompt":{"index":16,"kind":"parameter","displayName":"Sleep For Shell Prompt","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the sleep period in milliseconds to wait reading response from shell prompt. Defaults to 100 milliseconds."},"backoffErrorThreshold":{"index":17,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":18,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":19,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":20,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":21,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":22,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":23,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":24,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":25,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":26,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":27,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":28,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":29,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":30,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"certResource":{"index":31,"kind":"parameter","displayName":"Cert Resource","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate, and depends on keyType setting."},"certResourcePassword":{"index":32,"kind":"parameter","displayName":"Cert Resource Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the password to use in loading certResource, if certResource is an encrypted key."},"ciphers":{"index":33,"kind":"parameter","displayName":"Ciphers","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Comma-separated list of allowed/supported ciphers in their order of preference."},"kex":{"index":34,"kind":"parameter","displayName":"Kex","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Comma-separated list of allowed/supported key exchange algorithms in their order of preference."},"keyPairProvider":{"index":35,"kind":"parameter","displayName":"Key Pair Provider","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.sshd.common.keyprovider.KeyPairProvider","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server."},"keyType":{"index":36,"kind":"parameter","displayName":"Key Type","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. From Camel 3.0.0 / 2.25.0, by default Camel will select the first available KeyPair that is loaded. Prior to this, a KeyType of 'ssh-rsa' was enforced by default."},"macs":{"index":37,"kind":"parameter","displayName":"Macs","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Comma-separated list of allowed/supported message authentication code algorithms in their order of preference. The MAC algorithm is used for data integrity protection."},"password":{"index":38,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null."},"signatures":{"index":39,"kind":"parameter","displayName":"Signatures","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Comma-separated list of allowed/supported signature algorithms in their order of preference."},"username":{"index":40,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.ssh.SshConfiguration","configurationField":"configuration","description":"Sets the username to use in logging into the remote SSH server."}}} , -{"component":{"kind":"component","name":"stax","title":"StAX","description":"Process XML payloads by a SAX ContentHandler.","deprecated":false,"firstVersion":"2.9.0","label":"transformation","javaType":"org.apache.camel.component.stax.StAXComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-stax","version":"4.8.1","scheme":"stax","extendsScheme":"","syntax":"stax:contentHandlerClass","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"contentHandlerClass":{"index":0,"kind":"path","displayName":"Content Handler Class","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FQN class name for the ContentHandler implementation to use."},"lazyStartProducer":{"index":1,"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."}}} +{"component":{"kind":"component","name":"stax","title":"StAX","description":"Process XML payloads by a SAX ContentHandler.","deprecated":false,"firstVersion":"2.9.0","label":"transformation","javaType":"org.apache.camel.component.stax.StAXComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-stax","version":"4.8.2","scheme":"stax","extendsScheme":"","syntax":"stax:contentHandlerClass","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"contentHandlerClass":{"index":0,"kind":"path","displayName":"Content Handler Class","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The FQN class name for the ContentHandler implementation to use."},"lazyStartProducer":{"index":1,"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."}}} , -{"component":{"kind":"component","name":"stitch","title":"Stitch","description":"Stitch is a cloud ETL service that integrates various data sources into a central data warehouse through various integrations.","deprecated":false,"firstVersion":"3.8.0","label":"cloud,api,saas,bigdata","javaType":"org.apache.camel.component.stitch.StitchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-stitch","version":"4.8.1","scheme":"stitch","extendsScheme":"","syntax":"stitch:tableName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelStitchTableName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the destination table the data is being pushed to. Table names must be unique in each destination schema, or loading issues will occur. Note: The number of characters in the table name should be within the destinations allowed limits or data will rejected.","constantName":"org.apache.camel.component.stitch.StitchConstants#TABLE_NAME"},"CamelStitchSchema":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"StitchSchema or Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The schema that describes the Stitch message","constantName":"org.apache.camel.component.stitch.StitchConstants#SCHEMA"},"CamelStitchKeyNames":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A collection of strings representing the Primary Key fields in the source table. Stitch use these Primary Keys to de-dupe data during loading If not provided, the table will be loaded in an append-only manner.","constantName":"org.apache.camel.component.stitch.StitchConstants#KEY_NAMES"},"CamelStitchCode":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"HTTP Status code that is returned from Stitch Import HTTP API.","constantName":"org.apache.camel.component.stitch.StitchConstants#CODE"},"CamelStitchHeaders":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"HTTP headers that are returned from Stitch Import HTTP API.","constantName":"org.apache.camel.component.stitch.StitchConstants#HEADERS"},"CamelStitchStatus":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The status message that Stitch returns after sending the data through Stitch Import API.","constantName":"org.apache.camel.component.stitch.StitchConstants#STATUS"}},"properties":{"tableName":{"index":0,"kind":"path","displayName":"Table Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"The name of the destination table the data is being pushed to. Table names must be unique in each destination schema, or loading issues will occur. Note: The number of characters in the table name should be within the destination's allowed limits or data will rejected."},"keyNames":{"index":1,"kind":"parameter","displayName":"Key Names","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"A collection of comma separated strings representing the Primary Key fields in the source table. Stitch use these Primary Keys to de-dupe data during loading If not provided, the table will be loaded in an append-only manner."},"region":{"index":2,"kind":"parameter","displayName":"Region","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.stitch.client.StitchRegion","enum":["NORTH_AMERICA","EUROPE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"EUROPE","configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"Stitch account region, e.g: europe"},"stitchSchema":{"index":3,"kind":"parameter","displayName":"Stitch Schema","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.stitch.client.models.StitchSchema","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"A schema that describes the record(s)"},"connectionProvider":{"index":4,"kind":"parameter","displayName":"Connection Provider","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"reactor.netty.resources.ConnectionProvider","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"ConnectionProvider contain configuration for the HttpClient like Maximum connection limit .. etc, you can inject this ConnectionProvider and the StitchClient will initialize HttpClient with this ConnectionProvider"},"httpClient":{"index":5,"kind":"parameter","displayName":"Http Client","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"reactor.netty.http.client.HttpClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"Reactor Netty HttpClient, you can injected it if you want to have custom HttpClient"},"lazyStartProducer":{"index":6,"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."},"stitchClient":{"index":7,"kind":"parameter","displayName":"Stitch Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.stitch.client.StitchClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"Set a custom StitchClient that implements org.apache.camel.component.stitch.client.StitchClient interface"},"token":{"index":8,"kind":"parameter","displayName":"Token","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"Stitch access token for the Stitch Import API"}}} +{"component":{"kind":"component","name":"stitch","title":"Stitch","description":"Stitch is a cloud ETL service that integrates various data sources into a central data warehouse through various integrations.","deprecated":false,"firstVersion":"3.8.0","label":"cloud,api,saas,bigdata","javaType":"org.apache.camel.component.stitch.StitchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-stitch","version":"4.8.2","scheme":"stitch","extendsScheme":"","syntax":"stitch:tableName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelStitchTableName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the destination table the data is being pushed to. Table names must be unique in each destination schema, or loading issues will occur. Note: The number of characters in the table name should be within the destinations allowed limits or data will rejected.","constantName":"org.apache.camel.component.stitch.StitchConstants#TABLE_NAME"},"CamelStitchSchema":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"StitchSchema or Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The schema that describes the Stitch message","constantName":"org.apache.camel.component.stitch.StitchConstants#SCHEMA"},"CamelStitchKeyNames":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Collection","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A collection of strings representing the Primary Key fields in the source table. Stitch use these Primary Keys to de-dupe data during loading If not provided, the table will be loaded in an append-only manner.","constantName":"org.apache.camel.component.stitch.StitchConstants#KEY_NAMES"},"CamelStitchCode":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"HTTP Status code that is returned from Stitch Import HTTP API.","constantName":"org.apache.camel.component.stitch.StitchConstants#CODE"},"CamelStitchHeaders":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"HTTP headers that are returned from Stitch Import HTTP API.","constantName":"org.apache.camel.component.stitch.StitchConstants#HEADERS"},"CamelStitchStatus":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The status message that Stitch returns after sending the data through Stitch Import API.","constantName":"org.apache.camel.component.stitch.StitchConstants#STATUS"}},"properties":{"tableName":{"index":0,"kind":"path","displayName":"Table Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"The name of the destination table the data is being pushed to. Table names must be unique in each destination schema, or loading issues will occur. Note: The number of characters in the table name should be within the destination's allowed limits or data will rejected."},"keyNames":{"index":1,"kind":"parameter","displayName":"Key Names","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"A collection of comma separated strings representing the Primary Key fields in the source table. Stitch use these Primary Keys to de-dupe data during loading If not provided, the table will be loaded in an append-only manner."},"region":{"index":2,"kind":"parameter","displayName":"Region","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.stitch.client.StitchRegion","enum":["NORTH_AMERICA","EUROPE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"EUROPE","configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"Stitch account region, e.g: europe"},"stitchSchema":{"index":3,"kind":"parameter","displayName":"Stitch Schema","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.stitch.client.models.StitchSchema","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"A schema that describes the record(s)"},"connectionProvider":{"index":4,"kind":"parameter","displayName":"Connection Provider","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"reactor.netty.resources.ConnectionProvider","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"ConnectionProvider contain configuration for the HttpClient like Maximum connection limit .. etc, you can inject this ConnectionProvider and the StitchClient will initialize HttpClient with this ConnectionProvider"},"httpClient":{"index":5,"kind":"parameter","displayName":"Http Client","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"reactor.netty.http.client.HttpClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"Reactor Netty HttpClient, you can injected it if you want to have custom HttpClient"},"lazyStartProducer":{"index":6,"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."},"stitchClient":{"index":7,"kind":"parameter","displayName":"Stitch Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.stitch.client.StitchClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"Set a custom StitchClient that implements org.apache.camel.component.stitch.client.StitchClient interface"},"token":{"index":8,"kind":"parameter","displayName":"Token","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.stitch.StitchConfiguration","configurationField":"configuration","description":"Stitch access token for the Stitch Import API"}}} , -{"component":{"kind":"component","name":"stomp","title":"Stomp","description":"Send and receive messages to/from STOMP (Simple Text Oriented Messaging Protocol) compliant message brokers.","deprecated":false,"firstVersion":"2.12.0","label":"messaging","javaType":"org.apache.camel.component.stomp.StompComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-stomp","version":"4.8.1","scheme":"stomp","extendsScheme":"","syntax":"stomp:destination","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"destination":{"index":0,"kind":"path","displayName":"Destination","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the queue"},"brokerURL":{"index":1,"kind":"parameter","displayName":"Broker URL","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"tcp://localhost:61613","configurationClass":"org.apache.camel.component.stomp.StompConfiguration","configurationField":"configuration","description":"The URI of the Stomp broker to connect to"},"customHeaders":{"index":2,"kind":"parameter","displayName":"Custom Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.stomp.StompConfiguration","configurationField":"configuration","description":"To set custom headers"},"host":{"index":3,"kind":"parameter","displayName":"Host","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.stomp.StompConfiguration","configurationField":"configuration","description":"The virtual host name"},"version":{"index":4,"kind":"parameter","displayName":"Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.stomp.StompConfiguration","configurationField":"configuration","description":"The stomp version (1.1, or 1.2)"},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."},"headerFilterStrategy":{"index":9,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"login":{"index":10,"kind":"parameter","displayName":"Login","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.stomp.StompConfiguration","configurationField":"configuration","description":"The username"},"passcode":{"index":11,"kind":"parameter","displayName":"Passcode","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.stomp.StompConfiguration","configurationField":"configuration","description":"The password"},"sslContextParameters":{"index":12,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.stomp.StompConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}}} +{"component":{"kind":"component","name":"stomp","title":"Stomp","description":"Send and receive messages to/from STOMP (Simple Text Oriented Messaging Protocol) compliant message brokers.","deprecated":false,"firstVersion":"2.12.0","label":"messaging","javaType":"org.apache.camel.component.stomp.StompComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-stomp","version":"4.8.2","scheme":"stomp","extendsScheme":"","syntax":"stomp:destination","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"destination":{"index":0,"kind":"path","displayName":"Destination","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the queue"},"brokerURL":{"index":1,"kind":"parameter","displayName":"Broker URL","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"tcp://localhost:61613","configurationClass":"org.apache.camel.component.stomp.StompConfiguration","configurationField":"configuration","description":"The URI of the Stomp broker to connect to"},"customHeaders":{"index":2,"kind":"parameter","displayName":"Custom Headers","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.stomp.StompConfiguration","configurationField":"configuration","description":"To set custom headers"},"host":{"index":3,"kind":"parameter","displayName":"Host","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.stomp.StompConfiguration","configurationField":"configuration","description":"The virtual host name"},"version":{"index":4,"kind":"parameter","displayName":"Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.stomp.StompConfiguration","configurationField":"configuration","description":"The stomp version (1.1, or 1.2)"},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":6,"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":{"index":7,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":8,"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."},"headerFilterStrategy":{"index":9,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"login":{"index":10,"kind":"parameter","displayName":"Login","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.stomp.StompConfiguration","configurationField":"configuration","description":"The username"},"passcode":{"index":11,"kind":"parameter","displayName":"Passcode","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.stomp.StompConfiguration","configurationField":"configuration","description":"The password"},"sslContextParameters":{"index":12,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.stomp.StompConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}}} , -{"component":{"kind":"component","name":"stream","title":"Stream","description":"Read from system-in and write to system-out and system-err streams.","deprecated":false,"firstVersion":"1.3.0","label":"file,core","javaType":"org.apache.camel.component.stream.StreamComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-stream","version":"4.8.1","scheme":"stream","extendsScheme":"","syntax":"stream:kind","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelStreamIndex":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index","constantName":"org.apache.camel.component.stream.StreamConstants#STREAM_INDEX"},"CamelStreamComplete":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is complete","constantName":"org.apache.camel.component.stream.StreamConstants#STREAM_COMPLETE"}},"properties":{"kind":{"index":0,"kind":"path","displayName":"Kind","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["in","out","err","header","file","http"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Kind of stream to use such as System.in, System.out, a file, or a http url."},"encoding":{"index":1,"kind":"parameter","displayName":"Encoding","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"You can configure the encoding (is a charset name) to use text-based streams (for example, message body is a String object). If not provided, Camel uses the JVM default Charset."},"fileName":{"index":2,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When using the stream:file URI format, this option specifies the filename to stream to/from."},"fileWatcher":{"index":3,"kind":"parameter","displayName":"File Watcher","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To use JVM file watcher to listen for file change events to support re-loading files that may be overwritten, somewhat like tail --retry"},"groupLines":{"index":4,"kind":"parameter","displayName":"Group Lines","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To group X number of lines in the consumer. For example to group 10 lines and therefore only spit out an Exchange with 10 lines, instead of 1 Exchange per line."},"groupStrategy":{"index":5,"kind":"parameter","displayName":"Group Strategy","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.stream.GroupStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Allows to use a custom GroupStrategy to control how to group lines."},"httpHeaders":{"index":6,"kind":"parameter","displayName":"Http Headers","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When using stream:http format, this option specifies optional http headers, such as Accept: application/json. Multiple headers can be separated by comma. The format of headers can be either HEADER=VALUE or HEADER:VALUE. In accordance with the HTTP/1.1 specification, leading and/or trailing whitespace is ignored"},"httpUrl":{"index":7,"kind":"parameter","displayName":"Http Url","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When using stream:http format, this option specifies the http url to stream from."},"initialPromptDelay":{"index":8,"kind":"parameter","displayName":"Initial Prompt Delay","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":2000,"description":"Initial delay in milliseconds before showing the message prompt. This delay occurs only once. Can be used during system startup to avoid message prompts being written while other logging is done to the system out."},"promptDelay":{"index":9,"kind":"parameter","displayName":"Prompt Delay","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Optional delay in milliseconds before showing the message prompt."},"promptMessage":{"index":10,"kind":"parameter","displayName":"Prompt Message","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Message prompt to use when reading from stream:in; for example, you could set this to Enter a command:"},"readLine":{"index":11,"kind":"parameter","displayName":"Read Line","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to read the input stream in line mode (terminate by line breaks). Setting this to false, will instead read the entire stream until EOL."},"retry":{"index":12,"kind":"parameter","displayName":"Retry","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will retry opening the stream if it's overwritten, somewhat like tail --retry If reading from files then you should also enable the fileWatcher option, to make it work reliable."},"scanStream":{"index":13,"kind":"parameter","displayName":"Scan Stream","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To be used for continuously reading a stream such as the unix tail command."},"scanStreamDelay":{"index":14,"kind":"parameter","displayName":"Scan Stream Delay","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Delay in milliseconds between read attempts when using scanStream."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"appendNewLine":{"index":18,"kind":"parameter","displayName":"Append New Line","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to append a new line character at end of output."},"autoCloseCount":{"index":19,"kind":"parameter","displayName":"Auto Close Count","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Number of messages to process before closing stream on Producer side. Never close stream by default (only when Producer is stopped). If more messages are sent, the stream is reopened for another autoCloseCount batch."},"closeOnDone":{"index":20,"kind":"parameter","displayName":"Close On Done","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option is used in combination with Splitter and streaming to the same file. The idea is to keep the stream open and only close when the Splitter is done, to improve performance. Mind this requires that you only stream to the same file, and not 2 or more files."},"delay":{"index":21,"kind":"parameter","displayName":"Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Initial delay in milliseconds before producing the stream."},"lazyStartProducer":{"index":22,"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."},"readTimeout":{"index":23,"kind":"parameter","displayName":"Read Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Sets the read timeout to a specified timeout, in milliseconds. A non-zero value specifies the timeout when reading from Input stream when a connection is established to a resource. If the timeout expires before there is data available for read, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout."}}} +{"component":{"kind":"component","name":"stream","title":"Stream","description":"Read from system-in and write to system-out and system-err streams.","deprecated":false,"firstVersion":"1.3.0","label":"file,core","javaType":"org.apache.camel.component.stream.StreamComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-stream","version":"4.8.2","scheme":"stream","extendsScheme":"","syntax":"stream:kind","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelStreamIndex":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The index","constantName":"org.apache.camel.component.stream.StreamConstants#STREAM_INDEX"},"CamelStreamComplete":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is complete","constantName":"org.apache.camel.component.stream.StreamConstants#STREAM_COMPLETE"}},"properties":{"kind":{"index":0,"kind":"path","displayName":"Kind","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["in","out","err","header","file","http"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Kind of stream to use such as System.in, System.out, a file, or a http url."},"encoding":{"index":1,"kind":"parameter","displayName":"Encoding","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"You can configure the encoding (is a charset name) to use text-based streams (for example, message body is a String object). If not provided, Camel uses the JVM default Charset."},"fileName":{"index":2,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When using the stream:file URI format, this option specifies the filename to stream to/from."},"fileWatcher":{"index":3,"kind":"parameter","displayName":"File Watcher","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To use JVM file watcher to listen for file change events to support re-loading files that may be overwritten, somewhat like tail --retry"},"groupLines":{"index":4,"kind":"parameter","displayName":"Group Lines","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To group X number of lines in the consumer. For example to group 10 lines and therefore only spit out an Exchange with 10 lines, instead of 1 Exchange per line."},"groupStrategy":{"index":5,"kind":"parameter","displayName":"Group Strategy","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.stream.GroupStrategy","deprecated":false,"autowired":false,"secret":false,"description":"Allows to use a custom GroupStrategy to control how to group lines."},"httpHeaders":{"index":6,"kind":"parameter","displayName":"Http Headers","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When using stream:http format, this option specifies optional http headers, such as Accept: application/json. Multiple headers can be separated by comma. The format of headers can be either HEADER=VALUE or HEADER:VALUE. In accordance with the HTTP/1.1 specification, leading and/or trailing whitespace is ignored"},"httpUrl":{"index":7,"kind":"parameter","displayName":"Http Url","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"When using stream:http format, this option specifies the http url to stream from."},"initialPromptDelay":{"index":8,"kind":"parameter","displayName":"Initial Prompt Delay","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":2000,"description":"Initial delay in milliseconds before showing the message prompt. This delay occurs only once. Can be used during system startup to avoid message prompts being written while other logging is done to the system out."},"promptDelay":{"index":9,"kind":"parameter","displayName":"Prompt Delay","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Optional delay in milliseconds before showing the message prompt."},"promptMessage":{"index":10,"kind":"parameter","displayName":"Prompt Message","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Message prompt to use when reading from stream:in; for example, you could set this to Enter a command:"},"readLine":{"index":11,"kind":"parameter","displayName":"Read Line","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to read the input stream in line mode (terminate by line breaks). Setting this to false, will instead read the entire stream until EOL."},"retry":{"index":12,"kind":"parameter","displayName":"Retry","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Will retry opening the stream if it's overwritten, somewhat like tail --retry If reading from files then you should also enable the fileWatcher option, to make it work reliable."},"scanStream":{"index":13,"kind":"parameter","displayName":"Scan Stream","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To be used for continuously reading a stream such as the unix tail command."},"scanStreamDelay":{"index":14,"kind":"parameter","displayName":"Scan Stream Delay","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Delay in milliseconds between read attempts when using scanStream."},"bridgeErrorHandler":{"index":15,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":16,"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":{"index":17,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"appendNewLine":{"index":18,"kind":"parameter","displayName":"Append New Line","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to append a new line character at end of output."},"autoCloseCount":{"index":19,"kind":"parameter","displayName":"Auto Close Count","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Number of messages to process before closing stream on Producer side. Never close stream by default (only when Producer is stopped). If more messages are sent, the stream is reopened for another autoCloseCount batch."},"closeOnDone":{"index":20,"kind":"parameter","displayName":"Close On Done","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"This option is used in combination with Splitter and streaming to the same file. The idea is to keep the stream open and only close when the Splitter is done, to improve performance. Mind this requires that you only stream to the same file, and not 2 or more files."},"delay":{"index":21,"kind":"parameter","displayName":"Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Initial delay in milliseconds before producing the stream."},"lazyStartProducer":{"index":22,"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."},"readTimeout":{"index":23,"kind":"parameter","displayName":"Read Timeout","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Sets the read timeout to a specified timeout, in milliseconds. A non-zero value specifies the timeout when reading from Input stream when a connection is established to a resource. If the timeout expires before there is data available for read, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout."}}} , -{"component":{"kind":"component","name":"string-template","title":"String Template","description":"Transform messages using StringTemplate engine.","deprecated":false,"firstVersion":"1.2.0","label":"transformation,script","javaType":"org.apache.camel.component.stringtemplate.StringTemplateComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-stringtemplate","version":"4.8.1","scheme":"string-template","extendsScheme":"","syntax":"string-template:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelStringTemplateResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to use instead of the endpoint configured.","constantName":"org.apache.camel.component.stringtemplate.StringTemplateConstants#STRINGTEMPLATE_RESOURCE_URI"},"CamelStringTemplateVariableMap":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Map of the variables which are made available to a script or template","constantName":"org.apache.camel.component.stringtemplate.StringTemplateConstants#STRINGTEMPLATE_VARIABLE_MAP"},"CamelStringTemplateTemplate":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.stringtemplate.StringTemplateConstants#STRINGTEMPLATE_TEMPLATE"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"delimiterStart":{"index":4,"kind":"parameter","displayName":"Delimiter Start","group":"producer","label":"","required":false,"type":"string","javaType":"char","deprecated":false,"autowired":false,"secret":false,"defaultValue":"<","description":"The variable start delimiter"},"delimiterStop":{"index":5,"kind":"parameter","displayName":"Delimiter Stop","group":"producer","label":"","required":false,"type":"string","javaType":"char","deprecated":false,"autowired":false,"secret":false,"defaultValue":">","description":"The variable end delimiter"},"lazyStartProducer":{"index":6,"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."}}} +{"component":{"kind":"component","name":"string-template","title":"String Template","description":"Transform messages using StringTemplate engine.","deprecated":false,"firstVersion":"1.2.0","label":"transformation,script","javaType":"org.apache.camel.component.stringtemplate.StringTemplateComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-stringtemplate","version":"4.8.2","scheme":"string-template","extendsScheme":"","syntax":"string-template:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelStringTemplateResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to use instead of the endpoint configured.","constantName":"org.apache.camel.component.stringtemplate.StringTemplateConstants#STRINGTEMPLATE_RESOURCE_URI"},"CamelStringTemplateVariableMap":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Map of the variables which are made available to a script or template","constantName":"org.apache.camel.component.stringtemplate.StringTemplateConstants#STRINGTEMPLATE_VARIABLE_MAP"},"CamelStringTemplateTemplate":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.stringtemplate.StringTemplateConstants#STRINGTEMPLATE_TEMPLATE"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"delimiterStart":{"index":4,"kind":"parameter","displayName":"Delimiter Start","group":"producer","label":"","required":false,"type":"string","javaType":"char","deprecated":false,"autowired":false,"secret":false,"defaultValue":"<","description":"The variable start delimiter"},"delimiterStop":{"index":5,"kind":"parameter","displayName":"Delimiter Stop","group":"producer","label":"","required":false,"type":"string","javaType":"char","deprecated":false,"autowired":false,"secret":false,"defaultValue":">","description":"The variable end delimiter"},"lazyStartProducer":{"index":6,"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."}}} , -{"component":{"kind":"component","name":"stub","title":"Stub","description":"Stub out any physical endpoints while in development or testing.","deprecated":false,"firstVersion":"2.10.0","label":"core,testing","javaType":"org.apache.camel.component.stub.StubComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-stub","version":"4.8.1","scheme":"stub","extendsScheme":"","syntax":"stub:name","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of queue"},"size":{"index":1,"kind":"parameter","displayName":"Size","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"The maximum capacity of the SEDA queue (i.e., the number of messages it can hold). Will by default use the defaultSize set on the SEDA component."},"concurrentConsumers":{"index":2,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Number of concurrent threads processing exchanges."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"limitConcurrentConsumers":{"index":6,"kind":"parameter","displayName":"Limit Concurrent Consumers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to limit the number of concurrentConsumers to the maximum of 500. By default, an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off."},"multipleConsumers":{"index":7,"kind":"parameter","displayName":"Multiple Consumers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether multiple consumers are allowed. If enabled, you can use SEDA for Publish-Subscribe messaging. That is, you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint."},"pollTimeout":{"index":8,"kind":"parameter","displayName":"Poll Timeout","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"The timeout (in milliseconds) used when polling. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."},"purgeWhenStopping":{"index":9,"kind":"parameter","displayName":"Purge When Stopping","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to purge the task queue when stopping the consumer/route. This allows to stop faster, as any pending messages on the queue is discarded."},"blockWhenFull":{"index":10,"kind":"parameter","displayName":"Block When Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will instead block and wait until the message can be accepted."},"discardIfNoConsumers":{"index":11,"kind":"parameter","displayName":"Discard If No Consumers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should discard the message (do not add the message to the queue), when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time."},"discardWhenFull":{"index":12,"kind":"parameter","displayName":"Discard When Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a thread that sends messages to a full SEDA queue will be discarded. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will give up sending and continue, meaning that the message was not sent to the SEDA queue."},"failIfNoConsumers":{"index":13,"kind":"parameter","displayName":"Fail If No Consumers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should fail by throwing an exception, when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time."},"offerTimeout":{"index":14,"kind":"parameter","displayName":"Offer Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Offer timeout (in milliseconds) can be added to the block case when queue is full. You can disable timeout by using 0 or a negative value."},"timeout":{"index":15,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value."},"waitForTaskToComplete":{"index":16,"kind":"parameter","displayName":"Wait For Task To Complete","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.WaitForTaskToComplete","enum":["Never","IfReplyExpected","Always"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"IfReplyExpected","description":"Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based. The default option is IfReplyExpected."},"lazyStartProducer":{"index":17,"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."},"queue":{"index":18,"kind":"parameter","displayName":"Queue","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.concurrent.BlockingQueue","deprecated":false,"autowired":false,"secret":false,"description":"Define the queue instance which will be used by the endpoint"}}} +{"component":{"kind":"component","name":"stub","title":"Stub","description":"Stub out any physical endpoints while in development or testing.","deprecated":false,"firstVersion":"2.10.0","label":"core,testing","javaType":"org.apache.camel.component.stub.StubComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-stub","version":"4.8.2","scheme":"stub","extendsScheme":"","syntax":"stub:name","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":false},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of queue"},"size":{"index":1,"kind":"parameter","displayName":"Size","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"The maximum capacity of the SEDA queue (i.e., the number of messages it can hold). Will by default use the defaultSize set on the SEDA component."},"concurrentConsumers":{"index":2,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"Number of concurrent threads processing exchanges."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":4,"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":{"index":5,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"limitConcurrentConsumers":{"index":6,"kind":"parameter","displayName":"Limit Concurrent Consumers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to limit the number of concurrentConsumers to the maximum of 500. By default, an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off."},"multipleConsumers":{"index":7,"kind":"parameter","displayName":"Multiple Consumers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether multiple consumers are allowed. If enabled, you can use SEDA for Publish-Subscribe messaging. That is, you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint."},"pollTimeout":{"index":8,"kind":"parameter","displayName":"Poll Timeout","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"The timeout (in milliseconds) used when polling. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."},"purgeWhenStopping":{"index":9,"kind":"parameter","displayName":"Purge When Stopping","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to purge the task queue when stopping the consumer/route. This allows to stop faster, as any pending messages on the queue is discarded."},"blockWhenFull":{"index":10,"kind":"parameter","displayName":"Block When Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will instead block and wait until the message can be accepted."},"discardIfNoConsumers":{"index":11,"kind":"parameter","displayName":"Discard If No Consumers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should discard the message (do not add the message to the queue), when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time."},"discardWhenFull":{"index":12,"kind":"parameter","displayName":"Discard When Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether a thread that sends messages to a full SEDA queue will be discarded. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will give up sending and continue, meaning that the message was not sent to the SEDA queue."},"failIfNoConsumers":{"index":13,"kind":"parameter","displayName":"Fail If No Consumers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should fail by throwing an exception, when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time."},"offerTimeout":{"index":14,"kind":"parameter","displayName":"Offer Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Offer timeout (in milliseconds) can be added to the block case when queue is full. You can disable timeout by using 0 or a negative value."},"timeout":{"index":15,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value."},"waitForTaskToComplete":{"index":16,"kind":"parameter","displayName":"Wait For Task To Complete","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.WaitForTaskToComplete","enum":["Never","IfReplyExpected","Always"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"IfReplyExpected","description":"Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based. The default option is IfReplyExpected."},"lazyStartProducer":{"index":17,"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."},"queue":{"index":18,"kind":"parameter","displayName":"Queue","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.concurrent.BlockingQueue","deprecated":false,"autowired":false,"secret":false,"description":"Define the queue instance which will be used by the endpoint"}}} , -{"component":{"kind":"component","name":"tahu-edge","title":"Tahu Edge Node / Device","description":"Sparkplug B Edge Node and Device support over MQTT using Eclipse Tahu","deprecated":false,"firstVersion":"4.8.0","label":"messaging,iot,monitoring","javaType":"org.apache.camel.component.tahu.TahuEdgeComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-tahu","version":"4.8.1","scheme":"tahu-edge","extendsScheme":"","syntax":"tahu-edge:groupId/edgeNode","alternativeSyntax":"tahu-edge:groupId/edgeNode/deviceId","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelTahuMessageType":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","enum":["NBIRTH","NDATA","NDEATH","DBIRTH","DDATA","DDEATH"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Sparkplug message type of the message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_TYPE"},"CamelTahuEdgeNodeDescriptor":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Sparkplug edge node descriptor string source of a message or metric","constantName":"org.apache.camel.component.tahu.TahuConstants#EDGE_NODE_DESCRIPTOR"},"CamelTahuMessageTimestamp":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of a Sparkplug message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_TIMESTAMP"},"CamelTahuMessageUUID":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.util.UUID","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The UUID of a Sparkplug message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_UUID"},"CamelTahuMessageSequenceNumber":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sequence number of a Sparkplug message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_SEQUENCE_NUMBER"}},"properties":{"groupId":{"index":0,"kind":"path","displayName":"Group Id","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the group"},"edgeNode":{"index":1,"kind":"path","displayName":"Edge Node","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the edge node"},"deviceId":{"index":2,"kind":"path","displayName":"Device Id","group":"producer (device only)","label":"producer (device only)","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of this edge node device"},"checkClientIdLength":{"index":3,"kind":"parameter","displayName":"Check Client Id Length","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT client ID length check enabled"},"clientId":{"index":4,"kind":"parameter","displayName":"Client Id","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT client ID to use for all server definitions, rather than specifying the same one for each. Note that if neither the 'clientId' parameter nor an 'MqttClientId' are defined for an MQTT Server, a random MQTT Client ID will be generated automatically, prefaced with 'Camel'"},"keepAliveTimeout":{"index":5,"kind":"parameter","displayName":"Keep Alive Timeout","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":30,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT connection keep alive timeout, in seconds"},"rebirthDebounceDelay":{"index":6,"kind":"parameter","displayName":"Rebirth Debounce Delay","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"Delay before recurring node rebirth messages will be sent"},"servers":{"index":7,"kind":"parameter","displayName":"Servers","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT server definitions, given with the following syntax in a comma-separated list: MqttServerName:(MqttClientId:)(tcp/ssl)://hostname(:port),..."},"metricDataTypePayloadMap":{"index":8,"kind":"parameter","displayName":"Metric Data Type Payload Map","group":"producer","label":"producer","required":true,"type":"object","javaType":"org.eclipse.tahu.message.model.SparkplugBPayloadMap","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tahu SparkplugBPayloadMap to configure metric data types for this edge node or device. Note that this payload is used exclusively as a Sparkplug B spec-compliant configuration for all possible edge node or device metric names, aliases, and data types. This configuration is required to publish proper Sparkplug B NBIRTH and DBIRTH payloads."},"headerFilterStrategy":{"index":9,"kind":"parameter","displayName":"Header Filter Strategy","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter headers used as Sparkplug metrics. Default value notice: Defaults to sending all Camel Message headers with name prefixes of CamelTahuMetric., including those with null values"},"lazyStartProducer":{"index":10,"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."},"bdSeqManager":{"index":11,"kind":"parameter","displayName":"Bd Seq Manager","group":"advanced","label":"producer (edge node only),advanced","required":false,"type":"object","javaType":"org.eclipse.tahu.message.BdSeqManager","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"org.apache.camel.component.tahu.CamelBdSeqManager","description":"To use a specific org.eclipse.tahu.message.BdSeqManager implementation to manage edge node birth-death sequence numbers"},"bdSeqNumPath":{"index":12,"kind":"parameter","displayName":"Bd Seq Num Path","group":"advanced","label":"producer (edge node only),advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"${sys:java.io.tmpdir}/CamelTahuTemp","description":"Path for Sparkplug B NBIRTH/NDEATH sequence number persistence files. This path will contain files named as -bdSeqNum and must be writable by the executing process' user"},"useAliases":{"index":13,"kind":"parameter","displayName":"Use Aliases","group":"advanced","label":"producer (edge node only),advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Flag enabling support for metric aliases"},"deviceIds":{"index":14,"kind":"parameter","displayName":"Device Ids","group":"producer (edge node only)","label":"producer (edge node only)","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of each device connected to this edge node, as a comma-separated list"},"primaryHostId":{"index":15,"kind":"parameter","displayName":"Primary Host Id","group":"producer (edge node only)","label":"producer (edge node only)","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Host ID of the primary host application for this edge node"},"password":{"index":16,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"Password for MQTT server authentication"},"sslContextParameters":{"index":17,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"SSL configuration for MQTT server connections"},"username":{"index":18,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"Username for MQTT server authentication"}}} +{"component":{"kind":"component","name":"tahu-edge","title":"Tahu Edge Node / Device","description":"Sparkplug B Edge Node and Device support over MQTT using Eclipse Tahu","deprecated":false,"firstVersion":"4.8.0","label":"messaging,iot,monitoring","javaType":"org.apache.camel.component.tahu.TahuEdgeComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-tahu","version":"4.8.2","scheme":"tahu-edge","extendsScheme":"","syntax":"tahu-edge:groupId/edgeNode","alternativeSyntax":"tahu-edge:groupId/edgeNode/deviceId","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelTahuMessageType":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","enum":["NBIRTH","NDATA","NDEATH","DBIRTH","DDATA","DDEATH"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Sparkplug message type of the message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_TYPE"},"CamelTahuEdgeNodeDescriptor":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Sparkplug edge node descriptor string source of a message or metric","constantName":"org.apache.camel.component.tahu.TahuConstants#EDGE_NODE_DESCRIPTOR"},"CamelTahuMessageTimestamp":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of a Sparkplug message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_TIMESTAMP"},"CamelTahuMessageUUID":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.util.UUID","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The UUID of a Sparkplug message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_UUID"},"CamelTahuMessageSequenceNumber":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sequence number of a Sparkplug message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_SEQUENCE_NUMBER"}},"properties":{"groupId":{"index":0,"kind":"path","displayName":"Group Id","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the group"},"edgeNode":{"index":1,"kind":"path","displayName":"Edge Node","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of the edge node"},"deviceId":{"index":2,"kind":"path","displayName":"Device Id","group":"producer (device only)","label":"producer (device only)","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of this edge node device"},"checkClientIdLength":{"index":3,"kind":"parameter","displayName":"Check Client Id Length","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT client ID length check enabled"},"clientId":{"index":4,"kind":"parameter","displayName":"Client Id","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT client ID to use for all server definitions, rather than specifying the same one for each. Note that if neither the 'clientId' parameter nor an 'MqttClientId' are defined for an MQTT Server, a random MQTT Client ID will be generated automatically, prefaced with 'Camel'"},"keepAliveTimeout":{"index":5,"kind":"parameter","displayName":"Keep Alive Timeout","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":30,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT connection keep alive timeout, in seconds"},"rebirthDebounceDelay":{"index":6,"kind":"parameter","displayName":"Rebirth Debounce Delay","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"Delay before recurring node rebirth messages will be sent"},"servers":{"index":7,"kind":"parameter","displayName":"Servers","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT server definitions, given with the following syntax in a comma-separated list: MqttServerName:(MqttClientId:)(tcp/ssl)://hostname(:port),..."},"metricDataTypePayloadMap":{"index":8,"kind":"parameter","displayName":"Metric Data Type Payload Map","group":"producer","label":"producer","required":true,"type":"object","javaType":"org.eclipse.tahu.message.model.SparkplugBPayloadMap","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Tahu SparkplugBPayloadMap to configure metric data types for this edge node or device. Note that this payload is used exclusively as a Sparkplug B spec-compliant configuration for all possible edge node or device metric names, aliases, and data types. This configuration is required to publish proper Sparkplug B NBIRTH and DBIRTH payloads."},"headerFilterStrategy":{"index":9,"kind":"parameter","displayName":"Header Filter Strategy","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter headers used as Sparkplug metrics. Default value notice: Defaults to sending all Camel Message headers with name prefixes of CamelTahuMetric., including those with null values"},"lazyStartProducer":{"index":10,"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."},"bdSeqManager":{"index":11,"kind":"parameter","displayName":"Bd Seq Manager","group":"advanced","label":"producer (edge node only),advanced","required":false,"type":"object","javaType":"org.eclipse.tahu.message.BdSeqManager","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"org.apache.camel.component.tahu.CamelBdSeqManager","description":"To use a specific org.eclipse.tahu.message.BdSeqManager implementation to manage edge node birth-death sequence numbers"},"bdSeqNumPath":{"index":12,"kind":"parameter","displayName":"Bd Seq Num Path","group":"advanced","label":"producer (edge node only),advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"${sys:java.io.tmpdir}/CamelTahuTemp","description":"Path for Sparkplug B NBIRTH/NDEATH sequence number persistence files. This path will contain files named as -bdSeqNum and must be writable by the executing process' user"},"useAliases":{"index":13,"kind":"parameter","displayName":"Use Aliases","group":"advanced","label":"producer (edge node only),advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Flag enabling support for metric aliases"},"deviceIds":{"index":14,"kind":"parameter","displayName":"Device Ids","group":"producer (edge node only)","label":"producer (edge node only)","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID of each device connected to this edge node, as a comma-separated list"},"primaryHostId":{"index":15,"kind":"parameter","displayName":"Primary Host Id","group":"producer (edge node only)","label":"producer (edge node only)","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Host ID of the primary host application for this edge node"},"password":{"index":16,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"Password for MQTT server authentication"},"sslContextParameters":{"index":17,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"SSL configuration for MQTT server connections"},"username":{"index":18,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"Username for MQTT server authentication"}}} , -{"component":{"kind":"component","name":"tahu-host","title":"Tahu Host Application","description":"Sparkplug B Host Application support over MQTT using Eclipse Tahu","deprecated":false,"firstVersion":"4.8.0","label":"messaging,iot,monitoring","javaType":"org.apache.camel.component.tahu.TahuHostComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-tahu","version":"4.8.1","scheme":"tahu-host","extendsScheme":"","syntax":"tahu-host:hostId","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelTahuMessageType":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","enum":["NBIRTH","NDATA","NDEATH","DBIRTH","DDATA","DDEATH"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Sparkplug message type of the message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_TYPE"},"CamelTahuEdgeNodeDescriptor":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Sparkplug edge node descriptor string source of a message or metric","constantName":"org.apache.camel.component.tahu.TahuConstants#EDGE_NODE_DESCRIPTOR"},"CamelTahuMessageTimestamp":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of a Sparkplug message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_TIMESTAMP"},"CamelTahuMessageUUID":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"java.util.UUID","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The UUID of a Sparkplug message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_UUID"},"CamelTahuMessageSequenceNumber":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sequence number of a Sparkplug message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_SEQUENCE_NUMBER"}},"properties":{"hostId":{"index":0,"kind":"path","displayName":"Host Id","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID for the host application"},"checkClientIdLength":{"index":1,"kind":"parameter","displayName":"Check Client Id Length","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT client ID length check enabled"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT client ID to use for all server definitions, rather than specifying the same one for each. Note that if neither the 'clientId' parameter nor an 'MqttClientId' are defined for an MQTT Server, a random MQTT Client ID will be generated automatically, prefaced with 'Camel'"},"keepAliveTimeout":{"index":3,"kind":"parameter","displayName":"Keep Alive Timeout","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":30,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT connection keep alive timeout, in seconds"},"rebirthDebounceDelay":{"index":4,"kind":"parameter","displayName":"Rebirth Debounce Delay","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"Delay before recurring node rebirth messages will be sent"},"servers":{"index":5,"kind":"parameter","displayName":"Servers","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT server definitions, given with the following syntax in a comma-separated list: MqttServerName:(MqttClientId:)(tcp/ssl)://hostname(:port),..."},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"password":{"index":9,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"Password for MQTT server authentication"},"sslContextParameters":{"index":10,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"SSL configuration for MQTT server connections"},"username":{"index":11,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"Username for MQTT server authentication"}}} +{"component":{"kind":"component","name":"tahu-host","title":"Tahu Host Application","description":"Sparkplug B Host Application support over MQTT using Eclipse Tahu","deprecated":false,"firstVersion":"4.8.0","label":"messaging,iot,monitoring","javaType":"org.apache.camel.component.tahu.TahuHostComponent","supportLevel":"Preview","groupId":"org.apache.camel","artifactId":"camel-tahu","version":"4.8.2","scheme":"tahu-host","extendsScheme":"","syntax":"tahu-host:hostId","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelTahuMessageType":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","enum":["NBIRTH","NDATA","NDEATH","DBIRTH","DDATA","DDEATH"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Sparkplug message type of the message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_TYPE"},"CamelTahuEdgeNodeDescriptor":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Sparkplug edge node descriptor string source of a message or metric","constantName":"org.apache.camel.component.tahu.TahuConstants#EDGE_NODE_DESCRIPTOR"},"CamelTahuMessageTimestamp":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of a Sparkplug message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_TIMESTAMP"},"CamelTahuMessageUUID":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"java.util.UUID","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The UUID of a Sparkplug message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_UUID"},"CamelTahuMessageSequenceNumber":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sequence number of a Sparkplug message","constantName":"org.apache.camel.component.tahu.TahuConstants#MESSAGE_SEQUENCE_NUMBER"}},"properties":{"hostId":{"index":0,"kind":"path","displayName":"Host Id","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ID for the host application"},"checkClientIdLength":{"index":1,"kind":"parameter","displayName":"Check Client Id Length","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT client ID length check enabled"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT client ID to use for all server definitions, rather than specifying the same one for each. Note that if neither the 'clientId' parameter nor an 'MqttClientId' are defined for an MQTT Server, a random MQTT Client ID will be generated automatically, prefaced with 'Camel'"},"keepAliveTimeout":{"index":3,"kind":"parameter","displayName":"Keep Alive Timeout","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":30,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT connection keep alive timeout, in seconds"},"rebirthDebounceDelay":{"index":4,"kind":"parameter","displayName":"Rebirth Debounce Delay","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"Delay before recurring node rebirth messages will be sent"},"servers":{"index":5,"kind":"parameter","displayName":"Servers","group":"common","label":"common","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"MQTT server definitions, given with the following syntax in a comma-separated list: MqttServerName:(MqttClientId:)(tcp/ssl)://hostname(:port),..."},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"password":{"index":9,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"Password for MQTT server authentication"},"sslContextParameters":{"index":10,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"SSL configuration for MQTT server connections"},"username":{"index":11,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.tahu.TahuConfiguration","configurationField":"configuration","description":"Username for MQTT server authentication"}}} , -{"component":{"kind":"component","name":"telegram","title":"Telegram","description":"Send and receive messages using the Telegram Bot API.","deprecated":false,"firstVersion":"2.18.0","label":"cloud,api,chat","javaType":"org.apache.camel.component.telegram.TelegramComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-telegram","version":"4.8.1","scheme":"telegram","extendsScheme":"","syntax":"telegram:type","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelTelegramChatId":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header is used by the producer endpoint in order to resolve the chat id that will receive the message. The recipient chat id can be placed (in order of priority) in message body, in the CamelTelegramChatId header or in the endpoint configuration (chatId option). This header is also present in all incoming messages.","constantName":"org.apache.camel.component.telegram.TelegramConstants#TELEGRAM_CHAT_ID"},"CamelTelegramMediaType":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.telegram.TelegramMediaType or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header is used to identify the media type when the outgoing message is composed of pure binary data. Possible values are strings or enum values belonging to the org.apache.camel.component.telegram.TelegramMediaType enumeration.","constantName":"org.apache.camel.component.telegram.TelegramConstants#TELEGRAM_MEDIA_TYPE"},"CamelTelegramMediaTitleCaption":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header is used to provide a caption or title for outgoing binary messages.","constantName":"org.apache.camel.component.telegram.TelegramConstants#TELEGRAM_MEDIA_TITLE_CAPTION"},"CamelTelegramMediaMarkup":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.telegram.model.ReplyMarkup","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The reply markup.","constantName":"org.apache.camel.component.telegram.TelegramConstants#TELEGRAM_MEDIA_MARKUP"},"CamelTelegramParseMode":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.telegram.TelegramParseMode","enum":["HTML","MARKDOWN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header is used to format text messages using HTML or Markdown","constantName":"org.apache.camel.component.telegram.TelegramConstants#TELEGRAM_PARSE_MODE"},"CamelMessageTimestamp":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message timestamp.","constantName":"org.apache.camel.component.telegram.TelegramConstants#MESSAGE_TIMESTAMP"}},"properties":{"type":{"index":0,"kind":"path","displayName":"Type","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["bots"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"The endpoint type. Currently, only the 'bots' type is supported."},"limit":{"index":1,"kind":"parameter","displayName":"Limit","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"Limit on the number of updates that can be received in a single polling request."},"sendEmptyMessageWhenIdle":{"index":2,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"timeout":{"index":3,"kind":"parameter","displayName":"Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30","configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"Timeout in seconds for long polling. Put 0 for short polling or a bigger number for long polling. Long polling produces shorter response time."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":7,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"chatId":{"index":8,"kind":"parameter","displayName":"Chat Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"The identifier of the chat that will receive the produced messages. Chat ids can be first obtained from incoming messages (eg. when a telegram user starts a conversation with a bot, its client sends automatically a '/start' message containing the chat id). It is an optional parameter, as the chat id can be set dynamically for each outgoing message (using body or headers)."},"lazyStartProducer":{"index":9,"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."},"baseUri":{"index":10,"kind":"parameter","displayName":"Base Uri","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"Can be used to set an alternative base URI, e.g. when you want to test the component against a mock Telegram API"},"bufferSize":{"index":11,"kind":"parameter","displayName":"Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1048576,"description":"The initial in-memory buffer size used when transferring data between Camel and AHC Client."},"client":{"index":12,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.net.http.HttpClient","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpClient"},"proxyHost":{"index":13,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"HTTP proxy host which could be used when sending out the message."},"proxyPort":{"index":14,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"HTTP proxy port which could be used when sending out the message."},"proxyType":{"index":15,"kind":"parameter","displayName":"Proxy Type","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"org.apache.camel.component.telegram.TelegramProxyType","enum":["HTTP","SOCKS4","SOCKS5"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTP","configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"HTTP proxy type which could be used when sending out the message."},"backoffErrorThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":17,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":18,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":19,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":20,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":21,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":22,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":23,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":24,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":25,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":26,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":27,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":28,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":29,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"authorizationToken":{"index":30,"kind":"parameter","displayName":"Authorization Token","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"The authorization token for using the bot (ask the BotFather)"}}} +{"component":{"kind":"component","name":"telegram","title":"Telegram","description":"Send and receive messages using the Telegram Bot API.","deprecated":false,"firstVersion":"2.18.0","label":"cloud,api,chat","javaType":"org.apache.camel.component.telegram.TelegramComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-telegram","version":"4.8.2","scheme":"telegram","extendsScheme":"","syntax":"telegram:type","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelTelegramChatId":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header is used by the producer endpoint in order to resolve the chat id that will receive the message. The recipient chat id can be placed (in order of priority) in message body, in the CamelTelegramChatId header or in the endpoint configuration (chatId option). This header is also present in all incoming messages.","constantName":"org.apache.camel.component.telegram.TelegramConstants#TELEGRAM_CHAT_ID"},"CamelTelegramMediaType":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.telegram.TelegramMediaType or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header is used to identify the media type when the outgoing message is composed of pure binary data. Possible values are strings or enum values belonging to the org.apache.camel.component.telegram.TelegramMediaType enumeration.","constantName":"org.apache.camel.component.telegram.TelegramConstants#TELEGRAM_MEDIA_TYPE"},"CamelTelegramMediaTitleCaption":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header is used to provide a caption or title for outgoing binary messages.","constantName":"org.apache.camel.component.telegram.TelegramConstants#TELEGRAM_MEDIA_TITLE_CAPTION"},"CamelTelegramMediaMarkup":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.telegram.model.ReplyMarkup","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The reply markup.","constantName":"org.apache.camel.component.telegram.TelegramConstants#TELEGRAM_MEDIA_MARKUP"},"CamelTelegramParseMode":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.telegram.TelegramParseMode","enum":["HTML","MARKDOWN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header is used to format text messages using HTML or Markdown","constantName":"org.apache.camel.component.telegram.TelegramConstants#TELEGRAM_PARSE_MODE"},"CamelMessageTimestamp":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message timestamp.","constantName":"org.apache.camel.component.telegram.TelegramConstants#MESSAGE_TIMESTAMP"}},"properties":{"type":{"index":0,"kind":"path","displayName":"Type","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["bots"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"The endpoint type. Currently, only the 'bots' type is supported."},"limit":{"index":1,"kind":"parameter","displayName":"Limit","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"Limit on the number of updates that can be received in a single polling request."},"sendEmptyMessageWhenIdle":{"index":2,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"timeout":{"index":3,"kind":"parameter","displayName":"Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30","configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"Timeout in seconds for long polling. Put 0 for short polling or a bigger number for long polling. Long polling produces shorter response time."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":7,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"chatId":{"index":8,"kind":"parameter","displayName":"Chat Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"The identifier of the chat that will receive the produced messages. Chat ids can be first obtained from incoming messages (eg. when a telegram user starts a conversation with a bot, its client sends automatically a '/start' message containing the chat id). It is an optional parameter, as the chat id can be set dynamically for each outgoing message (using body or headers)."},"lazyStartProducer":{"index":9,"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."},"baseUri":{"index":10,"kind":"parameter","displayName":"Base Uri","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"Can be used to set an alternative base URI, e.g. when you want to test the component against a mock Telegram API"},"bufferSize":{"index":11,"kind":"parameter","displayName":"Buffer Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1048576,"description":"The initial in-memory buffer size used when transferring data between Camel and AHC Client."},"client":{"index":12,"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.net.http.HttpClient","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpClient"},"proxyHost":{"index":13,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"HTTP proxy host which could be used when sending out the message."},"proxyPort":{"index":14,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"HTTP proxy port which could be used when sending out the message."},"proxyType":{"index":15,"kind":"parameter","displayName":"Proxy Type","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"org.apache.camel.component.telegram.TelegramProxyType","enum":["HTTP","SOCKS4","SOCKS5"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTP","configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"HTTP proxy type which could be used when sending out the message."},"backoffErrorThreshold":{"index":16,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":17,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":18,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":19,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":20,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":21,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":22,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":23,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":24,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":25,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":26,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":27,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":28,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":29,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"authorizationToken":{"index":30,"kind":"parameter","displayName":"Authorization Token","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.telegram.TelegramConfiguration","configurationField":"configuration","description":"The authorization token for using the bot (ask the BotFather)"}}} , -{"component":{"kind":"component","name":"thrift","title":"Thrift","description":"Call and expose remote procedures (RPC) with Apache Thrift data format and serialization mechanism.","deprecated":false,"firstVersion":"2.20.0","label":"rpc,transformation","javaType":"org.apache.camel.component.thrift.ThriftComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-thrift","version":"4.8.1","scheme":"thrift","extendsScheme":"","syntax":"thrift:host:port/service","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelThriftMethodName":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Method name handled by the consumer service","constantName":"org.apache.camel.component.thrift.ThriftConstants#THRIFT_METHOD_NAME_HEADER"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift server host name. This is localhost or 0.0.0.0 (if not defined) when being a consumer or remote server host name when using producer."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift server port"},"service":{"index":2,"kind":"path","displayName":"Service","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Fully qualified service name from the thrift descriptor file (package dot service definition name)"},"compressionType":{"index":3,"kind":"parameter","displayName":"Compression Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.thrift.ThriftCompressionType","enum":["NONE","ZLIB"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"NONE","configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Protocol compression mechanism type"},"exchangeProtocol":{"index":4,"kind":"parameter","displayName":"Exchange Protocol","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.thrift.ThriftExchangeProtocol","enum":["BINARY","JSON","SJSON","COMPACT"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"BINARY","configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Exchange protocol serialization type"},"clientTimeout":{"index":5,"kind":"parameter","displayName":"Client Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Client timeout for consumers"},"maxPoolSize":{"index":6,"kind":"parameter","displayName":"Max Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift server consumer max thread pool size"},"poolSize":{"index":7,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift server consumer initial thread pool size"},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"method":{"index":11,"kind":"parameter","displayName":"Method","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift invoked method name"},"lazyStartProducer":{"index":12,"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."},"synchronous":{"index":13,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"negotiationType":{"index":14,"kind":"parameter","displayName":"Negotiation Type","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.thrift.ThriftNegotiationType","enum":["PLAINTEXT","SSL","SASL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PLAINTEXT","configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Security negotiation type"},"sslParameters":{"index":15,"kind":"parameter","displayName":"Ssl Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Configuration parameters for SSL/TLS security negotiation"}}} +{"component":{"kind":"component","name":"thrift","title":"Thrift","description":"Call and expose remote procedures (RPC) with Apache Thrift data format and serialization mechanism.","deprecated":false,"firstVersion":"2.20.0","label":"rpc,transformation","javaType":"org.apache.camel.component.thrift.ThriftComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-thrift","version":"4.8.2","scheme":"thrift","extendsScheme":"","syntax":"thrift:host:port/service","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelThriftMethodName":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Method name handled by the consumer service","constantName":"org.apache.camel.component.thrift.ThriftConstants#THRIFT_METHOD_NAME_HEADER"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift server host name. This is localhost or 0.0.0.0 (if not defined) when being a consumer or remote server host name when using producer."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift server port"},"service":{"index":2,"kind":"path","displayName":"Service","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Fully qualified service name from the thrift descriptor file (package dot service definition name)"},"compressionType":{"index":3,"kind":"parameter","displayName":"Compression Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.thrift.ThriftCompressionType","enum":["NONE","ZLIB"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"NONE","configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Protocol compression mechanism type"},"exchangeProtocol":{"index":4,"kind":"parameter","displayName":"Exchange Protocol","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.thrift.ThriftExchangeProtocol","enum":["BINARY","JSON","SJSON","COMPACT"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"BINARY","configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Exchange protocol serialization type"},"clientTimeout":{"index":5,"kind":"parameter","displayName":"Client Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Client timeout for consumers"},"maxPoolSize":{"index":6,"kind":"parameter","displayName":"Max Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift server consumer max thread pool size"},"poolSize":{"index":7,"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift server consumer initial thread pool size"},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"method":{"index":11,"kind":"parameter","displayName":"Method","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift invoked method name"},"lazyStartProducer":{"index":12,"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."},"synchronous":{"index":13,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"negotiationType":{"index":14,"kind":"parameter","displayName":"Negotiation Type","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.thrift.ThriftNegotiationType","enum":["PLAINTEXT","SSL","SASL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PLAINTEXT","configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Security negotiation type"},"sslParameters":{"index":15,"kind":"parameter","displayName":"Ssl Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Configuration parameters for SSL/TLS security negotiation"}}} , -{"component":{"kind":"component","name":"thymeleaf","title":"Thymeleaf","description":"Transform messages using a Thymeleaf template.","deprecated":false,"firstVersion":"4.1.0","label":"transformation","javaType":"org.apache.camel.component.thymeleaf.ThymeleafComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-thymeleaf","version":"4.8.1","scheme":"thymeleaf","extendsScheme":"","syntax":"thymeleaf:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelThymeleafResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the Thymeleaf template.","constantName":"org.apache.camel.component.thymeleaf.ThymeleafConstants#THYMELEAF_RESOURCE_URI"},"CamelThymeleafTemplate":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content of the Thymeleaf template.","constantName":"org.apache.camel.component.thymeleaf.ThymeleafConstants#THYMELEAF_TEMPLATE"},"CamelThymeleafVariableMap":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of this header should be a Map with key/values that will be override any existing key with the same name. This can be used to preconfigure common key/values you want to reuse in your Thymeleaf endpoints.","constantName":"org.apache.camel.component.thymeleaf.ThymeleafConstants#THYMELEAF_VARIABLE_MAP"},"CamelThymeleafServletContext":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"jakarta.servlet.ServletContext","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ServletContext for a web application.","constantName":"org.apache.camel.component.thymeleaf.ThymeleafConstants#THYMELEAF_SERVLET_CONTEXT"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"cacheable":{"index":2,"kind":"parameter","displayName":"Cacheable","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Whether templates have to be considered cacheable or not."},"cacheTimeToLive":{"index":3,"kind":"parameter","displayName":"Cache Time To Live","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The cache Time To Live for templates, expressed in milliseconds."},"checkExistence":{"index":4,"kind":"parameter","displayName":"Check Existence","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Whether a template resources will be checked for existence before being returned."},"contentCache":{"index":5,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"templateMode":{"index":6,"kind":"parameter","displayName":"Template Mode","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["HTML","XML","TEXT","JAVASCRIPT","CSS","RAW"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTML","description":"The template mode to be applied to templates."},"lazyStartProducer":{"index":7,"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."},"encoding":{"index":8,"kind":"parameter","displayName":"Encoding","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The character encoding to be used for reading template resources."},"order":{"index":9,"kind":"parameter","displayName":"Order","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The order in which this template will be resolved as part of the resolver chain."},"prefix":{"index":10,"kind":"parameter","displayName":"Prefix","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An optional prefix added to template names to convert them into resource names."},"resolver":{"index":11,"kind":"parameter","displayName":"Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.thymeleaf.ThymeleafResolverType","enum":["CLASS_LOADER","DEFAULT","FILE","STRING","URL","WEB_APP"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CLASS_LOADER","description":"The type of resolver to be used by the template engine."},"suffix":{"index":12,"kind":"parameter","displayName":"Suffix","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An optional suffix added to template names to convert them into resource names."}}} +{"component":{"kind":"component","name":"thymeleaf","title":"Thymeleaf","description":"Transform messages using a Thymeleaf template.","deprecated":false,"firstVersion":"4.1.0","label":"transformation","javaType":"org.apache.camel.component.thymeleaf.ThymeleafComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-thymeleaf","version":"4.8.2","scheme":"thymeleaf","extendsScheme":"","syntax":"thymeleaf:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelThymeleafResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the Thymeleaf template.","constantName":"org.apache.camel.component.thymeleaf.ThymeleafConstants#THYMELEAF_RESOURCE_URI"},"CamelThymeleafTemplate":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content of the Thymeleaf template.","constantName":"org.apache.camel.component.thymeleaf.ThymeleafConstants#THYMELEAF_TEMPLATE"},"CamelThymeleafVariableMap":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of this header should be a Map with key/values that will be override any existing key with the same name. This can be used to preconfigure common key/values you want to reuse in your Thymeleaf endpoints.","constantName":"org.apache.camel.component.thymeleaf.ThymeleafConstants#THYMELEAF_VARIABLE_MAP"},"CamelThymeleafServletContext":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"jakarta.servlet.ServletContext","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The ServletContext for a web application.","constantName":"org.apache.camel.component.thymeleaf.ThymeleafConstants#THYMELEAF_SERVLET_CONTEXT"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"cacheable":{"index":2,"kind":"parameter","displayName":"Cacheable","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Whether templates have to be considered cacheable or not."},"cacheTimeToLive":{"index":3,"kind":"parameter","displayName":"Cache Time To Live","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The cache Time To Live for templates, expressed in milliseconds."},"checkExistence":{"index":4,"kind":"parameter","displayName":"Check Existence","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Whether a template resources will be checked for existence before being returned."},"contentCache":{"index":5,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"templateMode":{"index":6,"kind":"parameter","displayName":"Template Mode","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["HTML","XML","TEXT","JAVASCRIPT","CSS","RAW"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTML","description":"The template mode to be applied to templates."},"lazyStartProducer":{"index":7,"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."},"encoding":{"index":8,"kind":"parameter","displayName":"Encoding","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The character encoding to be used for reading template resources."},"order":{"index":9,"kind":"parameter","displayName":"Order","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"The order in which this template will be resolved as part of the resolver chain."},"prefix":{"index":10,"kind":"parameter","displayName":"Prefix","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An optional prefix added to template names to convert them into resource names."},"resolver":{"index":11,"kind":"parameter","displayName":"Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.thymeleaf.ThymeleafResolverType","enum":["CLASS_LOADER","DEFAULT","FILE","STRING","URL","WEB_APP"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CLASS_LOADER","description":"The type of resolver to be used by the template engine."},"suffix":{"index":12,"kind":"parameter","displayName":"Suffix","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"An optional suffix added to template names to convert them into resource names."}}} , -{"component":{"kind":"component","name":"tika","title":"Tika","description":"Parse documents and extract metadata and text using Apache Tika.","deprecated":false,"firstVersion":"2.19.0","label":"document,transformation","javaType":"org.apache.camel.component.tika.TikaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-tika","version":"4.8.1","scheme":"tika","extendsScheme":"","syntax":"tika:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.tika.TikaOperation","enum":["parse","detect"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tika.TikaConfiguration","configurationField":"tikaConfiguration","description":"Operation type"},"tikaParseOutputEncoding":{"index":1,"kind":"parameter","displayName":"Tika Parse Output Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tika.TikaConfiguration","configurationField":"tikaConfiguration","description":"Tika Parse Output Encoding"},"tikaParseOutputFormat":{"index":2,"kind":"parameter","displayName":"Tika Parse Output Format","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.tika.TikaParseOutputFormat","enum":["xml","html","text","textMain"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"xml","configurationClass":"org.apache.camel.component.tika.TikaConfiguration","configurationField":"tikaConfiguration","description":"Tika Output Format. Supported output formats. xml: Returns Parsed Content as XML. html: Returns Parsed Content as HTML. text: Returns Parsed Content as Text. textMain: Uses the boilerpipe library to automatically extract the main content from a web page."},"lazyStartProducer":{"index":3,"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."},"tikaConfig":{"index":4,"kind":"parameter","displayName":"Tika Config","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.tika.config.TikaConfig","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tika.TikaConfiguration","configurationField":"tikaConfiguration","description":"Tika Config"},"tikaConfigUri":{"index":5,"kind":"parameter","displayName":"Tika Config Uri","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tika.TikaConfiguration","configurationField":"tikaConfiguration","description":"Tika Config Url"}}} +{"component":{"kind":"component","name":"tika","title":"Tika","description":"Parse documents and extract metadata and text using Apache Tika.","deprecated":false,"firstVersion":"2.19.0","label":"document,transformation","javaType":"org.apache.camel.component.tika.TikaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-tika","version":"4.8.2","scheme":"tika","extendsScheme":"","syntax":"tika:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.tika.TikaOperation","enum":["parse","detect"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tika.TikaConfiguration","configurationField":"tikaConfiguration","description":"Operation type"},"tikaParseOutputEncoding":{"index":1,"kind":"parameter","displayName":"Tika Parse Output Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tika.TikaConfiguration","configurationField":"tikaConfiguration","description":"Tika Parse Output Encoding"},"tikaParseOutputFormat":{"index":2,"kind":"parameter","displayName":"Tika Parse Output Format","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.tika.TikaParseOutputFormat","enum":["xml","html","text","textMain"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"xml","configurationClass":"org.apache.camel.component.tika.TikaConfiguration","configurationField":"tikaConfiguration","description":"Tika Output Format. Supported output formats. xml: Returns Parsed Content as XML. html: Returns Parsed Content as HTML. text: Returns Parsed Content as Text. textMain: Uses the boilerpipe library to automatically extract the main content from a web page."},"lazyStartProducer":{"index":3,"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."},"tikaConfig":{"index":4,"kind":"parameter","displayName":"Tika Config","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.tika.config.TikaConfig","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tika.TikaConfiguration","configurationField":"tikaConfiguration","description":"Tika Config"},"tikaConfigUri":{"index":5,"kind":"parameter","displayName":"Tika Config Uri","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.tika.TikaConfiguration","configurationField":"tikaConfiguration","description":"Tika Config Url"}}} , -{"component":{"kind":"component","name":"timer","title":"Timer","description":"Generate messages in specified intervals using java.util.Timer.","deprecated":false,"firstVersion":"1.0.0","label":"core,scheduling","javaType":"org.apache.camel.component.timer.TimerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-timer","version":"4.8.1","scheme":"timer","extendsScheme":"","syntax":"timer:timerName","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":false},"headers":{"CamelTimerFiredTime":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The fired time","constantName":"org.apache.camel.component.timer.TimerConstants#HEADER_FIRED_TIME"},"CamelMessageTimestamp":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message","constantName":"org.apache.camel.component.timer.TimerConstants#HEADER_MESSAGE_TIMESTAMP"}},"properties":{"timerName":{"index":0,"kind":"path","displayName":"Timer Name","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the timer"},"delay":{"index":1,"kind":"parameter","displayName":"Delay","group":"consumer","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"The number of milliseconds to wait before the first event is generated. Should not be used in conjunction with the time option. The default value is 1000."},"fixedRate":{"index":2,"kind":"parameter","displayName":"Fixed Rate","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Events take place at approximately regular intervals, separated by the specified period."},"includeMetadata":{"index":3,"kind":"parameter","displayName":"Include Metadata","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to include metadata in the exchange such as fired time, timer name, timer count etc."},"period":{"index":4,"kind":"parameter","displayName":"Period","group":"consumer","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Generate periodic events every period. Must be zero or positive value. The default value is 1000."},"repeatCount":{"index":5,"kind":"parameter","displayName":"Repeat Count","group":"consumer","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Specifies a maximum limit for the number of fires. Therefore, if you set it to 1, the timer will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"daemon":{"index":9,"kind":"parameter","displayName":"Daemon","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether the thread associated with the timer endpoint runs as a daemon. The default value is true."},"pattern":{"index":10,"kind":"parameter","displayName":"Pattern","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Allows you to specify a custom Date pattern to use for setting the time option using URI syntax."},"synchronous":{"index":11,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"time":{"index":12,"kind":"parameter","displayName":"Time","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"A java.util.Date the first event should be generated. If using the URI, the pattern expected is: yyyy-MM-dd HH:mm:ss or yyyy-MM-dd'T'HH:mm:ss."},"timer":{"index":13,"kind":"parameter","displayName":"Timer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Timer","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom Timer"},"runLoggingLevel":{"index":14,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."}}} +{"component":{"kind":"component","name":"timer","title":"Timer","description":"Generate messages in specified intervals using java.util.Timer.","deprecated":false,"firstVersion":"1.0.0","label":"core,scheduling","javaType":"org.apache.camel.component.timer.TimerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-timer","version":"4.8.2","scheme":"timer","extendsScheme":"","syntax":"timer:timerName","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false,"remote":false},"headers":{"CamelTimerFiredTime":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The fired time","constantName":"org.apache.camel.component.timer.TimerConstants#HEADER_FIRED_TIME"},"CamelMessageTimestamp":{"index":1,"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message","constantName":"org.apache.camel.component.timer.TimerConstants#HEADER_MESSAGE_TIMESTAMP"}},"properties":{"timerName":{"index":0,"kind":"path","displayName":"Timer Name","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the timer"},"delay":{"index":1,"kind":"parameter","displayName":"Delay","group":"consumer","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"The number of milliseconds to wait before the first event is generated. Should not be used in conjunction with the time option. The default value is 1000."},"fixedRate":{"index":2,"kind":"parameter","displayName":"Fixed Rate","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Events take place at approximately regular intervals, separated by the specified period."},"includeMetadata":{"index":3,"kind":"parameter","displayName":"Include Metadata","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to include metadata in the exchange such as fired time, timer name, timer count etc."},"period":{"index":4,"kind":"parameter","displayName":"Period","group":"consumer","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Generate periodic events every period. Must be zero or positive value. The default value is 1000."},"repeatCount":{"index":5,"kind":"parameter","displayName":"Repeat Count","group":"consumer","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Specifies a maximum limit for the number of fires. Therefore, if you set it to 1, the timer will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"daemon":{"index":9,"kind":"parameter","displayName":"Daemon","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether the thread associated with the timer endpoint runs as a daemon. The default value is true."},"pattern":{"index":10,"kind":"parameter","displayName":"Pattern","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Allows you to specify a custom Date pattern to use for setting the time option using URI syntax."},"synchronous":{"index":11,"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"time":{"index":12,"kind":"parameter","displayName":"Time","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"A java.util.Date the first event should be generated. If using the URI, the pattern expected is: yyyy-MM-dd HH:mm:ss or yyyy-MM-dd'T'HH:mm:ss."},"timer":{"index":13,"kind":"parameter","displayName":"Timer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Timer","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom Timer"},"runLoggingLevel":{"index":14,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."}}} , -{"component":{"kind":"component","name":"twilio","title":"Twilio","description":"Interact with Twilio REST APIs using Twilio Java SDK.","deprecated":false,"firstVersion":"2.20.0","label":"api,messaging,cloud","javaType":"org.apache.camel.component.twilio.TwilioComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-twilio","version":"4.8.1","scheme":"twilio","extendsScheme":"","syntax":"twilio:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.twilio.internal.TwilioApiName","enum":["ACCOUNT","ADDRESS","APPLICATION","AVAILABLE_PHONE_NUMBER_COUNTRY","CALL","CONFERENCE","CONNECT_APP","INCOMING_PHONE_NUMBER","KEY","MESSAGE","NEW_KEY","NEW_SIGNING_KEY","NOTIFICATION","OUTGOING_CALLER_ID","QUEUE","RECORDING","SHORT_CODE","SIGNING_KEY","TOKEN","TRANSCRIPTION","VALIDATION_REQUEST","ADDRESS_DEPENDENT_PHONE_NUMBER","AVAILABLE_PHONE_NUMBER_COUNTRY_LOCAL","AVAILABLE_PHONE_NUMBER_COUNTRY_MOBILE","AVAILABLE_PHONE_NUMBER_COUNTRY_TOLL_FREE","CALL_NOTIFICATION","CALL_RECORDING","CONFERENCE_PARTICIPANT","INCOMING_PHONE_NUMBER_LOCAL","INCOMING_PHONE_NUMBER_MOBILE","INCOMING_PHONE_NUMBER_TOLL_FREE","MESSAGE_FEEDBACK","MESSAGE_MEDIA","QUEUE_MEMBER","RECORDING_ADD_ON_RESULT","RECORDING_TRANSCRIPTION","RECORDING_ADD_ON_RESULT_PAYLOAD","SIP_CREDENTIAL_LIST","SIP_DOMAIN","SIP_IP_ACCESS_CONTROL_LIST","SIP_CREDENTIAL_LIST_CREDENTIAL","SIP_DOMAIN_CREDENTIAL_LIST_MAPPING","SIP_DOMAIN_IP_ACCESS_CONTROL_LIST_MAPPING","SIP_IP_ACCESS_CONTROL_LIST_IP_ADDRESS","USAGE_RECORD","USAGE_TRIGGER","USAGE_RECORD_ALL_TIME","USAGE_RECORD_DAILY","USAGE_RECORD_LAST_MONTH","USAGE_RECORD_MONTHLY","USAGE_RECORD_THIS_MONTH","USAGE_RECORD_TODAY","USAGE_RECORD_YEARLY","USAGE_RECORD_YESTERDAY"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twilio.TwilioConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["create","delete","fetch","read","update"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twilio.TwilioConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"inBody":{"index":2,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"sendEmptyMessageWhenIdle":{"index":3,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":7,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":8,"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."},"backoffErrorThreshold":{"index":9,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":10,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":11,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":12,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":13,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":14,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":15,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":16,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":17,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":18,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":19,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":20,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":21,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":22,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}},"apis":{"account":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.AccountFetcher fetcher()","com.twilio.rest.api.v2010.AccountFetcher fetcher(String pathSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.AccountUpdater updater()","com.twilio.rest.api.v2010.AccountUpdater updater(String pathSid)"]}}},"address":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.AddressCreator creator(String customerName, String street, String city, String region, String postalCode, String isoCountry)","com.twilio.rest.api.v2010.account.AddressCreator creator(String pathAccountSid, String customerName, String street, String city, String region, String postalCode, String isoCountry)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.AddressDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.AddressDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.AddressFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.AddressFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.AddressReader reader()","com.twilio.rest.api.v2010.account.AddressReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.AddressUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.AddressUpdater updater(String pathSid)"]}}},"address-dependent-phone-number":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.address.DependentPhoneNumberReader reader(String pathAccountSid, String pathAddressSid)","com.twilio.rest.api.v2010.account.address.DependentPhoneNumberReader reader(String pathAddressSid)"]}}},"application":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ApplicationCreator creator()","com.twilio.rest.api.v2010.account.ApplicationCreator creator(String pathAccountSid)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ApplicationDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ApplicationDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ApplicationFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ApplicationFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ApplicationReader reader()","com.twilio.rest.api.v2010.account.ApplicationReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ApplicationUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ApplicationUpdater updater(String pathSid)"]}}},"available-phone-number-country":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryFetcher fetcher(String pathAccountSid, String pathCountryCode)","com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryFetcher fetcher(String pathCountryCode)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryReader reader()","com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryReader reader(String pathAccountSid)"]}}},"available-phone-number-country-local":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.availablephonenumbercountry.LocalReader reader(String pathAccountSid, String pathCountryCode)","com.twilio.rest.api.v2010.account.availablephonenumbercountry.LocalReader reader(String pathCountryCode)"]}}},"available-phone-number-country-mobile":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.availablephonenumbercountry.MobileReader reader(String pathAccountSid, String pathCountryCode)","com.twilio.rest.api.v2010.account.availablephonenumbercountry.MobileReader reader(String pathCountryCode)"]}}},"available-phone-number-country-toll-free":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.availablephonenumbercountry.TollFreeReader reader(String pathAccountSid, String pathCountryCode)","com.twilio.rest.api.v2010.account.availablephonenumbercountry.TollFreeReader reader(String pathCountryCode)"]}}},"call":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, String applicationSid)","com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, com.twilio.type.Twiml twiml)","com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, java.net.URI url)","com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, String applicationSid)","com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, com.twilio.type.Twiml twiml)","com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, java.net.URI url)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.CallDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.CallDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.CallFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.CallFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.CallReader reader()","com.twilio.rest.api.v2010.account.CallReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.CallUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.CallUpdater updater(String pathSid)"]}}},"call-notification":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.call.NotificationFetcher fetcher(String pathAccountSid, String pathCallSid, String pathSid)","com.twilio.rest.api.v2010.account.call.NotificationFetcher fetcher(String pathCallSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.call.NotificationReader reader(String pathAccountSid, String pathCallSid)","com.twilio.rest.api.v2010.account.call.NotificationReader reader(String pathCallSid)"]}}},"call-recording":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.call.RecordingCreator creator(String pathAccountSid, String pathCallSid)","com.twilio.rest.api.v2010.account.call.RecordingCreator creator(String pathCallSid)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.call.RecordingDeleter deleter(String pathAccountSid, String pathCallSid, String pathSid)","com.twilio.rest.api.v2010.account.call.RecordingDeleter deleter(String pathCallSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.call.RecordingFetcher fetcher(String pathAccountSid, String pathCallSid, String pathSid)","com.twilio.rest.api.v2010.account.call.RecordingFetcher fetcher(String pathCallSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.call.RecordingReader reader(String pathAccountSid, String pathCallSid)","com.twilio.rest.api.v2010.account.call.RecordingReader reader(String pathCallSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.call.RecordingUpdater updater(String pathAccountSid, String pathCallSid, String pathSid, com.twilio.rest.api.v2010.account.call.Recording$Status status)","com.twilio.rest.api.v2010.account.call.RecordingUpdater updater(String pathCallSid, String pathSid, com.twilio.rest.api.v2010.account.call.Recording$Status status)"]}}},"conference":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ConferenceFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ConferenceFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ConferenceReader reader()","com.twilio.rest.api.v2010.account.ConferenceReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ConferenceUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ConferenceUpdater updater(String pathSid)"]}}},"conference-participant":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.conference.ParticipantCreator creator(String pathAccountSid, String pathConferenceSid, com.twilio.type.Endpoint from, com.twilio.type.Endpoint to)","com.twilio.rest.api.v2010.account.conference.ParticipantCreator creator(String pathConferenceSid, com.twilio.type.Endpoint from, com.twilio.type.Endpoint to)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.conference.ParticipantDeleter deleter(String pathAccountSid, String pathConferenceSid, String pathCallSid)","com.twilio.rest.api.v2010.account.conference.ParticipantDeleter deleter(String pathConferenceSid, String pathCallSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.conference.ParticipantFetcher fetcher(String pathAccountSid, String pathConferenceSid, String pathCallSid)","com.twilio.rest.api.v2010.account.conference.ParticipantFetcher fetcher(String pathConferenceSid, String pathCallSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.conference.ParticipantReader reader(String pathAccountSid, String pathConferenceSid)","com.twilio.rest.api.v2010.account.conference.ParticipantReader reader(String pathConferenceSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.conference.ParticipantUpdater updater(String pathAccountSid, String pathConferenceSid, String pathCallSid)","com.twilio.rest.api.v2010.account.conference.ParticipantUpdater updater(String pathConferenceSid, String pathCallSid)"]}}},"connect-app":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ConnectAppDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ConnectAppDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ConnectAppFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ConnectAppFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ConnectAppReader reader()","com.twilio.rest.api.v2010.account.ConnectAppReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ConnectAppUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ConnectAppUpdater updater(String pathSid)"]}}},"incoming-phone-number":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String areaCode)","com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String pathAccountSid, String areaCode)","com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)","com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(com.twilio.type.PhoneNumber phoneNumber)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.IncomingPhoneNumberDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.IncomingPhoneNumberDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.IncomingPhoneNumberFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.IncomingPhoneNumberFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.IncomingPhoneNumberReader reader()","com.twilio.rest.api.v2010.account.IncomingPhoneNumberReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.IncomingPhoneNumberUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.IncomingPhoneNumberUpdater updater(String pathSid)"]}}},"incoming-phone-number-local":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.incomingphonenumber.LocalCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)","com.twilio.rest.api.v2010.account.incomingphonenumber.LocalCreator creator(com.twilio.type.PhoneNumber phoneNumber)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.incomingphonenumber.LocalReader reader()","com.twilio.rest.api.v2010.account.incomingphonenumber.LocalReader reader(String pathAccountSid)"]}}},"incoming-phone-number-mobile":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.incomingphonenumber.MobileCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)","com.twilio.rest.api.v2010.account.incomingphonenumber.MobileCreator creator(com.twilio.type.PhoneNumber phoneNumber)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.incomingphonenumber.MobileReader reader()","com.twilio.rest.api.v2010.account.incomingphonenumber.MobileReader reader(String pathAccountSid)"]}}},"incoming-phone-number-toll-free":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)","com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeCreator creator(com.twilio.type.PhoneNumber phoneNumber)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeReader reader()","com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeReader reader(String pathAccountSid)"]}}},"key":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.KeyDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.KeyDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.KeyFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.KeyFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.KeyReader reader()","com.twilio.rest.api.v2010.account.KeyReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.KeyUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.KeyUpdater updater(String pathSid)"]}}},"message":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, String messagingServiceSid, String body)","com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, String messagingServiceSid, java.util.List mediaUrl)","com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, String body)","com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, java.util.List mediaUrl)","com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, String messagingServiceSid, String body)","com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, String messagingServiceSid, java.util.List mediaUrl)","com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, String body)","com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, java.util.List mediaUrl)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.MessageDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.MessageDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.MessageFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.MessageFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.MessageReader reader()","com.twilio.rest.api.v2010.account.MessageReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.MessageUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.MessageUpdater updater(String pathSid)"]}}},"message-feedback":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.message.FeedbackCreator creator(String pathAccountSid, String pathMessageSid)","com.twilio.rest.api.v2010.account.message.FeedbackCreator creator(String pathMessageSid)"]}}},"message-media":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.message.MediaDeleter deleter(String pathAccountSid, String pathMessageSid, String pathSid)","com.twilio.rest.api.v2010.account.message.MediaDeleter deleter(String pathMessageSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.message.MediaFetcher fetcher(String pathAccountSid, String pathMessageSid, String pathSid)","com.twilio.rest.api.v2010.account.message.MediaFetcher fetcher(String pathMessageSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.message.MediaReader reader(String pathAccountSid, String pathMessageSid)","com.twilio.rest.api.v2010.account.message.MediaReader reader(String pathMessageSid)"]}}},"new-key":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.NewKeyCreator creator()","com.twilio.rest.api.v2010.account.NewKeyCreator creator(String pathAccountSid)"]}}},"new-signing-key":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.NewSigningKeyCreator creator()","com.twilio.rest.api.v2010.account.NewSigningKeyCreator creator(String pathAccountSid)"]}}},"notification":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.NotificationFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.NotificationFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.NotificationReader reader()","com.twilio.rest.api.v2010.account.NotificationReader reader(String pathAccountSid)"]}}},"outgoing-caller-id":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.OutgoingCallerIdDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.OutgoingCallerIdDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.OutgoingCallerIdFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.OutgoingCallerIdFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.OutgoingCallerIdReader reader()","com.twilio.rest.api.v2010.account.OutgoingCallerIdReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.OutgoingCallerIdUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.OutgoingCallerIdUpdater updater(String pathSid)"]}}},"queue":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.QueueCreator creator(String friendlyName)","com.twilio.rest.api.v2010.account.QueueCreator creator(String pathAccountSid, String friendlyName)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.QueueDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.QueueDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.QueueFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.QueueFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.QueueReader reader()","com.twilio.rest.api.v2010.account.QueueReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.QueueUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.QueueUpdater updater(String pathSid)"]}}},"queue-member":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.queue.MemberFetcher fetcher(String pathAccountSid, String pathQueueSid, String pathCallSid)","com.twilio.rest.api.v2010.account.queue.MemberFetcher fetcher(String pathQueueSid, String pathCallSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.queue.MemberReader reader(String pathAccountSid, String pathQueueSid)","com.twilio.rest.api.v2010.account.queue.MemberReader reader(String pathQueueSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.queue.MemberUpdater updater(String pathAccountSid, String pathQueueSid, String pathCallSid, java.net.URI url)","com.twilio.rest.api.v2010.account.queue.MemberUpdater updater(String pathQueueSid, String pathCallSid, java.net.URI url)"]}}},"recording":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.RecordingDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.RecordingDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.RecordingFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.RecordingFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.RecordingReader reader()","com.twilio.rest.api.v2010.account.RecordingReader reader(String pathAccountSid)"]}}},"recording-add-on-result":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.AddOnResultDeleter deleter(String pathAccountSid, String pathReferenceSid, String pathSid)","com.twilio.rest.api.v2010.account.recording.AddOnResultDeleter deleter(String pathReferenceSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.AddOnResultFetcher fetcher(String pathAccountSid, String pathReferenceSid, String pathSid)","com.twilio.rest.api.v2010.account.recording.AddOnResultFetcher fetcher(String pathReferenceSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.AddOnResultReader reader(String pathAccountSid, String pathReferenceSid)","com.twilio.rest.api.v2010.account.recording.AddOnResultReader reader(String pathReferenceSid)"]}}},"recording-add-on-result-payload":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.addonresult.PayloadDeleter deleter(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid, String pathSid)","com.twilio.rest.api.v2010.account.recording.addonresult.PayloadDeleter deleter(String pathReferenceSid, String pathAddOnResultSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.addonresult.PayloadFetcher fetcher(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid, String pathSid)","com.twilio.rest.api.v2010.account.recording.addonresult.PayloadFetcher fetcher(String pathReferenceSid, String pathAddOnResultSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.addonresult.PayloadReader reader(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid)","com.twilio.rest.api.v2010.account.recording.addonresult.PayloadReader reader(String pathReferenceSid, String pathAddOnResultSid)"]}}},"recording-transcription":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.TranscriptionDeleter deleter(String pathAccountSid, String pathRecordingSid, String pathSid)","com.twilio.rest.api.v2010.account.recording.TranscriptionDeleter deleter(String pathRecordingSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.TranscriptionFetcher fetcher(String pathAccountSid, String pathRecordingSid, String pathSid)","com.twilio.rest.api.v2010.account.recording.TranscriptionFetcher fetcher(String pathRecordingSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.TranscriptionReader reader(String pathAccountSid, String pathRecordingSid)","com.twilio.rest.api.v2010.account.recording.TranscriptionReader reader(String pathRecordingSid)"]}}},"short-code":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ShortCodeFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ShortCodeFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ShortCodeReader reader()","com.twilio.rest.api.v2010.account.ShortCodeReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ShortCodeUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ShortCodeUpdater updater(String pathSid)"]}}},"signing-key":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.SigningKeyDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.SigningKeyDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.SigningKeyFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.SigningKeyFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.SigningKeyReader reader()","com.twilio.rest.api.v2010.account.SigningKeyReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.SigningKeyUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.SigningKeyUpdater updater(String pathSid)"]}}},"sip-credential-list":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.CredentialListCreator creator(String friendlyName)","com.twilio.rest.api.v2010.account.sip.CredentialListCreator creator(String pathAccountSid, String friendlyName)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.CredentialListDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.CredentialListDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.CredentialListFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.CredentialListFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.CredentialListReader reader()","com.twilio.rest.api.v2010.account.sip.CredentialListReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.CredentialListUpdater updater(String pathAccountSid, String pathSid, String friendlyName)","com.twilio.rest.api.v2010.account.sip.CredentialListUpdater updater(String pathSid, String friendlyName)"]}}},"sip-credential-list-credential":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialCreator creator(String pathAccountSid, String pathCredentialListSid, String username, String password)","com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialCreator creator(String pathCredentialListSid, String username, String password)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialDeleter deleter(String pathAccountSid, String pathCredentialListSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialDeleter deleter(String pathCredentialListSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialFetcher fetcher(String pathAccountSid, String pathCredentialListSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialFetcher fetcher(String pathCredentialListSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialReader reader(String pathAccountSid, String pathCredentialListSid)","com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialReader reader(String pathCredentialListSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialUpdater updater(String pathAccountSid, String pathCredentialListSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialUpdater updater(String pathCredentialListSid, String pathSid)"]}}},"sip-domain":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.DomainCreator creator(String domainName)","com.twilio.rest.api.v2010.account.sip.DomainCreator creator(String pathAccountSid, String domainName)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.DomainDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.DomainDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.DomainFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.DomainFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.DomainReader reader()","com.twilio.rest.api.v2010.account.sip.DomainReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.DomainUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.DomainUpdater updater(String pathSid)"]}}},"sip-domain-credential-list-mapping":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingCreator creator(String pathAccountSid, String pathDomainSid, String credentialListSid)","com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingCreator creator(String pathDomainSid, String credentialListSid)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingDeleter deleter(String pathAccountSid, String pathDomainSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingDeleter deleter(String pathDomainSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingFetcher fetcher(String pathAccountSid, String pathDomainSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingFetcher fetcher(String pathDomainSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingReader reader(String pathAccountSid, String pathDomainSid)","com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingReader reader(String pathDomainSid)"]}}},"sip-domain-ip-access-control-list-mapping":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingCreator creator(String pathAccountSid, String pathDomainSid, String ipAccessControlListSid)","com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingCreator creator(String pathDomainSid, String ipAccessControlListSid)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingDeleter deleter(String pathAccountSid, String pathDomainSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingDeleter deleter(String pathDomainSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingFetcher fetcher(String pathAccountSid, String pathDomainSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingFetcher fetcher(String pathDomainSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingReader reader(String pathAccountSid, String pathDomainSid)","com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingReader reader(String pathDomainSid)"]}}},"sip-ip-access-control-list":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.IpAccessControlListCreator creator(String friendlyName)","com.twilio.rest.api.v2010.account.sip.IpAccessControlListCreator creator(String pathAccountSid, String friendlyName)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.IpAccessControlListDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.IpAccessControlListDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.IpAccessControlListFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.IpAccessControlListFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.IpAccessControlListReader reader()","com.twilio.rest.api.v2010.account.sip.IpAccessControlListReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.IpAccessControlListUpdater updater(String pathAccountSid, String pathSid, String friendlyName)","com.twilio.rest.api.v2010.account.sip.IpAccessControlListUpdater updater(String pathSid, String friendlyName)"]}}},"sip-ip-access-control-list-ip-address":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressCreator creator(String pathAccountSid, String pathIpAccessControlListSid, String friendlyName, String ipAddress)","com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressCreator creator(String pathIpAccessControlListSid, String friendlyName, String ipAddress)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressDeleter deleter(String pathAccountSid, String pathIpAccessControlListSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressDeleter deleter(String pathIpAccessControlListSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressFetcher fetcher(String pathAccountSid, String pathIpAccessControlListSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressFetcher fetcher(String pathIpAccessControlListSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressReader reader(String pathAccountSid, String pathIpAccessControlListSid)","com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressReader reader(String pathIpAccessControlListSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressUpdater updater(String pathAccountSid, String pathIpAccessControlListSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressUpdater updater(String pathIpAccessControlListSid, String pathSid)"]}}},"token":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.TokenCreator creator()","com.twilio.rest.api.v2010.account.TokenCreator creator(String pathAccountSid)"]}}},"transcription":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.TranscriptionDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.TranscriptionDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.TranscriptionFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.TranscriptionFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.TranscriptionReader reader()","com.twilio.rest.api.v2010.account.TranscriptionReader reader(String pathAccountSid)"]}}},"usage-record":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.RecordReader reader()","com.twilio.rest.api.v2010.account.usage.RecordReader reader(String pathAccountSid)"]}}},"usage-record-all-time":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.AllTimeReader reader()","com.twilio.rest.api.v2010.account.usage.record.AllTimeReader reader(String pathAccountSid)"]}}},"usage-record-daily":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.DailyReader reader()","com.twilio.rest.api.v2010.account.usage.record.DailyReader reader(String pathAccountSid)"]}}},"usage-record-last-month":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.LastMonthReader reader()","com.twilio.rest.api.v2010.account.usage.record.LastMonthReader reader(String pathAccountSid)"]}}},"usage-record-monthly":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.MonthlyReader reader()","com.twilio.rest.api.v2010.account.usage.record.MonthlyReader reader(String pathAccountSid)"]}}},"usage-record-this-month":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.ThisMonthReader reader()","com.twilio.rest.api.v2010.account.usage.record.ThisMonthReader reader(String pathAccountSid)"]}}},"usage-record-today":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.TodayReader reader()","com.twilio.rest.api.v2010.account.usage.record.TodayReader reader(String pathAccountSid)"]}}},"usage-record-yearly":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.YearlyReader reader()","com.twilio.rest.api.v2010.account.usage.record.YearlyReader reader(String pathAccountSid)"]}}},"usage-record-yesterday":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.YesterdayReader reader()","com.twilio.rest.api.v2010.account.usage.record.YesterdayReader reader(String pathAccountSid)"]}}},"usage-trigger":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.TriggerCreator creator(String pathAccountSid, java.net.URI callbackUrl, String triggerValue, com.twilio.rest.api.v2010.account.usage.Trigger$UsageCategory usageCategory)","com.twilio.rest.api.v2010.account.usage.TriggerCreator creator(java.net.URI callbackUrl, String triggerValue, com.twilio.rest.api.v2010.account.usage.Trigger$UsageCategory usageCategory)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.TriggerDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.usage.TriggerDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.TriggerFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.usage.TriggerFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.TriggerReader reader()","com.twilio.rest.api.v2010.account.usage.TriggerReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.TriggerUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.usage.TriggerUpdater updater(String pathSid)"]}}},"validation-request":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ValidationRequestCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)","com.twilio.rest.api.v2010.account.ValidationRequestCreator creator(com.twilio.type.PhoneNumber phoneNumber)"]}}}},"apiProperties":{"account":{"methods":{"fetcher":{"properties":{"pathSid":{"index":0,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathSid":{"index":0,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"address":{"methods":{"creator":{"properties":{"city":{"index":0,"kind":"parameter","displayName":"City","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"customerName":{"index":1,"kind":"parameter","displayName":"Customer Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"isoCountry":{"index":2,"kind":"parameter","displayName":"Iso Country","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":3,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"postalCode":{"index":4,"kind":"parameter","displayName":"Postal Code","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"street":{"index":6,"kind":"parameter","displayName":"Street","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"address-dependent-phone-number":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAddressSid":{"index":2,"kind":"parameter","displayName":"Path Address Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"application":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"available-phone-number-country":{"methods":{"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCountryCode":{"index":1,"kind":"parameter","displayName":"Path Country Code","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"available-phone-number-country-local":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCountryCode":{"index":2,"kind":"parameter","displayName":"Path Country Code","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"available-phone-number-country-mobile":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCountryCode":{"index":2,"kind":"parameter","displayName":"Path Country Code","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"available-phone-number-country-toll-free":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCountryCode":{"index":2,"kind":"parameter","displayName":"Path Country Code","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"call":{"methods":{"creator":{"properties":{"applicationSid":{"index":0,"kind":"parameter","displayName":"Application Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"from":{"index":1,"kind":"parameter","displayName":"From","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.Endpoint","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":2,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"to":{"index":3,"kind":"parameter","displayName":"To","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.Endpoint","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"twiml":{"index":4,"kind":"parameter","displayName":"Twiml","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.Twiml","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"url":{"index":5,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"call-notification":{"methods":{"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":2,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":2,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"call-recording":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":2,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":2,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":2,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":2,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":2,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"status":{"index":4,"kind":"parameter","displayName":"Status","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.rest.api.v2010.account.call.Recording.Status","enum":["in-progress","paused","stopped","processing","completed","absent"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"conference":{"methods":{"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"conference-participant":{"methods":{"creator":{"properties":{"from":{"index":0,"kind":"parameter","displayName":"From","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.Endpoint","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathConferenceSid":{"index":3,"kind":"parameter","displayName":"Path Conference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"to":{"index":4,"kind":"parameter","displayName":"To","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.Endpoint","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":1,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathConferenceSid":{"index":3,"kind":"parameter","displayName":"Path Conference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":1,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathConferenceSid":{"index":3,"kind":"parameter","displayName":"Path Conference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathConferenceSid":{"index":2,"kind":"parameter","displayName":"Path Conference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":1,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathConferenceSid":{"index":3,"kind":"parameter","displayName":"Path Conference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"connect-app":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"incoming-phone-number":{"methods":{"creator":{"properties":{"areaCode":{"index":0,"kind":"parameter","displayName":"Area Code","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"phoneNumber":{"index":2,"kind":"parameter","displayName":"Phone Number","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.PhoneNumber","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"incoming-phone-number-local":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"phoneNumber":{"index":1,"kind":"parameter","displayName":"Phone Number","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.PhoneNumber","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"incoming-phone-number-mobile":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"phoneNumber":{"index":1,"kind":"parameter","displayName":"Phone Number","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.PhoneNumber","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"incoming-phone-number-toll-free":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"phoneNumber":{"index":1,"kind":"parameter","displayName":"Phone Number","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.PhoneNumber","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"key":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"message":{"methods":{"creator":{"properties":{"body":{"index":0,"kind":"parameter","displayName":"Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"from":{"index":1,"kind":"parameter","displayName":"From","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.PhoneNumber","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"mediaUrl":{"index":2,"kind":"parameter","displayName":"Media Url","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"messagingServiceSid":{"index":3,"kind":"parameter","displayName":"Messaging Service Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":4,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"to":{"index":5,"kind":"parameter","displayName":"To","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.PhoneNumber","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"message-feedback":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathMessageSid":{"index":2,"kind":"parameter","displayName":"Path Message Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"message-media":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathMessageSid":{"index":2,"kind":"parameter","displayName":"Path Message Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathMessageSid":{"index":2,"kind":"parameter","displayName":"Path Message Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathMessageSid":{"index":2,"kind":"parameter","displayName":"Path Message Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"new-key":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"new-signing-key":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"notification":{"methods":{"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"outgoing-caller-id":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"queue":{"methods":{"creator":{"properties":{"friendlyName":{"index":0,"kind":"parameter","displayName":"Friendly Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"queue-member":{"methods":{"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":1,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathQueueSid":{"index":3,"kind":"parameter","displayName":"Path Queue Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathQueueSid":{"index":2,"kind":"parameter","displayName":"Path Queue Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":1,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathQueueSid":{"index":3,"kind":"parameter","displayName":"Path Queue Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"url":{"index":4,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"recording":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"recording-add-on-result":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathReferenceSid":{"index":2,"kind":"parameter","displayName":"Path Reference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathReferenceSid":{"index":2,"kind":"parameter","displayName":"Path Reference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathReferenceSid":{"index":2,"kind":"parameter","displayName":"Path Reference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"recording-add-on-result-payload":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAddOnResultSid":{"index":2,"kind":"parameter","displayName":"Path Add On Result Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathReferenceSid":{"index":4,"kind":"parameter","displayName":"Path Reference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":5,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAddOnResultSid":{"index":2,"kind":"parameter","displayName":"Path Add On Result Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathReferenceSid":{"index":4,"kind":"parameter","displayName":"Path Reference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":5,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAddOnResultSid":{"index":2,"kind":"parameter","displayName":"Path Add On Result Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathReferenceSid":{"index":4,"kind":"parameter","displayName":"Path Reference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"recording-transcription":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathRecordingSid":{"index":2,"kind":"parameter","displayName":"Path Recording Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathRecordingSid":{"index":2,"kind":"parameter","displayName":"Path Recording Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathRecordingSid":{"index":2,"kind":"parameter","displayName":"Path Recording Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"short-code":{"methods":{"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"signing-key":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"sip-credential-list":{"methods":{"creator":{"properties":{"friendlyName":{"index":0,"kind":"parameter","displayName":"Friendly Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"friendlyName":{"index":0,"kind":"parameter","displayName":"Friendly Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":2,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"sip-credential-list-credential":{"methods":{"creator":{"properties":{"password":{"index":0,"kind":"parameter","displayName":"Password","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCredentialListSid":{"index":3,"kind":"parameter","displayName":"Path Credential List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"username":{"index":4,"kind":"parameter","displayName":"Username","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCredentialListSid":{"index":2,"kind":"parameter","displayName":"Path Credential List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCredentialListSid":{"index":2,"kind":"parameter","displayName":"Path Credential List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCredentialListSid":{"index":2,"kind":"parameter","displayName":"Path Credential List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCredentialListSid":{"index":2,"kind":"parameter","displayName":"Path Credential List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"sip-domain":{"methods":{"creator":{"properties":{"domainName":{"index":0,"kind":"parameter","displayName":"Domain Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"sip-domain-credential-list-mapping":{"methods":{"creator":{"properties":{"credentialListSid":{"index":0,"kind":"parameter","displayName":"Credential List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":3,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":2,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":2,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":2,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"sip-domain-ip-access-control-list-mapping":{"methods":{"creator":{"properties":{"ipAccessControlListSid":{"index":0,"kind":"parameter","displayName":"Ip Access Control List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":3,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":2,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":2,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":2,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"sip-ip-access-control-list":{"methods":{"creator":{"properties":{"friendlyName":{"index":0,"kind":"parameter","displayName":"Friendly Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"friendlyName":{"index":0,"kind":"parameter","displayName":"Friendly Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":2,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"sip-ip-access-control-list-ip-address":{"methods":{"creator":{"properties":{"friendlyName":{"index":0,"kind":"parameter","displayName":"Friendly Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ipAddress":{"index":1,"kind":"parameter","displayName":"Ip Address","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":2,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathIpAccessControlListSid":{"index":4,"kind":"parameter","displayName":"Path Ip Access Control List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathIpAccessControlListSid":{"index":2,"kind":"parameter","displayName":"Path Ip Access Control List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathIpAccessControlListSid":{"index":2,"kind":"parameter","displayName":"Path Ip Access Control List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathIpAccessControlListSid":{"index":2,"kind":"parameter","displayName":"Path Ip Access Control List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathIpAccessControlListSid":{"index":2,"kind":"parameter","displayName":"Path Ip Access Control List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"token":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"transcription":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-all-time":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-daily":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-last-month":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-monthly":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-this-month":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-today":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-yearly":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-yesterday":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-trigger":{"methods":{"creator":{"properties":{"callbackUrl":{"index":0,"kind":"parameter","displayName":"Callback Url","group":"common","label":"","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"triggerValue":{"index":2,"kind":"parameter","displayName":"Trigger Value","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"usageCategory":{"index":3,"kind":"parameter","displayName":"Usage Category","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.rest.api.v2010.account.usage.Trigger.UsageCategory","enum":["a2p-registration-fees","agent-conference","amazon-polly","answering-machine-detection","authy-authentications","authy-calls-outbound","authy-monthly-fees","authy-phone-intelligence","authy-phone-verifications","authy-sms-outbound","call-progess-events","calleridlookups","calls","calls-client","calls-globalconference","calls-inbound","calls-inbound-local","calls-inbound-mobile","calls-inbound-tollfree","calls-outbound","calls-pay-verb-transactions","calls-recordings","calls-sip","calls-sip-inbound","calls-sip-outbound","calls-transfers","carrier-lookups","conversations","conversations-api-requests","conversations-conversation-events","conversations-endpoint-connectivity","conversations-events","conversations-participant-events","conversations-participants","cps","flex-usage","fraud-lookups","group-rooms","group-rooms-data-track","group-rooms-encrypted-media-recorded","group-rooms-media-downloaded","group-rooms-media-recorded","group-rooms-media-routed","group-rooms-media-stored","group-rooms-participant-minutes","group-rooms-recorded-minutes","imp-v1-usage","lookups","marketplace","marketplace-algorithmia-named-entity-recognition","marketplace-cadence-transcription","marketplace-cadence-translation","marketplace-capio-speech-to-text","marketplace-convriza-ababa","marketplace-deepgram-phrase-detector","marketplace-digital-segment-business-info","marketplace-facebook-offline-conversions","marketplace-google-speech-to-text","marketplace-ibm-watson-message-insights","marketplace-ibm-watson-message-sentiment","marketplace-ibm-watson-recording-analysis","marketplace-ibm-watson-tone-analyzer","marketplace-icehook-systems-scout","marketplace-infogroup-dataaxle-bizinfo","marketplace-keen-io-contact-center-analytics","marketplace-marchex-cleancall","marketplace-marchex-sentiment-analysis-for-sms","marketplace-marketplace-nextcaller-social-id","marketplace-mobile-commons-opt-out-classifier","marketplace-nexiwave-voicemail-to-text","marketplace-nextcaller-advanced-caller-identification","marketplace-nomorobo-spam-score","marketplace-payfone-tcpa-compliance","marketplace-remeeting-automatic-speech-recognition","marketplace-tcpa-defense-solutions-blacklist-feed","marketplace-telo-opencnam","marketplace-truecnam-true-spam","marketplace-twilio-caller-name-lookup-us","marketplace-twilio-carrier-information-lookup","marketplace-voicebase-pci","marketplace-voicebase-transcription","marketplace-voicebase-transcription-custom-vocabulary","marketplace-whitepages-pro-caller-identification","marketplace-whitepages-pro-phone-intelligence","marketplace-whitepages-pro-phone-reputation","marketplace-wolfarm-spoken-results","marketplace-wolfram-short-answer","marketplace-ytica-contact-center-reporting-analytics","mediastorage","mms","mms-inbound","mms-inbound-longcode","mms-inbound-shortcode","mms-messages-carrierfees","mms-outbound","mms-outbound-longcode","mms-outbound-shortcode","monitor-reads","monitor-storage","monitor-writes","notify","notify-actions-attempts","notify-channels","number-format-lookups","pchat","pchat-users","peer-to-peer-rooms-participant-minutes","pfax","pfax-minutes","pfax-minutes-inbound","pfax-minutes-outbound","pfax-pages","phonenumbers","phonenumbers-cps","phonenumbers-emergency","phonenumbers-local","phonenumbers-mobile","phonenumbers-setups","phonenumbers-tollfree","premiumsupport","proxy","proxy-active-sessions","pstnconnectivity","pv","pv-composition-media-downloaded","pv-composition-media-encrypted","pv-composition-media-stored","pv-composition-minutes","pv-recording-compositions","pv-room-participants","pv-room-participants-au1","pv-room-participants-br1","pv-room-participants-ie1","pv-room-participants-jp1","pv-room-participants-sg1","pv-room-participants-us1","pv-room-participants-us2","pv-rooms","pv-sip-endpoint-registrations","recordings","recordingstorage","rooms-group-bandwidth","rooms-group-minutes","rooms-peer-to-peer-minutes","shortcodes","shortcodes-customerowned","shortcodes-mms-enablement","shortcodes-mps","shortcodes-random","shortcodes-uk","shortcodes-vanity","small-group-rooms","small-group-rooms-data-track","small-group-rooms-participant-minutes","sms","sms-inbound","sms-inbound-longcode","sms-inbound-shortcode","sms-messages-carrierfees","sms-messages-features","sms-messages-features-senderid","sms-outbound","sms-outbound-content-inspection","sms-outbound-longcode","sms-outbound-shortcode","speech-recognition","studio-engagements","sync","sync-actions","sync-endpoint-hours","sync-endpoint-hours-above-daily-cap","taskrouter-tasks","totalprice","transcriptions","trunking-cps","trunking-emergency-calls","trunking-origination","trunking-origination-local","trunking-origination-mobile","trunking-origination-tollfree","trunking-recordings","trunking-secure","trunking-termination","tts-google","turnmegabytes","turnmegabytes-australia","turnmegabytes-brasil","turnmegabytes-germany","turnmegabytes-india","turnmegabytes-ireland","turnmegabytes-japan","turnmegabytes-singapore","turnmegabytes-useast","turnmegabytes-uswest","twilio-interconnect","verify-push","verify-totp","verify-whatsapp-conversations-business-initiated","video-recordings","virtual-agent","voice-insights","voice-insights-client-insights-on-demand-minute","voice-insights-ptsn-insights-on-demand-minute","voice-insights-sip-interface-insights-on-demand-minute","voice-insights-sip-trunking-insights-on-demand-minute","voice-intelligence","voice-intelligence-transcription","voice-intelligence-operators","wireless","wireless-orders","wireless-orders-artwork","wireless-orders-bulk","wireless-orders-esim","wireless-orders-starter","wireless-usage","wireless-usage-commands","wireless-usage-commands-africa","wireless-usage-commands-asia","wireless-usage-commands-centralandsouthamerica","wireless-usage-commands-europe","wireless-usage-commands-home","wireless-usage-commands-northamerica","wireless-usage-commands-oceania","wireless-usage-commands-roaming","wireless-usage-data","wireless-usage-data-africa","wireless-usage-data-asia","wireless-usage-data-centralandsouthamerica","wireless-usage-data-custom-additionalmb","wireless-usage-data-custom-first5mb","wireless-usage-data-domestic-roaming","wireless-usage-data-europe","wireless-usage-data-individual-additionalgb","wireless-usage-data-individual-firstgb","wireless-usage-data-international-roaming-canada","wireless-usage-data-international-roaming-india","wireless-usage-data-international-roaming-mexico","wireless-usage-data-northamerica","wireless-usage-data-oceania","wireless-usage-data-pooled","wireless-usage-data-pooled-downlink","wireless-usage-data-pooled-uplink","wireless-usage-mrc","wireless-usage-mrc-custom","wireless-usage-mrc-individual","wireless-usage-mrc-pooled","wireless-usage-mrc-suspended","wireless-usage-sms","wireless-usage-voice"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"validation-request":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"phoneNumber":{"index":2,"kind":"parameter","displayName":"Phone Number","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.PhoneNumber","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}}}} +{"component":{"kind":"component","name":"twilio","title":"Twilio","description":"Interact with Twilio REST APIs using Twilio Java SDK.","deprecated":false,"firstVersion":"2.20.0","label":"api,messaging,cloud","javaType":"org.apache.camel.component.twilio.TwilioComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-twilio","version":"4.8.2","scheme":"twilio","extendsScheme":"","syntax":"twilio:apiName/methodName","async":false,"api":true,"apiSyntax":"apiName/methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"apiName":{"index":0,"kind":"path","displayName":"Api Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.twilio.internal.TwilioApiName","enum":["ACCOUNT","ADDRESS","APPLICATION","AVAILABLE_PHONE_NUMBER_COUNTRY","CALL","CONFERENCE","CONNECT_APP","INCOMING_PHONE_NUMBER","KEY","MESSAGE","NEW_KEY","NEW_SIGNING_KEY","NOTIFICATION","OUTGOING_CALLER_ID","QUEUE","RECORDING","SHORT_CODE","SIGNING_KEY","TOKEN","TRANSCRIPTION","VALIDATION_REQUEST","ADDRESS_DEPENDENT_PHONE_NUMBER","AVAILABLE_PHONE_NUMBER_COUNTRY_LOCAL","AVAILABLE_PHONE_NUMBER_COUNTRY_MOBILE","AVAILABLE_PHONE_NUMBER_COUNTRY_TOLL_FREE","CALL_NOTIFICATION","CALL_RECORDING","CONFERENCE_PARTICIPANT","INCOMING_PHONE_NUMBER_LOCAL","INCOMING_PHONE_NUMBER_MOBILE","INCOMING_PHONE_NUMBER_TOLL_FREE","MESSAGE_FEEDBACK","MESSAGE_MEDIA","QUEUE_MEMBER","RECORDING_ADD_ON_RESULT","RECORDING_TRANSCRIPTION","RECORDING_ADD_ON_RESULT_PAYLOAD","SIP_CREDENTIAL_LIST","SIP_DOMAIN","SIP_IP_ACCESS_CONTROL_LIST","SIP_CREDENTIAL_LIST_CREDENTIAL","SIP_DOMAIN_CREDENTIAL_LIST_MAPPING","SIP_DOMAIN_IP_ACCESS_CONTROL_LIST_MAPPING","SIP_IP_ACCESS_CONTROL_LIST_IP_ADDRESS","USAGE_RECORD","USAGE_TRIGGER","USAGE_RECORD_ALL_TIME","USAGE_RECORD_DAILY","USAGE_RECORD_LAST_MONTH","USAGE_RECORD_MONTHLY","USAGE_RECORD_THIS_MONTH","USAGE_RECORD_TODAY","USAGE_RECORD_YEARLY","USAGE_RECORD_YESTERDAY"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twilio.TwilioConfiguration","configurationField":"configuration","description":"What kind of operation to perform"},"methodName":{"index":1,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["create","delete","fetch","read","update"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twilio.TwilioConfiguration","configurationField":"configuration","description":"What sub operation to use for the selected operation"},"inBody":{"index":2,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"sendEmptyMessageWhenIdle":{"index":3,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":7,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":8,"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."},"backoffErrorThreshold":{"index":9,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":10,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":11,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":12,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":13,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":14,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":15,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":16,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":17,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":18,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":19,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":20,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":21,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":22,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}},"apis":{"account":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.AccountFetcher fetcher()","com.twilio.rest.api.v2010.AccountFetcher fetcher(String pathSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.AccountUpdater updater()","com.twilio.rest.api.v2010.AccountUpdater updater(String pathSid)"]}}},"address":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.AddressCreator creator(String customerName, String street, String city, String region, String postalCode, String isoCountry)","com.twilio.rest.api.v2010.account.AddressCreator creator(String pathAccountSid, String customerName, String street, String city, String region, String postalCode, String isoCountry)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.AddressDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.AddressDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.AddressFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.AddressFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.AddressReader reader()","com.twilio.rest.api.v2010.account.AddressReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.AddressUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.AddressUpdater updater(String pathSid)"]}}},"address-dependent-phone-number":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.address.DependentPhoneNumberReader reader(String pathAccountSid, String pathAddressSid)","com.twilio.rest.api.v2010.account.address.DependentPhoneNumberReader reader(String pathAddressSid)"]}}},"application":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ApplicationCreator creator()","com.twilio.rest.api.v2010.account.ApplicationCreator creator(String pathAccountSid)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ApplicationDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ApplicationDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ApplicationFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ApplicationFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ApplicationReader reader()","com.twilio.rest.api.v2010.account.ApplicationReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ApplicationUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ApplicationUpdater updater(String pathSid)"]}}},"available-phone-number-country":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryFetcher fetcher(String pathAccountSid, String pathCountryCode)","com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryFetcher fetcher(String pathCountryCode)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryReader reader()","com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryReader reader(String pathAccountSid)"]}}},"available-phone-number-country-local":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.availablephonenumbercountry.LocalReader reader(String pathAccountSid, String pathCountryCode)","com.twilio.rest.api.v2010.account.availablephonenumbercountry.LocalReader reader(String pathCountryCode)"]}}},"available-phone-number-country-mobile":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.availablephonenumbercountry.MobileReader reader(String pathAccountSid, String pathCountryCode)","com.twilio.rest.api.v2010.account.availablephonenumbercountry.MobileReader reader(String pathCountryCode)"]}}},"available-phone-number-country-toll-free":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.availablephonenumbercountry.TollFreeReader reader(String pathAccountSid, String pathCountryCode)","com.twilio.rest.api.v2010.account.availablephonenumbercountry.TollFreeReader reader(String pathCountryCode)"]}}},"call":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, String applicationSid)","com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, com.twilio.type.Twiml twiml)","com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, java.net.URI url)","com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, String applicationSid)","com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, com.twilio.type.Twiml twiml)","com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, java.net.URI url)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.CallDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.CallDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.CallFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.CallFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.CallReader reader()","com.twilio.rest.api.v2010.account.CallReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.CallUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.CallUpdater updater(String pathSid)"]}}},"call-notification":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.call.NotificationFetcher fetcher(String pathAccountSid, String pathCallSid, String pathSid)","com.twilio.rest.api.v2010.account.call.NotificationFetcher fetcher(String pathCallSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.call.NotificationReader reader(String pathAccountSid, String pathCallSid)","com.twilio.rest.api.v2010.account.call.NotificationReader reader(String pathCallSid)"]}}},"call-recording":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.call.RecordingCreator creator(String pathAccountSid, String pathCallSid)","com.twilio.rest.api.v2010.account.call.RecordingCreator creator(String pathCallSid)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.call.RecordingDeleter deleter(String pathAccountSid, String pathCallSid, String pathSid)","com.twilio.rest.api.v2010.account.call.RecordingDeleter deleter(String pathCallSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.call.RecordingFetcher fetcher(String pathAccountSid, String pathCallSid, String pathSid)","com.twilio.rest.api.v2010.account.call.RecordingFetcher fetcher(String pathCallSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.call.RecordingReader reader(String pathAccountSid, String pathCallSid)","com.twilio.rest.api.v2010.account.call.RecordingReader reader(String pathCallSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.call.RecordingUpdater updater(String pathAccountSid, String pathCallSid, String pathSid, com.twilio.rest.api.v2010.account.call.Recording$Status status)","com.twilio.rest.api.v2010.account.call.RecordingUpdater updater(String pathCallSid, String pathSid, com.twilio.rest.api.v2010.account.call.Recording$Status status)"]}}},"conference":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ConferenceFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ConferenceFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ConferenceReader reader()","com.twilio.rest.api.v2010.account.ConferenceReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ConferenceUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ConferenceUpdater updater(String pathSid)"]}}},"conference-participant":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.conference.ParticipantCreator creator(String pathAccountSid, String pathConferenceSid, com.twilio.type.Endpoint from, com.twilio.type.Endpoint to)","com.twilio.rest.api.v2010.account.conference.ParticipantCreator creator(String pathConferenceSid, com.twilio.type.Endpoint from, com.twilio.type.Endpoint to)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.conference.ParticipantDeleter deleter(String pathAccountSid, String pathConferenceSid, String pathCallSid)","com.twilio.rest.api.v2010.account.conference.ParticipantDeleter deleter(String pathConferenceSid, String pathCallSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.conference.ParticipantFetcher fetcher(String pathAccountSid, String pathConferenceSid, String pathCallSid)","com.twilio.rest.api.v2010.account.conference.ParticipantFetcher fetcher(String pathConferenceSid, String pathCallSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.conference.ParticipantReader reader(String pathAccountSid, String pathConferenceSid)","com.twilio.rest.api.v2010.account.conference.ParticipantReader reader(String pathConferenceSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.conference.ParticipantUpdater updater(String pathAccountSid, String pathConferenceSid, String pathCallSid)","com.twilio.rest.api.v2010.account.conference.ParticipantUpdater updater(String pathConferenceSid, String pathCallSid)"]}}},"connect-app":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ConnectAppDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ConnectAppDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ConnectAppFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ConnectAppFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ConnectAppReader reader()","com.twilio.rest.api.v2010.account.ConnectAppReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ConnectAppUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ConnectAppUpdater updater(String pathSid)"]}}},"incoming-phone-number":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String areaCode)","com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String pathAccountSid, String areaCode)","com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)","com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(com.twilio.type.PhoneNumber phoneNumber)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.IncomingPhoneNumberDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.IncomingPhoneNumberDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.IncomingPhoneNumberFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.IncomingPhoneNumberFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.IncomingPhoneNumberReader reader()","com.twilio.rest.api.v2010.account.IncomingPhoneNumberReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.IncomingPhoneNumberUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.IncomingPhoneNumberUpdater updater(String pathSid)"]}}},"incoming-phone-number-local":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.incomingphonenumber.LocalCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)","com.twilio.rest.api.v2010.account.incomingphonenumber.LocalCreator creator(com.twilio.type.PhoneNumber phoneNumber)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.incomingphonenumber.LocalReader reader()","com.twilio.rest.api.v2010.account.incomingphonenumber.LocalReader reader(String pathAccountSid)"]}}},"incoming-phone-number-mobile":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.incomingphonenumber.MobileCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)","com.twilio.rest.api.v2010.account.incomingphonenumber.MobileCreator creator(com.twilio.type.PhoneNumber phoneNumber)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.incomingphonenumber.MobileReader reader()","com.twilio.rest.api.v2010.account.incomingphonenumber.MobileReader reader(String pathAccountSid)"]}}},"incoming-phone-number-toll-free":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)","com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeCreator creator(com.twilio.type.PhoneNumber phoneNumber)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeReader reader()","com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeReader reader(String pathAccountSid)"]}}},"key":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.KeyDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.KeyDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.KeyFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.KeyFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.KeyReader reader()","com.twilio.rest.api.v2010.account.KeyReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.KeyUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.KeyUpdater updater(String pathSid)"]}}},"message":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, String messagingServiceSid, String body)","com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, String messagingServiceSid, java.util.List mediaUrl)","com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, String body)","com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, java.util.List mediaUrl)","com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, String messagingServiceSid, String body)","com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, String messagingServiceSid, java.util.List mediaUrl)","com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, String body)","com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, java.util.List mediaUrl)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.MessageDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.MessageDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.MessageFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.MessageFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.MessageReader reader()","com.twilio.rest.api.v2010.account.MessageReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.MessageUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.MessageUpdater updater(String pathSid)"]}}},"message-feedback":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.message.FeedbackCreator creator(String pathAccountSid, String pathMessageSid)","com.twilio.rest.api.v2010.account.message.FeedbackCreator creator(String pathMessageSid)"]}}},"message-media":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.message.MediaDeleter deleter(String pathAccountSid, String pathMessageSid, String pathSid)","com.twilio.rest.api.v2010.account.message.MediaDeleter deleter(String pathMessageSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.message.MediaFetcher fetcher(String pathAccountSid, String pathMessageSid, String pathSid)","com.twilio.rest.api.v2010.account.message.MediaFetcher fetcher(String pathMessageSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.message.MediaReader reader(String pathAccountSid, String pathMessageSid)","com.twilio.rest.api.v2010.account.message.MediaReader reader(String pathMessageSid)"]}}},"new-key":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.NewKeyCreator creator()","com.twilio.rest.api.v2010.account.NewKeyCreator creator(String pathAccountSid)"]}}},"new-signing-key":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.NewSigningKeyCreator creator()","com.twilio.rest.api.v2010.account.NewSigningKeyCreator creator(String pathAccountSid)"]}}},"notification":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.NotificationFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.NotificationFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.NotificationReader reader()","com.twilio.rest.api.v2010.account.NotificationReader reader(String pathAccountSid)"]}}},"outgoing-caller-id":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.OutgoingCallerIdDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.OutgoingCallerIdDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.OutgoingCallerIdFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.OutgoingCallerIdFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.OutgoingCallerIdReader reader()","com.twilio.rest.api.v2010.account.OutgoingCallerIdReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.OutgoingCallerIdUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.OutgoingCallerIdUpdater updater(String pathSid)"]}}},"queue":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.QueueCreator creator(String friendlyName)","com.twilio.rest.api.v2010.account.QueueCreator creator(String pathAccountSid, String friendlyName)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.QueueDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.QueueDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.QueueFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.QueueFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.QueueReader reader()","com.twilio.rest.api.v2010.account.QueueReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.QueueUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.QueueUpdater updater(String pathSid)"]}}},"queue-member":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.queue.MemberFetcher fetcher(String pathAccountSid, String pathQueueSid, String pathCallSid)","com.twilio.rest.api.v2010.account.queue.MemberFetcher fetcher(String pathQueueSid, String pathCallSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.queue.MemberReader reader(String pathAccountSid, String pathQueueSid)","com.twilio.rest.api.v2010.account.queue.MemberReader reader(String pathQueueSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.queue.MemberUpdater updater(String pathAccountSid, String pathQueueSid, String pathCallSid, java.net.URI url)","com.twilio.rest.api.v2010.account.queue.MemberUpdater updater(String pathQueueSid, String pathCallSid, java.net.URI url)"]}}},"recording":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.RecordingDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.RecordingDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.RecordingFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.RecordingFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.RecordingReader reader()","com.twilio.rest.api.v2010.account.RecordingReader reader(String pathAccountSid)"]}}},"recording-add-on-result":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.AddOnResultDeleter deleter(String pathAccountSid, String pathReferenceSid, String pathSid)","com.twilio.rest.api.v2010.account.recording.AddOnResultDeleter deleter(String pathReferenceSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.AddOnResultFetcher fetcher(String pathAccountSid, String pathReferenceSid, String pathSid)","com.twilio.rest.api.v2010.account.recording.AddOnResultFetcher fetcher(String pathReferenceSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.AddOnResultReader reader(String pathAccountSid, String pathReferenceSid)","com.twilio.rest.api.v2010.account.recording.AddOnResultReader reader(String pathReferenceSid)"]}}},"recording-add-on-result-payload":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.addonresult.PayloadDeleter deleter(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid, String pathSid)","com.twilio.rest.api.v2010.account.recording.addonresult.PayloadDeleter deleter(String pathReferenceSid, String pathAddOnResultSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.addonresult.PayloadFetcher fetcher(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid, String pathSid)","com.twilio.rest.api.v2010.account.recording.addonresult.PayloadFetcher fetcher(String pathReferenceSid, String pathAddOnResultSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.addonresult.PayloadReader reader(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid)","com.twilio.rest.api.v2010.account.recording.addonresult.PayloadReader reader(String pathReferenceSid, String pathAddOnResultSid)"]}}},"recording-transcription":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.TranscriptionDeleter deleter(String pathAccountSid, String pathRecordingSid, String pathSid)","com.twilio.rest.api.v2010.account.recording.TranscriptionDeleter deleter(String pathRecordingSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.TranscriptionFetcher fetcher(String pathAccountSid, String pathRecordingSid, String pathSid)","com.twilio.rest.api.v2010.account.recording.TranscriptionFetcher fetcher(String pathRecordingSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.recording.TranscriptionReader reader(String pathAccountSid, String pathRecordingSid)","com.twilio.rest.api.v2010.account.recording.TranscriptionReader reader(String pathRecordingSid)"]}}},"short-code":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ShortCodeFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ShortCodeFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ShortCodeReader reader()","com.twilio.rest.api.v2010.account.ShortCodeReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ShortCodeUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.ShortCodeUpdater updater(String pathSid)"]}}},"signing-key":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.SigningKeyDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.SigningKeyDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.SigningKeyFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.SigningKeyFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.SigningKeyReader reader()","com.twilio.rest.api.v2010.account.SigningKeyReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.SigningKeyUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.SigningKeyUpdater updater(String pathSid)"]}}},"sip-credential-list":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.CredentialListCreator creator(String friendlyName)","com.twilio.rest.api.v2010.account.sip.CredentialListCreator creator(String pathAccountSid, String friendlyName)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.CredentialListDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.CredentialListDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.CredentialListFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.CredentialListFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.CredentialListReader reader()","com.twilio.rest.api.v2010.account.sip.CredentialListReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.CredentialListUpdater updater(String pathAccountSid, String pathSid, String friendlyName)","com.twilio.rest.api.v2010.account.sip.CredentialListUpdater updater(String pathSid, String friendlyName)"]}}},"sip-credential-list-credential":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialCreator creator(String pathAccountSid, String pathCredentialListSid, String username, String password)","com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialCreator creator(String pathCredentialListSid, String username, String password)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialDeleter deleter(String pathAccountSid, String pathCredentialListSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialDeleter deleter(String pathCredentialListSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialFetcher fetcher(String pathAccountSid, String pathCredentialListSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialFetcher fetcher(String pathCredentialListSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialReader reader(String pathAccountSid, String pathCredentialListSid)","com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialReader reader(String pathCredentialListSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialUpdater updater(String pathAccountSid, String pathCredentialListSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialUpdater updater(String pathCredentialListSid, String pathSid)"]}}},"sip-domain":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.DomainCreator creator(String domainName)","com.twilio.rest.api.v2010.account.sip.DomainCreator creator(String pathAccountSid, String domainName)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.DomainDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.DomainDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.DomainFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.DomainFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.DomainReader reader()","com.twilio.rest.api.v2010.account.sip.DomainReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.DomainUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.DomainUpdater updater(String pathSid)"]}}},"sip-domain-credential-list-mapping":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingCreator creator(String pathAccountSid, String pathDomainSid, String credentialListSid)","com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingCreator creator(String pathDomainSid, String credentialListSid)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingDeleter deleter(String pathAccountSid, String pathDomainSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingDeleter deleter(String pathDomainSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingFetcher fetcher(String pathAccountSid, String pathDomainSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingFetcher fetcher(String pathDomainSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingReader reader(String pathAccountSid, String pathDomainSid)","com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingReader reader(String pathDomainSid)"]}}},"sip-domain-ip-access-control-list-mapping":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingCreator creator(String pathAccountSid, String pathDomainSid, String ipAccessControlListSid)","com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingCreator creator(String pathDomainSid, String ipAccessControlListSid)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingDeleter deleter(String pathAccountSid, String pathDomainSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingDeleter deleter(String pathDomainSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingFetcher fetcher(String pathAccountSid, String pathDomainSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingFetcher fetcher(String pathDomainSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingReader reader(String pathAccountSid, String pathDomainSid)","com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingReader reader(String pathDomainSid)"]}}},"sip-ip-access-control-list":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.IpAccessControlListCreator creator(String friendlyName)","com.twilio.rest.api.v2010.account.sip.IpAccessControlListCreator creator(String pathAccountSid, String friendlyName)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.IpAccessControlListDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.IpAccessControlListDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.IpAccessControlListFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.IpAccessControlListFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.IpAccessControlListReader reader()","com.twilio.rest.api.v2010.account.sip.IpAccessControlListReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.IpAccessControlListUpdater updater(String pathAccountSid, String pathSid, String friendlyName)","com.twilio.rest.api.v2010.account.sip.IpAccessControlListUpdater updater(String pathSid, String friendlyName)"]}}},"sip-ip-access-control-list-ip-address":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressCreator creator(String pathAccountSid, String pathIpAccessControlListSid, String friendlyName, String ipAddress)","com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressCreator creator(String pathIpAccessControlListSid, String friendlyName, String ipAddress)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressDeleter deleter(String pathAccountSid, String pathIpAccessControlListSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressDeleter deleter(String pathIpAccessControlListSid, String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressFetcher fetcher(String pathAccountSid, String pathIpAccessControlListSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressFetcher fetcher(String pathIpAccessControlListSid, String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressReader reader(String pathAccountSid, String pathIpAccessControlListSid)","com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressReader reader(String pathIpAccessControlListSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressUpdater updater(String pathAccountSid, String pathIpAccessControlListSid, String pathSid)","com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressUpdater updater(String pathIpAccessControlListSid, String pathSid)"]}}},"token":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.TokenCreator creator()","com.twilio.rest.api.v2010.account.TokenCreator creator(String pathAccountSid)"]}}},"transcription":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.TranscriptionDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.TranscriptionDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.TranscriptionFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.TranscriptionFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.TranscriptionReader reader()","com.twilio.rest.api.v2010.account.TranscriptionReader reader(String pathAccountSid)"]}}},"usage-record":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.RecordReader reader()","com.twilio.rest.api.v2010.account.usage.RecordReader reader(String pathAccountSid)"]}}},"usage-record-all-time":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.AllTimeReader reader()","com.twilio.rest.api.v2010.account.usage.record.AllTimeReader reader(String pathAccountSid)"]}}},"usage-record-daily":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.DailyReader reader()","com.twilio.rest.api.v2010.account.usage.record.DailyReader reader(String pathAccountSid)"]}}},"usage-record-last-month":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.LastMonthReader reader()","com.twilio.rest.api.v2010.account.usage.record.LastMonthReader reader(String pathAccountSid)"]}}},"usage-record-monthly":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.MonthlyReader reader()","com.twilio.rest.api.v2010.account.usage.record.MonthlyReader reader(String pathAccountSid)"]}}},"usage-record-this-month":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.ThisMonthReader reader()","com.twilio.rest.api.v2010.account.usage.record.ThisMonthReader reader(String pathAccountSid)"]}}},"usage-record-today":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.TodayReader reader()","com.twilio.rest.api.v2010.account.usage.record.TodayReader reader(String pathAccountSid)"]}}},"usage-record-yearly":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.YearlyReader reader()","com.twilio.rest.api.v2010.account.usage.record.YearlyReader reader(String pathAccountSid)"]}}},"usage-record-yesterday":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.record.YesterdayReader reader()","com.twilio.rest.api.v2010.account.usage.record.YesterdayReader reader(String pathAccountSid)"]}}},"usage-trigger":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.TriggerCreator creator(String pathAccountSid, java.net.URI callbackUrl, String triggerValue, com.twilio.rest.api.v2010.account.usage.Trigger$UsageCategory usageCategory)","com.twilio.rest.api.v2010.account.usage.TriggerCreator creator(java.net.URI callbackUrl, String triggerValue, com.twilio.rest.api.v2010.account.usage.Trigger$UsageCategory usageCategory)"]},"deleter":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.TriggerDeleter deleter(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.usage.TriggerDeleter deleter(String pathSid)"]},"fetcher":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.TriggerFetcher fetcher(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.usage.TriggerFetcher fetcher(String pathSid)"]},"reader":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.TriggerReader reader()","com.twilio.rest.api.v2010.account.usage.TriggerReader reader(String pathAccountSid)"]},"updater":{"description":"","signatures":["com.twilio.rest.api.v2010.account.usage.TriggerUpdater updater(String pathAccountSid, String pathSid)","com.twilio.rest.api.v2010.account.usage.TriggerUpdater updater(String pathSid)"]}}},"validation-request":{"consumerOnly":false,"producerOnly":false,"description":"","aliases":["^creator$=create","^deleter$=delete","^fetcher$=fetch","^reader$=read","^updater$=update"],"methods":{"creator":{"description":"","signatures":["com.twilio.rest.api.v2010.account.ValidationRequestCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)","com.twilio.rest.api.v2010.account.ValidationRequestCreator creator(com.twilio.type.PhoneNumber phoneNumber)"]}}}},"apiProperties":{"account":{"methods":{"fetcher":{"properties":{"pathSid":{"index":0,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathSid":{"index":0,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"address":{"methods":{"creator":{"properties":{"city":{"index":0,"kind":"parameter","displayName":"City","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"customerName":{"index":1,"kind":"parameter","displayName":"Customer Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"isoCountry":{"index":2,"kind":"parameter","displayName":"Iso Country","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":3,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"postalCode":{"index":4,"kind":"parameter","displayName":"Postal Code","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"region":{"index":5,"kind":"parameter","displayName":"Region","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"street":{"index":6,"kind":"parameter","displayName":"Street","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"address-dependent-phone-number":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAddressSid":{"index":2,"kind":"parameter","displayName":"Path Address Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"application":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"available-phone-number-country":{"methods":{"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCountryCode":{"index":1,"kind":"parameter","displayName":"Path Country Code","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"available-phone-number-country-local":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCountryCode":{"index":2,"kind":"parameter","displayName":"Path Country Code","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"available-phone-number-country-mobile":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCountryCode":{"index":2,"kind":"parameter","displayName":"Path Country Code","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"available-phone-number-country-toll-free":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCountryCode":{"index":2,"kind":"parameter","displayName":"Path Country Code","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"call":{"methods":{"creator":{"properties":{"applicationSid":{"index":0,"kind":"parameter","displayName":"Application Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"from":{"index":1,"kind":"parameter","displayName":"From","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.Endpoint","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":2,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"to":{"index":3,"kind":"parameter","displayName":"To","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.Endpoint","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"twiml":{"index":4,"kind":"parameter","displayName":"Twiml","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.Twiml","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"url":{"index":5,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"call-notification":{"methods":{"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":2,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":2,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"call-recording":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":2,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":2,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":2,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":2,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":2,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"status":{"index":4,"kind":"parameter","displayName":"Status","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.rest.api.v2010.account.call.Recording.Status","enum":["in-progress","paused","stopped","processing","completed","absent"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"conference":{"methods":{"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"conference-participant":{"methods":{"creator":{"properties":{"from":{"index":0,"kind":"parameter","displayName":"From","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.Endpoint","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathConferenceSid":{"index":3,"kind":"parameter","displayName":"Path Conference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"to":{"index":4,"kind":"parameter","displayName":"To","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.Endpoint","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":1,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathConferenceSid":{"index":3,"kind":"parameter","displayName":"Path Conference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":1,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathConferenceSid":{"index":3,"kind":"parameter","displayName":"Path Conference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathConferenceSid":{"index":2,"kind":"parameter","displayName":"Path Conference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":1,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathConferenceSid":{"index":3,"kind":"parameter","displayName":"Path Conference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"connect-app":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"incoming-phone-number":{"methods":{"creator":{"properties":{"areaCode":{"index":0,"kind":"parameter","displayName":"Area Code","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"phoneNumber":{"index":2,"kind":"parameter","displayName":"Phone Number","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.PhoneNumber","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"incoming-phone-number-local":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"phoneNumber":{"index":1,"kind":"parameter","displayName":"Phone Number","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.PhoneNumber","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"incoming-phone-number-mobile":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"phoneNumber":{"index":1,"kind":"parameter","displayName":"Phone Number","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.PhoneNumber","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"incoming-phone-number-toll-free":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"phoneNumber":{"index":1,"kind":"parameter","displayName":"Phone Number","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.PhoneNumber","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"key":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"message":{"methods":{"creator":{"properties":{"body":{"index":0,"kind":"parameter","displayName":"Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"from":{"index":1,"kind":"parameter","displayName":"From","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.PhoneNumber","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"mediaUrl":{"index":2,"kind":"parameter","displayName":"Media Url","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"messagingServiceSid":{"index":3,"kind":"parameter","displayName":"Messaging Service Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":4,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"to":{"index":5,"kind":"parameter","displayName":"To","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.PhoneNumber","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"message-feedback":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathMessageSid":{"index":2,"kind":"parameter","displayName":"Path Message Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"message-media":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathMessageSid":{"index":2,"kind":"parameter","displayName":"Path Message Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathMessageSid":{"index":2,"kind":"parameter","displayName":"Path Message Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathMessageSid":{"index":2,"kind":"parameter","displayName":"Path Message Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"new-key":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"new-signing-key":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"notification":{"methods":{"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"outgoing-caller-id":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"queue":{"methods":{"creator":{"properties":{"friendlyName":{"index":0,"kind":"parameter","displayName":"Friendly Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"queue-member":{"methods":{"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":1,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathQueueSid":{"index":3,"kind":"parameter","displayName":"Path Queue Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathQueueSid":{"index":2,"kind":"parameter","displayName":"Path Queue Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCallSid":{"index":1,"kind":"parameter","displayName":"Path Call Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathQueueSid":{"index":3,"kind":"parameter","displayName":"Path Queue Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"url":{"index":4,"kind":"parameter","displayName":"Url","group":"common","label":"","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"recording":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"recording-add-on-result":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathReferenceSid":{"index":2,"kind":"parameter","displayName":"Path Reference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathReferenceSid":{"index":2,"kind":"parameter","displayName":"Path Reference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathReferenceSid":{"index":2,"kind":"parameter","displayName":"Path Reference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"recording-add-on-result-payload":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAddOnResultSid":{"index":2,"kind":"parameter","displayName":"Path Add On Result Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathReferenceSid":{"index":4,"kind":"parameter","displayName":"Path Reference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":5,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAddOnResultSid":{"index":2,"kind":"parameter","displayName":"Path Add On Result Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathReferenceSid":{"index":4,"kind":"parameter","displayName":"Path Reference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":5,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAddOnResultSid":{"index":2,"kind":"parameter","displayName":"Path Add On Result Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathReferenceSid":{"index":4,"kind":"parameter","displayName":"Path Reference Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"recording-transcription":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathRecordingSid":{"index":2,"kind":"parameter","displayName":"Path Recording Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathRecordingSid":{"index":2,"kind":"parameter","displayName":"Path Recording Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathRecordingSid":{"index":2,"kind":"parameter","displayName":"Path Recording Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"short-code":{"methods":{"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"signing-key":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"sip-credential-list":{"methods":{"creator":{"properties":{"friendlyName":{"index":0,"kind":"parameter","displayName":"Friendly Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"friendlyName":{"index":0,"kind":"parameter","displayName":"Friendly Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":2,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"sip-credential-list-credential":{"methods":{"creator":{"properties":{"password":{"index":0,"kind":"parameter","displayName":"Password","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCredentialListSid":{"index":3,"kind":"parameter","displayName":"Path Credential List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"username":{"index":4,"kind":"parameter","displayName":"Username","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCredentialListSid":{"index":2,"kind":"parameter","displayName":"Path Credential List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCredentialListSid":{"index":2,"kind":"parameter","displayName":"Path Credential List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCredentialListSid":{"index":2,"kind":"parameter","displayName":"Path Credential List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathCredentialListSid":{"index":2,"kind":"parameter","displayName":"Path Credential List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"sip-domain":{"methods":{"creator":{"properties":{"domainName":{"index":0,"kind":"parameter","displayName":"Domain Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"sip-domain-credential-list-mapping":{"methods":{"creator":{"properties":{"credentialListSid":{"index":0,"kind":"parameter","displayName":"Credential List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":3,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":2,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":2,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":2,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"sip-domain-ip-access-control-list-mapping":{"methods":{"creator":{"properties":{"ipAccessControlListSid":{"index":0,"kind":"parameter","displayName":"Ip Access Control List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":3,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":2,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":2,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathDomainSid":{"index":2,"kind":"parameter","displayName":"Path Domain Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"sip-ip-access-control-list":{"methods":{"creator":{"properties":{"friendlyName":{"index":0,"kind":"parameter","displayName":"Friendly Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"friendlyName":{"index":0,"kind":"parameter","displayName":"Friendly Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":2,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"sip-ip-access-control-list-ip-address":{"methods":{"creator":{"properties":{"friendlyName":{"index":0,"kind":"parameter","displayName":"Friendly Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ipAddress":{"index":1,"kind":"parameter","displayName":"Ip Address","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":2,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathIpAccessControlListSid":{"index":4,"kind":"parameter","displayName":"Path Ip Access Control List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathIpAccessControlListSid":{"index":2,"kind":"parameter","displayName":"Path Ip Access Control List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathIpAccessControlListSid":{"index":2,"kind":"parameter","displayName":"Path Ip Access Control List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathIpAccessControlListSid":{"index":2,"kind":"parameter","displayName":"Path Ip Access Control List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathIpAccessControlListSid":{"index":2,"kind":"parameter","displayName":"Path Ip Access Control List Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":3,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"token":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"transcription":{"methods":{"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-all-time":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-daily":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-last-month":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-monthly":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-this-month":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-today":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-yearly":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-record-yesterday":{"methods":{"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"usage-trigger":{"methods":{"creator":{"properties":{"callbackUrl":{"index":0,"kind":"parameter","displayName":"Callback Url","group":"common","label":"","required":false,"type":"string","javaType":"java.net.URI","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathAccountSid":{"index":1,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"triggerValue":{"index":2,"kind":"parameter","displayName":"Trigger Value","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"usageCategory":{"index":3,"kind":"parameter","displayName":"Usage Category","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.rest.api.v2010.account.usage.Trigger.UsageCategory","enum":["a2p-registration-fees","agent-conference","amazon-polly","answering-machine-detection","authy-authentications","authy-calls-outbound","authy-monthly-fees","authy-phone-intelligence","authy-phone-verifications","authy-sms-outbound","call-progess-events","calleridlookups","calls","calls-client","calls-globalconference","calls-inbound","calls-inbound-local","calls-inbound-mobile","calls-inbound-tollfree","calls-outbound","calls-pay-verb-transactions","calls-recordings","calls-sip","calls-sip-inbound","calls-sip-outbound","calls-transfers","carrier-lookups","conversations","conversations-api-requests","conversations-conversation-events","conversations-endpoint-connectivity","conversations-events","conversations-participant-events","conversations-participants","cps","flex-usage","fraud-lookups","group-rooms","group-rooms-data-track","group-rooms-encrypted-media-recorded","group-rooms-media-downloaded","group-rooms-media-recorded","group-rooms-media-routed","group-rooms-media-stored","group-rooms-participant-minutes","group-rooms-recorded-minutes","imp-v1-usage","lookups","marketplace","marketplace-algorithmia-named-entity-recognition","marketplace-cadence-transcription","marketplace-cadence-translation","marketplace-capio-speech-to-text","marketplace-convriza-ababa","marketplace-deepgram-phrase-detector","marketplace-digital-segment-business-info","marketplace-facebook-offline-conversions","marketplace-google-speech-to-text","marketplace-ibm-watson-message-insights","marketplace-ibm-watson-message-sentiment","marketplace-ibm-watson-recording-analysis","marketplace-ibm-watson-tone-analyzer","marketplace-icehook-systems-scout","marketplace-infogroup-dataaxle-bizinfo","marketplace-keen-io-contact-center-analytics","marketplace-marchex-cleancall","marketplace-marchex-sentiment-analysis-for-sms","marketplace-marketplace-nextcaller-social-id","marketplace-mobile-commons-opt-out-classifier","marketplace-nexiwave-voicemail-to-text","marketplace-nextcaller-advanced-caller-identification","marketplace-nomorobo-spam-score","marketplace-payfone-tcpa-compliance","marketplace-remeeting-automatic-speech-recognition","marketplace-tcpa-defense-solutions-blacklist-feed","marketplace-telo-opencnam","marketplace-truecnam-true-spam","marketplace-twilio-caller-name-lookup-us","marketplace-twilio-carrier-information-lookup","marketplace-voicebase-pci","marketplace-voicebase-transcription","marketplace-voicebase-transcription-custom-vocabulary","marketplace-whitepages-pro-caller-identification","marketplace-whitepages-pro-phone-intelligence","marketplace-whitepages-pro-phone-reputation","marketplace-wolfarm-spoken-results","marketplace-wolfram-short-answer","marketplace-ytica-contact-center-reporting-analytics","mediastorage","mms","mms-inbound","mms-inbound-longcode","mms-inbound-shortcode","mms-messages-carrierfees","mms-outbound","mms-outbound-longcode","mms-outbound-shortcode","monitor-reads","monitor-storage","monitor-writes","notify","notify-actions-attempts","notify-channels","number-format-lookups","pchat","pchat-users","peer-to-peer-rooms-participant-minutes","pfax","pfax-minutes","pfax-minutes-inbound","pfax-minutes-outbound","pfax-pages","phonenumbers","phonenumbers-cps","phonenumbers-emergency","phonenumbers-local","phonenumbers-mobile","phonenumbers-setups","phonenumbers-tollfree","premiumsupport","proxy","proxy-active-sessions","pstnconnectivity","pv","pv-composition-media-downloaded","pv-composition-media-encrypted","pv-composition-media-stored","pv-composition-minutes","pv-recording-compositions","pv-room-participants","pv-room-participants-au1","pv-room-participants-br1","pv-room-participants-ie1","pv-room-participants-jp1","pv-room-participants-sg1","pv-room-participants-us1","pv-room-participants-us2","pv-rooms","pv-sip-endpoint-registrations","recordings","recordingstorage","rooms-group-bandwidth","rooms-group-minutes","rooms-peer-to-peer-minutes","shortcodes","shortcodes-customerowned","shortcodes-mms-enablement","shortcodes-mps","shortcodes-random","shortcodes-uk","shortcodes-vanity","small-group-rooms","small-group-rooms-data-track","small-group-rooms-participant-minutes","sms","sms-inbound","sms-inbound-longcode","sms-inbound-shortcode","sms-messages-carrierfees","sms-messages-features","sms-messages-features-senderid","sms-outbound","sms-outbound-content-inspection","sms-outbound-longcode","sms-outbound-shortcode","speech-recognition","studio-engagements","sync","sync-actions","sync-endpoint-hours","sync-endpoint-hours-above-daily-cap","taskrouter-tasks","totalprice","transcriptions","trunking-cps","trunking-emergency-calls","trunking-origination","trunking-origination-local","trunking-origination-mobile","trunking-origination-tollfree","trunking-recordings","trunking-secure","trunking-termination","tts-google","turnmegabytes","turnmegabytes-australia","turnmegabytes-brasil","turnmegabytes-germany","turnmegabytes-india","turnmegabytes-ireland","turnmegabytes-japan","turnmegabytes-singapore","turnmegabytes-useast","turnmegabytes-uswest","twilio-interconnect","verify-push","verify-totp","verify-whatsapp-conversations-business-initiated","video-recordings","virtual-agent","voice-insights","voice-insights-client-insights-on-demand-minute","voice-insights-ptsn-insights-on-demand-minute","voice-insights-sip-interface-insights-on-demand-minute","voice-insights-sip-trunking-insights-on-demand-minute","voice-intelligence","voice-intelligence-transcription","voice-intelligence-operators","wireless","wireless-orders","wireless-orders-artwork","wireless-orders-bulk","wireless-orders-esim","wireless-orders-starter","wireless-usage","wireless-usage-commands","wireless-usage-commands-africa","wireless-usage-commands-asia","wireless-usage-commands-centralandsouthamerica","wireless-usage-commands-europe","wireless-usage-commands-home","wireless-usage-commands-northamerica","wireless-usage-commands-oceania","wireless-usage-commands-roaming","wireless-usage-data","wireless-usage-data-africa","wireless-usage-data-asia","wireless-usage-data-centralandsouthamerica","wireless-usage-data-custom-additionalmb","wireless-usage-data-custom-first5mb","wireless-usage-data-domestic-roaming","wireless-usage-data-europe","wireless-usage-data-individual-additionalgb","wireless-usage-data-individual-firstgb","wireless-usage-data-international-roaming-canada","wireless-usage-data-international-roaming-india","wireless-usage-data-international-roaming-mexico","wireless-usage-data-northamerica","wireless-usage-data-oceania","wireless-usage-data-pooled","wireless-usage-data-pooled-downlink","wireless-usage-data-pooled-uplink","wireless-usage-mrc","wireless-usage-mrc-custom","wireless-usage-mrc-individual","wireless-usage-mrc-pooled","wireless-usage-mrc-suspended","wireless-usage-sms","wireless-usage-voice"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleter":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"fetcher":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"reader":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updater":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pathSid":{"index":1,"kind":"parameter","displayName":"Path Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}},"validation-request":{"methods":{"creator":{"properties":{"pathAccountSid":{"index":0,"kind":"parameter","displayName":"Path Account Sid","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"phoneNumber":{"index":2,"kind":"parameter","displayName":"Phone Number","group":"common","label":"","required":false,"type":"object","javaType":"com.twilio.type.PhoneNumber","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}}}} , -{"component":{"kind":"component","name":"twitter-directmessage","title":"Twitter Direct Message","description":"Send and receive Twitter direct messages.","deprecated":false,"firstVersion":"2.10.0","label":"saas,social","javaType":"org.apache.camel.component.twitter.directmessage.TwitterDirectMessageComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-twitter","version":"4.8.1","scheme":"twitter-directmessage","extendsScheme":"","syntax":"twitter-directmessage:user","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"CamelTwitterUser":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_USER"},"CamelTwitterEventType":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event. The supported values are the values of the enum org.apache.camel.component.twitter.consumer.TwitterEventType","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_EVENT_TYPE"}},"properties":{"user":{"index":0,"kind":"path","displayName":"User","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user name to send a direct message. This will be ignored for consumer."},"sendEmptyMessageWhenIdle":{"index":1,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"type":{"index":2,"kind":"parameter","displayName":"Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.twitter.data.EndpointType","enum":["polling","direct"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"polling","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Endpoint type to use."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"distanceMetric":{"index":4,"kind":"parameter","displayName":"Distance Metric","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["km","mi"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"km","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search, to search by radius using the configured metrics. The unit can either be mi for miles, or km for kilometers. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"exceptionHandler":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"extendedMode":{"index":7,"kind":"parameter","displayName":"Extended Mode","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used for enabling full text from twitter (eg receive tweets that contains more than 140 characters)."},"latitude":{"index":8,"kind":"parameter","displayName":"Latitude","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by latitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"locations":{"index":9,"kind":"parameter","displayName":"Locations","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Bounding boxes, created by pairs of lat/lons. Can be used for filter. A pair is defined as lat,lon. And multiple pairs can be separated by semicolon."},"longitude":{"index":10,"kind":"parameter","displayName":"Longitude","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by longitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"radius":{"index":12,"kind":"parameter","displayName":"Radius","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by radius. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"lazyStartProducer":{"index":13,"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."},"count":{"index":14,"kind":"parameter","displayName":"Count","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Limiting number of results per page."},"filterOld":{"index":15,"kind":"parameter","displayName":"Filter Old","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Filter out old tweets, that has previously been polled. This state is stored in memory only, and based on last tweet id."},"lang":{"index":16,"kind":"parameter","displayName":"Lang","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The lang string ISO_639-1 which will be used for searching"},"numberOfPages":{"index":17,"kind":"parameter","displayName":"Number Of Pages","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The number of pages result which you want camel-twitter to consume."},"sinceId":{"index":18,"kind":"parameter","displayName":"Since Id","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running."},"userIds":{"index":19,"kind":"parameter","displayName":"User Ids","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"To filter by user ids for filter. Multiple values can be separated by comma."},"httpProxyHost":{"index":20,"kind":"parameter","displayName":"Http Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyPassword":{"index":21,"kind":"parameter","displayName":"Http Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyPort":{"index":22,"kind":"parameter","displayName":"Http Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyUser":{"index":23,"kind":"parameter","displayName":"Http Proxy User","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"backoffErrorThreshold":{"index":24,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":25,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":26,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":27,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Milliseconds before the next poll."},"greedy":{"index":28,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":29,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":30,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":31,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":32,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":33,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":34,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":35,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":36,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":37,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":38,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The access token. Can also be configured on the TwitterComponent level instead."},"accessTokenSecret":{"index":39,"kind":"parameter","displayName":"Access Token Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The access secret. Can also be configured on the TwitterComponent level instead."},"consumerKey":{"index":40,"kind":"parameter","displayName":"Consumer Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The consumer key. Can also be configured on the TwitterComponent level instead."},"consumerSecret":{"index":41,"kind":"parameter","displayName":"Consumer Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The consumer secret. Can also be configured on the TwitterComponent level instead."},"sortById":{"index":42,"kind":"parameter","displayName":"Sort By Id","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Sorts by id, so the oldest are first, and newest last."}}} +{"component":{"kind":"component","name":"twitter-directmessage","title":"Twitter Direct Message","description":"Send and receive Twitter direct messages.","deprecated":false,"firstVersion":"2.10.0","label":"saas,social","javaType":"org.apache.camel.component.twitter.directmessage.TwitterDirectMessageComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-twitter","version":"4.8.2","scheme":"twitter-directmessage","extendsScheme":"","syntax":"twitter-directmessage:user","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"CamelTwitterUser":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_USER"},"CamelTwitterEventType":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event. The supported values are the values of the enum org.apache.camel.component.twitter.consumer.TwitterEventType","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_EVENT_TYPE"}},"properties":{"user":{"index":0,"kind":"path","displayName":"User","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user name to send a direct message. This will be ignored for consumer."},"sendEmptyMessageWhenIdle":{"index":1,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"type":{"index":2,"kind":"parameter","displayName":"Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.twitter.data.EndpointType","enum":["polling","direct"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"polling","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Endpoint type to use."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"distanceMetric":{"index":4,"kind":"parameter","displayName":"Distance Metric","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["km","mi"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"km","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search, to search by radius using the configured metrics. The unit can either be mi for miles, or km for kilometers. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"exceptionHandler":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"extendedMode":{"index":7,"kind":"parameter","displayName":"Extended Mode","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used for enabling full text from twitter (eg receive tweets that contains more than 140 characters)."},"latitude":{"index":8,"kind":"parameter","displayName":"Latitude","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by latitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"locations":{"index":9,"kind":"parameter","displayName":"Locations","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Bounding boxes, created by pairs of lat/lons. Can be used for filter. A pair is defined as lat,lon. And multiple pairs can be separated by semicolon."},"longitude":{"index":10,"kind":"parameter","displayName":"Longitude","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by longitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"radius":{"index":12,"kind":"parameter","displayName":"Radius","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by radius. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"lazyStartProducer":{"index":13,"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."},"count":{"index":14,"kind":"parameter","displayName":"Count","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Limiting number of results per page."},"filterOld":{"index":15,"kind":"parameter","displayName":"Filter Old","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Filter out old tweets, that has previously been polled. This state is stored in memory only, and based on last tweet id."},"lang":{"index":16,"kind":"parameter","displayName":"Lang","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The lang string ISO_639-1 which will be used for searching"},"numberOfPages":{"index":17,"kind":"parameter","displayName":"Number Of Pages","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The number of pages result which you want camel-twitter to consume."},"sinceId":{"index":18,"kind":"parameter","displayName":"Since Id","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running."},"userIds":{"index":19,"kind":"parameter","displayName":"User Ids","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"To filter by user ids for filter. Multiple values can be separated by comma."},"httpProxyHost":{"index":20,"kind":"parameter","displayName":"Http Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyPassword":{"index":21,"kind":"parameter","displayName":"Http Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyPort":{"index":22,"kind":"parameter","displayName":"Http Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyUser":{"index":23,"kind":"parameter","displayName":"Http Proxy User","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"backoffErrorThreshold":{"index":24,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":25,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":26,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":27,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Milliseconds before the next poll."},"greedy":{"index":28,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":29,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":30,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":31,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":32,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":33,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":34,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":35,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":36,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":37,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":38,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The access token. Can also be configured on the TwitterComponent level instead."},"accessTokenSecret":{"index":39,"kind":"parameter","displayName":"Access Token Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The access secret. Can also be configured on the TwitterComponent level instead."},"consumerKey":{"index":40,"kind":"parameter","displayName":"Consumer Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The consumer key. Can also be configured on the TwitterComponent level instead."},"consumerSecret":{"index":41,"kind":"parameter","displayName":"Consumer Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The consumer secret. Can also be configured on the TwitterComponent level instead."},"sortById":{"index":42,"kind":"parameter","displayName":"Sort By Id","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Sorts by id, so the oldest are first, and newest last."}}} , -{"component":{"kind":"component","name":"twitter-search","title":"Twitter Search","description":"Access Twitter Search.","deprecated":false,"firstVersion":"2.10.0","label":"saas,social","javaType":"org.apache.camel.component.twitter.search.TwitterSearchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-twitter","version":"4.8.1","scheme":"twitter-search","extendsScheme":"","syntax":"twitter-search:keywords","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"CamelTwitterKeywords":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The keywords to search","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_KEYWORDS"},"CamelTwitterSearchLanguage":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The lang string ISO_639-1 which will be used for searching","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_SEARCH_LANGUAGE"},"CamelTwitterCount":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Limiting number of results per page.","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_COUNT"},"CamelTwitterNumberOfPages":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of pages result which you want camel-twitter to consume.","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_NUMBER_OF_PAGES"},"CamelTwitterSinceId":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long-running.","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_SINCEID"},"CamelTwitterMaxId":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If specified, returns tweets with status ids less than the given id.","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_MAXID"},"CamelTwitterEventType":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event. The supported values are the values of the enum org.apache.camel.component.twitter.consumer.TwitterEventType","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_EVENT_TYPE"}},"properties":{"keywords":{"index":0,"kind":"path","displayName":"Keywords","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The search query, use the keywords AND, OR, - and () to narrow the search results."},"sendEmptyMessageWhenIdle":{"index":1,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"type":{"index":2,"kind":"parameter","displayName":"Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.twitter.data.EndpointType","enum":["polling","direct"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"polling","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Endpoint type to use."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"distanceMetric":{"index":4,"kind":"parameter","displayName":"Distance Metric","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["km","mi"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"km","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search, to search by radius using the configured metrics. The unit can either be mi for miles, or km for kilometers. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"exceptionHandler":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"extendedMode":{"index":7,"kind":"parameter","displayName":"Extended Mode","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used for enabling full text from twitter (eg receive tweets that contains more than 140 characters)."},"latitude":{"index":8,"kind":"parameter","displayName":"Latitude","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by latitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"locations":{"index":9,"kind":"parameter","displayName":"Locations","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Bounding boxes, created by pairs of lat/lons. Can be used for filter. A pair is defined as lat,lon. And multiple pairs can be separated by semicolon."},"longitude":{"index":10,"kind":"parameter","displayName":"Longitude","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by longitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"radius":{"index":12,"kind":"parameter","displayName":"Radius","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by radius. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"lazyStartProducer":{"index":13,"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."},"count":{"index":14,"kind":"parameter","displayName":"Count","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Limiting number of results per page."},"filterOld":{"index":15,"kind":"parameter","displayName":"Filter Old","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Filter out old tweets, that has previously been polled. This state is stored in memory only, and based on last tweet id."},"lang":{"index":16,"kind":"parameter","displayName":"Lang","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The lang string ISO_639-1 which will be used for searching"},"numberOfPages":{"index":17,"kind":"parameter","displayName":"Number Of Pages","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The number of pages result which you want camel-twitter to consume."},"sinceId":{"index":18,"kind":"parameter","displayName":"Since Id","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running."},"userIds":{"index":19,"kind":"parameter","displayName":"User Ids","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"To filter by user ids for filter. Multiple values can be separated by comma."},"httpProxyHost":{"index":20,"kind":"parameter","displayName":"Http Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyPassword":{"index":21,"kind":"parameter","displayName":"Http Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyPort":{"index":22,"kind":"parameter","displayName":"Http Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyUser":{"index":23,"kind":"parameter","displayName":"Http Proxy User","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"backoffErrorThreshold":{"index":24,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":25,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":26,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":27,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Milliseconds before the next poll."},"greedy":{"index":28,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":29,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":30,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":31,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":32,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":33,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":34,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":35,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":36,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":37,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":38,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The access token. Can also be configured on the TwitterComponent level instead."},"accessTokenSecret":{"index":39,"kind":"parameter","displayName":"Access Token Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The access secret. Can also be configured on the TwitterComponent level instead."},"consumerKey":{"index":40,"kind":"parameter","displayName":"Consumer Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The consumer key. Can also be configured on the TwitterComponent level instead."},"consumerSecret":{"index":41,"kind":"parameter","displayName":"Consumer Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The consumer secret. Can also be configured on the TwitterComponent level instead."},"sortById":{"index":42,"kind":"parameter","displayName":"Sort By Id","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Sorts by id, so the oldest are first, and newest last."}}} +{"component":{"kind":"component","name":"twitter-search","title":"Twitter Search","description":"Access Twitter Search.","deprecated":false,"firstVersion":"2.10.0","label":"saas,social","javaType":"org.apache.camel.component.twitter.search.TwitterSearchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-twitter","version":"4.8.2","scheme":"twitter-search","extendsScheme":"","syntax":"twitter-search:keywords","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"CamelTwitterKeywords":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The keywords to search","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_KEYWORDS"},"CamelTwitterSearchLanguage":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The lang string ISO_639-1 which will be used for searching","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_SEARCH_LANGUAGE"},"CamelTwitterCount":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Limiting number of results per page.","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_COUNT"},"CamelTwitterNumberOfPages":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of pages result which you want camel-twitter to consume.","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_NUMBER_OF_PAGES"},"CamelTwitterSinceId":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long-running.","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_SINCEID"},"CamelTwitterMaxId":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If specified, returns tweets with status ids less than the given id.","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_MAXID"},"CamelTwitterEventType":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event. The supported values are the values of the enum org.apache.camel.component.twitter.consumer.TwitterEventType","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_EVENT_TYPE"}},"properties":{"keywords":{"index":0,"kind":"path","displayName":"Keywords","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The search query, use the keywords AND, OR, - and () to narrow the search results."},"sendEmptyMessageWhenIdle":{"index":1,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"type":{"index":2,"kind":"parameter","displayName":"Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.twitter.data.EndpointType","enum":["polling","direct"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"polling","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Endpoint type to use."},"bridgeErrorHandler":{"index":3,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"distanceMetric":{"index":4,"kind":"parameter","displayName":"Distance Metric","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["km","mi"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"km","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search, to search by radius using the configured metrics. The unit can either be mi for miles, or km for kilometers. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"exceptionHandler":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"extendedMode":{"index":7,"kind":"parameter","displayName":"Extended Mode","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used for enabling full text from twitter (eg receive tweets that contains more than 140 characters)."},"latitude":{"index":8,"kind":"parameter","displayName":"Latitude","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by latitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"locations":{"index":9,"kind":"parameter","displayName":"Locations","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Bounding boxes, created by pairs of lat/lons. Can be used for filter. A pair is defined as lat,lon. And multiple pairs can be separated by semicolon."},"longitude":{"index":10,"kind":"parameter","displayName":"Longitude","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by longitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"radius":{"index":12,"kind":"parameter","displayName":"Radius","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by radius. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"lazyStartProducer":{"index":13,"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."},"count":{"index":14,"kind":"parameter","displayName":"Count","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Limiting number of results per page."},"filterOld":{"index":15,"kind":"parameter","displayName":"Filter Old","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Filter out old tweets, that has previously been polled. This state is stored in memory only, and based on last tweet id."},"lang":{"index":16,"kind":"parameter","displayName":"Lang","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The lang string ISO_639-1 which will be used for searching"},"numberOfPages":{"index":17,"kind":"parameter","displayName":"Number Of Pages","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The number of pages result which you want camel-twitter to consume."},"sinceId":{"index":18,"kind":"parameter","displayName":"Since Id","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running."},"userIds":{"index":19,"kind":"parameter","displayName":"User Ids","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"To filter by user ids for filter. Multiple values can be separated by comma."},"httpProxyHost":{"index":20,"kind":"parameter","displayName":"Http Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyPassword":{"index":21,"kind":"parameter","displayName":"Http Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyPort":{"index":22,"kind":"parameter","displayName":"Http Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyUser":{"index":23,"kind":"parameter","displayName":"Http Proxy User","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"backoffErrorThreshold":{"index":24,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":25,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":26,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":27,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Milliseconds before the next poll."},"greedy":{"index":28,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":29,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":30,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":31,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":32,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":33,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":34,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":35,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":36,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":37,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":38,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The access token. Can also be configured on the TwitterComponent level instead."},"accessTokenSecret":{"index":39,"kind":"parameter","displayName":"Access Token Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The access secret. Can also be configured on the TwitterComponent level instead."},"consumerKey":{"index":40,"kind":"parameter","displayName":"Consumer Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The consumer key. Can also be configured on the TwitterComponent level instead."},"consumerSecret":{"index":41,"kind":"parameter","displayName":"Consumer Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The consumer secret. Can also be configured on the TwitterComponent level instead."},"sortById":{"index":42,"kind":"parameter","displayName":"Sort By Id","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Sorts by id, so the oldest are first, and newest last."}}} , -{"component":{"kind":"component","name":"twitter-timeline","title":"Twitter Timeline","description":"Send tweets and receive tweets from user's timeline.","deprecated":false,"firstVersion":"2.10.0","label":"saas,social","javaType":"org.apache.camel.component.twitter.timeline.TwitterTimelineComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-twitter","version":"4.8.1","scheme":"twitter-timeline","extendsScheme":"","syntax":"twitter-timeline:timelineType","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"CamelTwitterEventType":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event. The supported values are the values of the enum org.apache.camel.component.twitter.consumer.TwitterEventType","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_EVENT_TYPE"}},"properties":{"timelineType":{"index":0,"kind":"path","displayName":"Timeline Type","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.twitter.data.TimelineType","enum":["PUBLIC","HOME","USER","MENTIONS","LIST","UNKNOWN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timeline type to produce/consume."},"list":{"index":1,"kind":"parameter","displayName":"List","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The list name when using timelineType=list"},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The username when using timelineType=user"},"sendEmptyMessageWhenIdle":{"index":3,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"type":{"index":4,"kind":"parameter","displayName":"Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.twitter.data.EndpointType","enum":["polling","direct"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"polling","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Endpoint type to use."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"distanceMetric":{"index":6,"kind":"parameter","displayName":"Distance Metric","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["km","mi"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"km","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search, to search by radius using the configured metrics. The unit can either be mi for miles, or km for kilometers. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"exceptionHandler":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"extendedMode":{"index":9,"kind":"parameter","displayName":"Extended Mode","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used for enabling full text from twitter (eg receive tweets that contains more than 140 characters)."},"latitude":{"index":10,"kind":"parameter","displayName":"Latitude","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by latitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"locations":{"index":11,"kind":"parameter","displayName":"Locations","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Bounding boxes, created by pairs of lat/lons. Can be used for filter. A pair is defined as lat,lon. And multiple pairs can be separated by semicolon."},"longitude":{"index":12,"kind":"parameter","displayName":"Longitude","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by longitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"pollStrategy":{"index":13,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"radius":{"index":14,"kind":"parameter","displayName":"Radius","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by radius. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"lazyStartProducer":{"index":15,"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."},"count":{"index":16,"kind":"parameter","displayName":"Count","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Limiting number of results per page."},"filterOld":{"index":17,"kind":"parameter","displayName":"Filter Old","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Filter out old tweets, that has previously been polled. This state is stored in memory only, and based on last tweet id."},"lang":{"index":18,"kind":"parameter","displayName":"Lang","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The lang string ISO_639-1 which will be used for searching"},"numberOfPages":{"index":19,"kind":"parameter","displayName":"Number Of Pages","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The number of pages result which you want camel-twitter to consume."},"sinceId":{"index":20,"kind":"parameter","displayName":"Since Id","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running."},"userIds":{"index":21,"kind":"parameter","displayName":"User Ids","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"To filter by user ids for filter. Multiple values can be separated by comma."},"httpProxyHost":{"index":22,"kind":"parameter","displayName":"Http Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyPassword":{"index":23,"kind":"parameter","displayName":"Http Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyPort":{"index":24,"kind":"parameter","displayName":"Http Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyUser":{"index":25,"kind":"parameter","displayName":"Http Proxy User","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"backoffErrorThreshold":{"index":26,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":27,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":28,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":29,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Milliseconds before the next poll."},"greedy":{"index":30,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":31,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":32,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":33,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":34,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":35,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":36,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":37,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":38,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":39,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":40,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The access token. Can also be configured on the TwitterComponent level instead."},"accessTokenSecret":{"index":41,"kind":"parameter","displayName":"Access Token Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The access secret. Can also be configured on the TwitterComponent level instead."},"consumerKey":{"index":42,"kind":"parameter","displayName":"Consumer Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The consumer key. Can also be configured on the TwitterComponent level instead."},"consumerSecret":{"index":43,"kind":"parameter","displayName":"Consumer Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The consumer secret. Can also be configured on the TwitterComponent level instead."},"sortById":{"index":44,"kind":"parameter","displayName":"Sort By Id","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Sorts by id, so the oldest are first, and newest last."}}} +{"component":{"kind":"component","name":"twitter-timeline","title":"Twitter Timeline","description":"Send tweets and receive tweets from user's timeline.","deprecated":false,"firstVersion":"2.10.0","label":"saas,social","javaType":"org.apache.camel.component.twitter.timeline.TwitterTimelineComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-twitter","version":"4.8.2","scheme":"twitter-timeline","extendsScheme":"","syntax":"twitter-timeline:timelineType","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"CamelTwitterEventType":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event. The supported values are the values of the enum org.apache.camel.component.twitter.consumer.TwitterEventType","constantName":"org.apache.camel.component.twitter.TwitterConstants#TWITTER_EVENT_TYPE"}},"properties":{"timelineType":{"index":0,"kind":"path","displayName":"Timeline Type","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.twitter.data.TimelineType","enum":["PUBLIC","HOME","USER","MENTIONS","LIST","UNKNOWN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timeline type to produce/consume."},"list":{"index":1,"kind":"parameter","displayName":"List","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The list name when using timelineType=list"},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The username when using timelineType=user"},"sendEmptyMessageWhenIdle":{"index":3,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"type":{"index":4,"kind":"parameter","displayName":"Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.twitter.data.EndpointType","enum":["polling","direct"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"polling","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Endpoint type to use."},"bridgeErrorHandler":{"index":5,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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."},"distanceMetric":{"index":6,"kind":"parameter","displayName":"Distance Metric","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["km","mi"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"km","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search, to search by radius using the configured metrics. The unit can either be mi for miles, or km for kilometers. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"exceptionHandler":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"extendedMode":{"index":9,"kind":"parameter","displayName":"Extended Mode","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used for enabling full text from twitter (eg receive tweets that contains more than 140 characters)."},"latitude":{"index":10,"kind":"parameter","displayName":"Latitude","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by latitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"locations":{"index":11,"kind":"parameter","displayName":"Locations","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Bounding boxes, created by pairs of lat/lons. Can be used for filter. A pair is defined as lat,lon. And multiple pairs can be separated by semicolon."},"longitude":{"index":12,"kind":"parameter","displayName":"Longitude","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by longitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"pollStrategy":{"index":13,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"radius":{"index":14,"kind":"parameter","displayName":"Radius","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Used by the geography search to search by radius. You need to configure all the following options: longitude, latitude, radius, and distanceMetric."},"lazyStartProducer":{"index":15,"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."},"count":{"index":16,"kind":"parameter","displayName":"Count","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Limiting number of results per page."},"filterOld":{"index":17,"kind":"parameter","displayName":"Filter Old","group":"filter","label":"consumer,filter","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Filter out old tweets, that has previously been polled. This state is stored in memory only, and based on last tweet id."},"lang":{"index":18,"kind":"parameter","displayName":"Lang","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The lang string ISO_639-1 which will be used for searching"},"numberOfPages":{"index":19,"kind":"parameter","displayName":"Number Of Pages","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The number of pages result which you want camel-twitter to consume."},"sinceId":{"index":20,"kind":"parameter","displayName":"Since Id","group":"filter","label":"consumer,filter","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running."},"userIds":{"index":21,"kind":"parameter","displayName":"User Ids","group":"filter","label":"consumer,filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"To filter by user ids for filter. Multiple values can be separated by comma."},"httpProxyHost":{"index":22,"kind":"parameter","displayName":"Http Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyPassword":{"index":23,"kind":"parameter","displayName":"Http Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyPort":{"index":24,"kind":"parameter","displayName":"Http Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"httpProxyUser":{"index":25,"kind":"parameter","displayName":"Http Proxy User","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead."},"backoffErrorThreshold":{"index":26,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":27,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":28,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":29,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Milliseconds before the next poll."},"greedy":{"index":30,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":31,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":32,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":33,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":34,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":35,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":36,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":37,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":38,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":39,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessToken":{"index":40,"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The access token. Can also be configured on the TwitterComponent level instead."},"accessTokenSecret":{"index":41,"kind":"parameter","displayName":"Access Token Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The access secret. Can also be configured on the TwitterComponent level instead."},"consumerKey":{"index":42,"kind":"parameter","displayName":"Consumer Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The consumer key. Can also be configured on the TwitterComponent level instead."},"consumerSecret":{"index":43,"kind":"parameter","displayName":"Consumer Secret","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"The consumer secret. Can also be configured on the TwitterComponent level instead."},"sortById":{"index":44,"kind":"parameter","displayName":"Sort By Id","group":"sort","label":"consumer,sort","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.twitter.TwitterConfiguration","configurationField":"properties","description":"Sorts by id, so the oldest are first, and newest last."}}} , -{"component":{"kind":"component","name":"undertow","title":"Undertow","description":"Expose HTTP and WebSocket endpoints and access external HTTP/WebSocket servers.","deprecated":false,"firstVersion":"2.16.0","label":"http,networking","javaType":"org.apache.camel.component.undertow.UndertowComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-undertow","version":"4.8.1","scheme":"undertow","extendsScheme":"","syntax":"undertow:httpURI","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"websocket.connectionKey":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"An identifier of WebSocketChannel through which the message was received or should be sent.","constantName":"org.apache.camel.component.undertow.UndertowConstants#CONNECTION_KEY"},"websocket.connectionKey.list":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of websocket connection keys","constantName":"org.apache.camel.component.undertow.UndertowConstants#CONNECTION_KEY_LIST"},"websocket.sendToAll":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To send to all websocket subscribers. Can be used to configure on endpoint level, instead of having to use the UndertowConstants.SEND_TO_ALL header on the message.","constantName":"org.apache.camel.component.undertow.UndertowConstants#SEND_TO_ALL"},"websocket.eventType":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The numeric identifier of the type of websocket event","constantName":"org.apache.camel.component.undertow.UndertowConstants#EVENT_TYPE"},"websocket.eventTypeEnum":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.undertow.UndertowConstants.EventType","enum":["ONOPEN","ONCLOSE","ONERROR"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of websocket event","constantName":"org.apache.camel.component.undertow.UndertowConstants#EVENT_TYPE_ENUM"},"websocket.channel":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.undertow.websockets.core.WebSocketChannel","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The WebSocketChannel through which the message was received","constantName":"org.apache.camel.component.undertow.UndertowConstants#CHANNEL"},"websocket.exchange":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.undertow.websockets.spi.WebSocketHttpExchange","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The exchange for the websocket transport, only available for ON_OPEN events","constantName":"org.apache.camel.component.undertow.UndertowConstants#EXCHANGE"},"CamelHttpResponseCode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http response code","constantName":"org.apache.camel.component.undertow.UndertowConstants#HTTP_RESPONSE_CODE"},"Content-Type":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.undertow.UndertowConstants#CONTENT_TYPE"},"CamelHttpCharacterEncoding":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http character encoding","constantName":"org.apache.camel.component.undertow.UndertowConstants#HTTP_CHARACTER_ENCODING"},"CamelHttpPath":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http path","constantName":"org.apache.camel.component.undertow.UndertowConstants#HTTP_PATH"},"CamelHttpQuery":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http query","constantName":"org.apache.camel.component.undertow.UndertowConstants#HTTP_QUERY"},"CamelHttpUri":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http URI","constantName":"org.apache.camel.component.undertow.UndertowConstants#HTTP_URI"},"CamelHttpMethod":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http method","constantName":"org.apache.camel.component.undertow.UndertowConstants#HTTP_METHOD"},"Host":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The host http header","constantName":"org.apache.camel.component.undertow.UndertowConstants#HOST_STRING"}},"properties":{"httpURI":{"index":0,"kind":"path","displayName":"Http URI","group":"common","label":"","required":true,"type":"string","javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The url of the HTTP endpoint to use."},"useStreaming":{"index":1,"kind":"parameter","displayName":"Use Streaming","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"For HTTP endpoint: if true, text and binary messages will be wrapped as java.io.InputStream before they are passed to an Exchange; otherwise they will be passed as byte. For WebSocket endpoint: if true, text and binary messages will be wrapped as java.io.Reader and java.io.InputStream respectively before they are passed to an Exchange; otherwise they will be passed as String and byte respectively."},"accessLog":{"index":2,"kind":"parameter","displayName":"Access Log","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Whether or not the consumer should write access log"},"httpMethodRestrict":{"index":3,"kind":"parameter","displayName":"Http Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma."},"matchOnUriPrefix":{"index":4,"kind":"parameter","displayName":"Match On Uri Prefix","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found."},"muteException":{"index":5,"kind":"parameter","displayName":"Mute Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace."},"optionsEnabled":{"index":6,"kind":"parameter","displayName":"Options Enabled","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off."},"transferException":{"index":7,"kind":"parameter","displayName":"Transfer Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"handlers":{"index":11,"kind":"parameter","displayName":"Handlers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies a comma-delimited set of io.undertow.server.HttpHandler instances to lookup in your Registry. These handlers are added to the Undertow handler chain (for example, to add security). Important: You can not use different handlers with different Undertow endpoints using the same port number. The handlers is associated to the port number. If you need different handlers, then use different port numbers."},"cookieHandler":{"index":12,"kind":"parameter","displayName":"Cookie Handler","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.http.base.cookie.CookieHandler","deprecated":false,"autowired":false,"secret":false,"description":"Configure a cookie handler to maintain a HTTP session"},"keepAlive":{"index":13,"kind":"parameter","displayName":"Keep Alive","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","description":"Setting to ensure socket is not closed due to inactivity"},"options":{"index":14,"kind":"parameter","displayName":"Options","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.util.Map","prefix":"option.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Sets additional channel options. The options that can be used are defined in org.xnio.Options. To configure from endpoint uri, then prefix each option with option., such as option.close-abort=true&option.send-buffer=8192"},"preserveHostHeader":{"index":15,"kind":"parameter","displayName":"Preserve Host Header","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If the option is true, UndertowProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service."},"reuseAddresses":{"index":16,"kind":"parameter","displayName":"Reuse Addresses","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","description":"Setting to facilitate socket multiplexing"},"tcpNoDelay":{"index":17,"kind":"parameter","displayName":"Tcp No Delay","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","description":"Setting to improve TCP protocol performance"},"throwExceptionOnFailure":{"index":18,"kind":"parameter","displayName":"Throw Exception On Failure","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","description":"Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code."},"lazyStartProducer":{"index":19,"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."},"accessLogReceiver":{"index":20,"kind":"parameter","displayName":"Access Log Receiver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.undertow.server.handlers.accesslog.AccessLogReceiver","deprecated":false,"autowired":false,"secret":false,"description":"Which Undertow AccessLogReceiver should be used Will use JBossLoggingAccessLogReceiver if not specified"},"headerFilterStrategy":{"index":21,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"undertowHttpBinding":{"index":22,"kind":"parameter","displayName":"Undertow Http Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.undertow.UndertowHttpBinding","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom UndertowHttpBinding to control the mapping between Camel message and undertow."},"allowedRoles":{"index":23,"kind":"parameter","displayName":"Allowed Roles","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Configuration used by UndertowSecurityProvider. Comma separated list of allowed roles."},"securityConfiguration":{"index":24,"kind":"parameter","displayName":"Security Configuration","group":"security","label":"security","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"OConfiguration used by UndertowSecurityProvider. Security configuration object for use from UndertowSecurityProvider. Configuration is UndertowSecurityProvider specific. Each provider decides whether accepts configuration."},"securityProvider":{"index":25,"kind":"parameter","displayName":"Security Provider","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.undertow.spi.UndertowSecurityProvider","deprecated":false,"autowired":false,"secret":false,"description":"Security provider allows plug in the provider, which will be used to secure requests. SPI approach could be used too (endpoint then finds security provider using SPI)."},"sslContextParameters":{"index":26,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"To configure security using SSLContextParameters"},"fireWebSocketChannelEvents":{"index":27,"kind":"parameter","displayName":"Fire Web Socket Channel Events","group":"websocket","label":"consumer,websocket","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"if true, the consumer will post notifications to the route when a new WebSocket peer connects, disconnects, etc. See UndertowConstants.EVENT_TYPE and EventType."},"sendTimeout":{"index":28,"kind":"parameter","displayName":"Send Timeout","group":"websocket","label":"producer,websocket","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Timeout in milliseconds when sending to a websocket channel. The default timeout is 30000 (30 seconds)."},"sendToAll":{"index":29,"kind":"parameter","displayName":"Send To All","group":"websocket","label":"producer,websocket","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"To send to all websocket subscribers. Can be used to configure on endpoint level, instead of having to use the UndertowConstants.SEND_TO_ALL header on the message."}}} +{"component":{"kind":"component","name":"undertow","title":"Undertow","description":"Expose HTTP and WebSocket endpoints and access external HTTP/WebSocket servers.","deprecated":false,"firstVersion":"2.16.0","label":"http,networking","javaType":"org.apache.camel.component.undertow.UndertowComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-undertow","version":"4.8.2","scheme":"undertow","extendsScheme":"","syntax":"undertow:httpURI","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true,"verifiers":"parameters,connectivity"},"headers":{"websocket.connectionKey":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"An identifier of WebSocketChannel through which the message was received or should be sent.","constantName":"org.apache.camel.component.undertow.UndertowConstants#CONNECTION_KEY"},"websocket.connectionKey.list":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of websocket connection keys","constantName":"org.apache.camel.component.undertow.UndertowConstants#CONNECTION_KEY_LIST"},"websocket.sendToAll":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To send to all websocket subscribers. Can be used to configure on endpoint level, instead of having to use the UndertowConstants.SEND_TO_ALL header on the message.","constantName":"org.apache.camel.component.undertow.UndertowConstants#SEND_TO_ALL"},"websocket.eventType":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The numeric identifier of the type of websocket event","constantName":"org.apache.camel.component.undertow.UndertowConstants#EVENT_TYPE"},"websocket.eventTypeEnum":{"index":4,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.undertow.UndertowConstants.EventType","enum":["ONOPEN","ONCLOSE","ONERROR"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of websocket event","constantName":"org.apache.camel.component.undertow.UndertowConstants#EVENT_TYPE_ENUM"},"websocket.channel":{"index":5,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.undertow.websockets.core.WebSocketChannel","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The WebSocketChannel through which the message was received","constantName":"org.apache.camel.component.undertow.UndertowConstants#CHANNEL"},"websocket.exchange":{"index":6,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.undertow.websockets.spi.WebSocketHttpExchange","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The exchange for the websocket transport, only available for ON_OPEN events","constantName":"org.apache.camel.component.undertow.UndertowConstants#EXCHANGE"},"CamelHttpResponseCode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http response code","constantName":"org.apache.camel.component.undertow.UndertowConstants#HTTP_RESPONSE_CODE"},"Content-Type":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type","constantName":"org.apache.camel.component.undertow.UndertowConstants#CONTENT_TYPE"},"CamelHttpCharacterEncoding":{"index":9,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http character encoding","constantName":"org.apache.camel.component.undertow.UndertowConstants#HTTP_CHARACTER_ENCODING"},"CamelHttpPath":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http path","constantName":"org.apache.camel.component.undertow.UndertowConstants#HTTP_PATH"},"CamelHttpQuery":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http query","constantName":"org.apache.camel.component.undertow.UndertowConstants#HTTP_QUERY"},"CamelHttpUri":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http URI","constantName":"org.apache.camel.component.undertow.UndertowConstants#HTTP_URI"},"CamelHttpMethod":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http method","constantName":"org.apache.camel.component.undertow.UndertowConstants#HTTP_METHOD"},"Host":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The host http header","constantName":"org.apache.camel.component.undertow.UndertowConstants#HOST_STRING"}},"properties":{"httpURI":{"index":0,"kind":"path","displayName":"Http URI","group":"common","label":"","required":true,"type":"string","javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The url of the HTTP endpoint to use."},"useStreaming":{"index":1,"kind":"parameter","displayName":"Use Streaming","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"For HTTP endpoint: if true, text and binary messages will be wrapped as java.io.InputStream before they are passed to an Exchange; otherwise they will be passed as byte. For WebSocket endpoint: if true, text and binary messages will be wrapped as java.io.Reader and java.io.InputStream respectively before they are passed to an Exchange; otherwise they will be passed as String and byte respectively."},"accessLog":{"index":2,"kind":"parameter","displayName":"Access Log","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Whether or not the consumer should write access log"},"httpMethodRestrict":{"index":3,"kind":"parameter","displayName":"Http Method Restrict","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma."},"matchOnUriPrefix":{"index":4,"kind":"parameter","displayName":"Match On Uri Prefix","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found."},"muteException":{"index":5,"kind":"parameter","displayName":"Mute Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace."},"optionsEnabled":{"index":6,"kind":"parameter","displayName":"Options Enabled","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off."},"transferException":{"index":7,"kind":"parameter","displayName":"Transfer Exception","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","description":"If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"handlers":{"index":11,"kind":"parameter","displayName":"Handlers","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Specifies a comma-delimited set of io.undertow.server.HttpHandler instances to lookup in your Registry. These handlers are added to the Undertow handler chain (for example, to add security). Important: You can not use different handlers with different Undertow endpoints using the same port number. The handlers is associated to the port number. If you need different handlers, then use different port numbers."},"cookieHandler":{"index":12,"kind":"parameter","displayName":"Cookie Handler","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.http.base.cookie.CookieHandler","deprecated":false,"autowired":false,"secret":false,"description":"Configure a cookie handler to maintain a HTTP session"},"keepAlive":{"index":13,"kind":"parameter","displayName":"Keep Alive","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","description":"Setting to ensure socket is not closed due to inactivity"},"options":{"index":14,"kind":"parameter","displayName":"Options","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.util.Map","prefix":"option.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Sets additional channel options. The options that can be used are defined in org.xnio.Options. To configure from endpoint uri, then prefix each option with option., such as option.close-abort=true&option.send-buffer=8192"},"preserveHostHeader":{"index":15,"kind":"parameter","displayName":"Preserve Host Header","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If the option is true, UndertowProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service."},"reuseAddresses":{"index":16,"kind":"parameter","displayName":"Reuse Addresses","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","description":"Setting to facilitate socket multiplexing"},"tcpNoDelay":{"index":17,"kind":"parameter","displayName":"Tcp No Delay","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","description":"Setting to improve TCP protocol performance"},"throwExceptionOnFailure":{"index":18,"kind":"parameter","displayName":"Throw Exception On Failure","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","description":"Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code."},"lazyStartProducer":{"index":19,"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."},"accessLogReceiver":{"index":20,"kind":"parameter","displayName":"Access Log Receiver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"io.undertow.server.handlers.accesslog.AccessLogReceiver","deprecated":false,"autowired":false,"secret":false,"description":"Which Undertow AccessLogReceiver should be used Will use JBossLoggingAccessLogReceiver if not specified"},"headerFilterStrategy":{"index":21,"kind":"parameter","displayName":"Header Filter Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"undertowHttpBinding":{"index":22,"kind":"parameter","displayName":"Undertow Http Binding","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.undertow.UndertowHttpBinding","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom UndertowHttpBinding to control the mapping between Camel message and undertow."},"allowedRoles":{"index":23,"kind":"parameter","displayName":"Allowed Roles","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Configuration used by UndertowSecurityProvider. Comma separated list of allowed roles."},"securityConfiguration":{"index":24,"kind":"parameter","displayName":"Security Configuration","group":"security","label":"security","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"OConfiguration used by UndertowSecurityProvider. Security configuration object for use from UndertowSecurityProvider. Configuration is UndertowSecurityProvider specific. Each provider decides whether accepts configuration."},"securityProvider":{"index":25,"kind":"parameter","displayName":"Security Provider","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.undertow.spi.UndertowSecurityProvider","deprecated":false,"autowired":false,"secret":false,"description":"Security provider allows plug in the provider, which will be used to secure requests. SPI approach could be used too (endpoint then finds security provider using SPI)."},"sslContextParameters":{"index":26,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"To configure security using SSLContextParameters"},"fireWebSocketChannelEvents":{"index":27,"kind":"parameter","displayName":"Fire Web Socket Channel Events","group":"websocket","label":"consumer,websocket","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"if true, the consumer will post notifications to the route when a new WebSocket peer connects, disconnects, etc. See UndertowConstants.EVENT_TYPE and EventType."},"sendTimeout":{"index":28,"kind":"parameter","displayName":"Send Timeout","group":"websocket","label":"producer,websocket","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"Timeout in milliseconds when sending to a websocket channel. The default timeout is 30000 (30 seconds)."},"sendToAll":{"index":29,"kind":"parameter","displayName":"Send To All","group":"websocket","label":"producer,websocket","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"To send to all websocket subscribers. Can be used to configure on endpoint level, instead of having to use the UndertowConstants.SEND_TO_ALL header on the message."}}} , -{"component":{"kind":"component","name":"validator","title":"Validator","description":"Validate the payload using XML Schema and JAXP Validation.","deprecated":false,"firstVersion":"1.1.0","label":"core,validation","javaType":"org.apache.camel.component.validator.ValidatorComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-validator","version":"4.8.1","scheme":"validator","extendsScheme":"","syntax":"validator:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"URL to a local resource on the classpath, or a reference to lookup a bean in the Registry, or a full URL to a remote resource or resource on the file system which contains the XSD to validate against."},"failOnNullBody":{"index":1,"kind":"parameter","displayName":"Fail On Null Body","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to fail if no body exists."},"failOnNullHeader":{"index":2,"kind":"parameter","displayName":"Fail On Null Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to fail if no header exists when validating against a header."},"headerName":{"index":3,"kind":"parameter","displayName":"Header Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To validate against a header instead of the message body."},"lazyStartProducer":{"index":4,"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."},"errorHandler":{"index":5,"kind":"parameter","displayName":"Error Handler","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.support.processor.validation.ValidatorErrorHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler. The default error handler captures the errors and throws an exception."},"resourceResolver":{"index":6,"kind":"parameter","displayName":"Resource Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.w3c.dom.ls.LSResourceResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom LSResourceResolver. Do not use together with resourceResolverFactory"},"resourceResolverFactory":{"index":7,"kind":"parameter","displayName":"Resource Resolver Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.validator.ValidatorResourceResolverFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI. The default resource resolver factory returns a resource resolver which can read files from the class path and file system. Do not use together with resourceResolver."},"schemaFactory":{"index":8,"kind":"parameter","displayName":"Schema Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.validation.SchemaFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom javax.xml.validation.SchemaFactory"},"schemaLanguage":{"index":9,"kind":"parameter","displayName":"Schema Language","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"http://www.w3.org/2001/XMLSchema","description":"Configures the W3C XML Schema Namespace URI."},"useSharedSchema":{"index":10,"kind":"parameter","displayName":"Use Shared Schema","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the Schema instance should be shared or not. This option is introduced to work around a JDK 1.6.x bug. Xerces should not have this issue."}}} +{"component":{"kind":"component","name":"validator","title":"Validator","description":"Validate the payload using XML Schema and JAXP Validation.","deprecated":false,"firstVersion":"1.1.0","label":"core,validation","javaType":"org.apache.camel.component.validator.ValidatorComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-validator","version":"4.8.2","scheme":"validator","extendsScheme":"","syntax":"validator:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"URL to a local resource on the classpath, or a reference to lookup a bean in the Registry, or a full URL to a remote resource or resource on the file system which contains the XSD to validate against."},"failOnNullBody":{"index":1,"kind":"parameter","displayName":"Fail On Null Body","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to fail if no body exists."},"failOnNullHeader":{"index":2,"kind":"parameter","displayName":"Fail On Null Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to fail if no header exists when validating against a header."},"headerName":{"index":3,"kind":"parameter","displayName":"Header Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To validate against a header instead of the message body."},"lazyStartProducer":{"index":4,"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."},"errorHandler":{"index":5,"kind":"parameter","displayName":"Error Handler","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.support.processor.validation.ValidatorErrorHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler. The default error handler captures the errors and throws an exception."},"resourceResolver":{"index":6,"kind":"parameter","displayName":"Resource Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.w3c.dom.ls.LSResourceResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom LSResourceResolver. Do not use together with resourceResolverFactory"},"resourceResolverFactory":{"index":7,"kind":"parameter","displayName":"Resource Resolver Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.validator.ValidatorResourceResolverFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI. The default resource resolver factory returns a resource resolver which can read files from the class path and file system. Do not use together with resourceResolver."},"schemaFactory":{"index":8,"kind":"parameter","displayName":"Schema Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.validation.SchemaFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom javax.xml.validation.SchemaFactory"},"schemaLanguage":{"index":9,"kind":"parameter","displayName":"Schema Language","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"http://www.w3.org/2001/XMLSchema","description":"Configures the W3C XML Schema Namespace URI."},"useSharedSchema":{"index":10,"kind":"parameter","displayName":"Use Shared Schema","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the Schema instance should be shared or not. This option is introduced to work around a JDK 1.6.x bug. Xerces should not have this issue."}}} , -{"component":{"kind":"component","name":"velocity","title":"Velocity","description":"Transform messages using a Velocity template.","deprecated":false,"firstVersion":"1.2.0","label":"transformation","javaType":"org.apache.camel.component.velocity.VelocityComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-velocity","version":"4.8.1","scheme":"velocity","extendsScheme":"","syntax":"velocity:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelVelocityResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the velocity template.","constantName":"org.apache.camel.component.velocity.VelocityConstants#VELOCITY_RESOURCE_URI"},"CamelVelocityTemplate":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content of the velocity template.","constantName":"org.apache.camel.component.velocity.VelocityConstants#VELOCITY_TEMPLATE"},"CamelVelocityContext":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.velocity.context.Context","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The velocity context to use.","constantName":"org.apache.camel.component.velocity.VelocityConstants#VELOCITY_CONTEXT"},"CamelVelocitySupplementalContext":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To add additional information to the used VelocityContext. The value of this header should be a Map with key/values that will added (override any existing key with the same name). This can be used to pre setup some common key/values you want to reuse in your velocity endpoints.","constantName":"org.apache.camel.component.velocity.VelocityConstants#VELOCITY_SUPPLEMENTAL_CONTEXT"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"encoding":{"index":4,"kind":"parameter","displayName":"Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Character encoding of the resource content."},"loaderCache":{"index":5,"kind":"parameter","displayName":"Loader Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Enables / disables the velocity resource loader cache which is enabled by default"},"propertiesFile":{"index":6,"kind":"parameter","displayName":"Properties File","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The URI of the properties file which is used for VelocityEngine initialization."},"lazyStartProducer":{"index":7,"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."}}} +{"component":{"kind":"component","name":"velocity","title":"Velocity","description":"Transform messages using a Velocity template.","deprecated":false,"firstVersion":"1.2.0","label":"transformation","javaType":"org.apache.camel.component.velocity.VelocityComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-velocity","version":"4.8.2","scheme":"velocity","extendsScheme":"","syntax":"velocity:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelVelocityResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the velocity template.","constantName":"org.apache.camel.component.velocity.VelocityConstants#VELOCITY_RESOURCE_URI"},"CamelVelocityTemplate":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content of the velocity template.","constantName":"org.apache.camel.component.velocity.VelocityConstants#VELOCITY_TEMPLATE"},"CamelVelocityContext":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.velocity.context.Context","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The velocity context to use.","constantName":"org.apache.camel.component.velocity.VelocityConstants#VELOCITY_CONTEXT"},"CamelVelocitySupplementalContext":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To add additional information to the used VelocityContext. The value of this header should be a Map with key/values that will added (override any existing key with the same name). This can be used to pre setup some common key/values you want to reuse in your velocity endpoints.","constantName":"org.apache.camel.component.velocity.VelocityConstants#VELOCITY_SUPPLEMENTAL_CONTEXT"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"index":1,"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"encoding":{"index":4,"kind":"parameter","displayName":"Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Character encoding of the resource content."},"loaderCache":{"index":5,"kind":"parameter","displayName":"Loader Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Enables / disables the velocity resource loader cache which is enabled by default"},"propertiesFile":{"index":6,"kind":"parameter","displayName":"Properties File","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The URI of the properties file which is used for VelocityEngine initialization."},"lazyStartProducer":{"index":7,"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."}}} , -{"component":{"kind":"component","name":"vertx","title":"Vert.x","description":"Send and receive messages to/from Vert.x Event Bus.","deprecated":false,"firstVersion":"2.12.0","label":"messaging","javaType":"org.apache.camel.component.vertx.VertxComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-vertx","version":"4.8.1","scheme":"vertx","extendsScheme":"","syntax":"vertx:address","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"address":{"index":0,"kind":"path","displayName":"Address","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the event bus address used to communicate"},"pubSub":{"index":1,"kind":"parameter","displayName":"Pub Sub","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Whether to use publish/subscribe instead of point to point when sending to a vertx endpoint."},"bridgeErrorHandler":{"index":2,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":3,"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":{"index":4,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":5,"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."}}} +{"component":{"kind":"component","name":"vertx","title":"Vert.x","description":"Send and receive messages to/from Vert.x Event Bus.","deprecated":false,"firstVersion":"2.12.0","label":"messaging","javaType":"org.apache.camel.component.vertx.VertxComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-vertx","version":"4.8.2","scheme":"vertx","extendsScheme":"","syntax":"vertx:address","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"address":{"index":0,"kind":"path","displayName":"Address","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the event bus address used to communicate"},"pubSub":{"index":1,"kind":"parameter","displayName":"Pub Sub","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Whether to use publish/subscribe instead of point to point when sending to a vertx endpoint."},"bridgeErrorHandler":{"index":2,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":3,"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":{"index":4,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":5,"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."}}} , -{"component":{"kind":"component","name":"vertx-http","title":"Vert.x HTTP Client","description":"Send requests to external HTTP servers using Vert.x","deprecated":false,"firstVersion":"3.5.0","label":"http","javaType":"org.apache.camel.component.vertx.http.VertxHttpComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-vertx-http","version":"4.8.1","scheme":"vertx-http","extendsScheme":"","syntax":"vertx-http:httpUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"remote":true},"headers":{"CamelHttpMethod":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"io.vertx.core.http.HttpMethod","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http method","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#HTTP_METHOD"},"CamelHttpResponseCode":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP response code from the external server.","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#HTTP_RESPONSE_CODE"},"CamelHttpResponseText":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP response text from the external server.","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#HTTP_RESPONSE_TEXT"},"Content-Type":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP content type. Is set on both the IN and OUT message to provide a content type, such as text/html.","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#CONTENT_TYPE"},"CamelHttpQuery":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URI parameters. Will override existing URI parameters set directly on the endpoint.","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#HTTP_QUERY"},"CamelHttpUri":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URI to call. Will override the existing URI set directly on the endpoint. This URI is the URI of the http server to call. Its not the same as the Camel endpoint URI, where you can configure endpoint options such as security etc. This header does not support that, its only the URI of the http server.","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#HTTP_URI"},"CamelHttpPath":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Request URI's path, the header will be used to build the request URI with the HTTP_URI.","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#HTTP_PATH"},"Content-Encoding":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP content encoding. Is set to provide a content encoding, such as gzip.","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#CONTENT_ENCODING"}},"properties":{"httpUri":{"index":0,"kind":"path","displayName":"Http Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The HTTP URI to connect to"},"connectTimeout":{"index":1,"kind":"parameter","displayName":"Connect Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The amount of time in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout."},"cookieStore":{"index":2,"kind":"parameter","displayName":"Cookie Store","group":"producer","label":"producer","required":false,"type":"object","javaType":"io.vertx.ext.web.client.spi.CookieStore","deprecated":false,"autowired":false,"secret":false,"defaultValue":"InMemoryCookieStore","configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"A custom CookieStore to use when session management is enabled. If this option is not set then an in-memory CookieStore is used"},"headerFilterStrategy":{"index":3,"kind":"parameter","displayName":"Header Filter Strategy","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"defaultValue":"VertxHttpHeaderFilterStrategy","configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"A custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message."},"httpMethod":{"index":4,"kind":"parameter","displayName":"Http Method","group":"producer","label":"producer","required":false,"type":"object","javaType":"io.vertx.core.http.HttpMethod","enum":["OPTIONS","GET","HEAD","POST","PUT","DELETE","TRACE","CONNECT","PATCH","PROPFIND","PROPPATCH","MKCOL","COPY","MOVE","LOCK","UNLOCK","MKCALENDAR","VERSION_CONTROL","REPORT","CHECKIN","CHECKOUT","UNCHECKOUT","MKWORKSPACE","UPDATE","LABEL","MERGE","BASELINE_CONTROL","MKACTIVITY","ORDERPATCH","ACL","SEARCH"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The HTTP method to use. The HttpMethod header cannot override this option if set"},"okStatusCodeRange":{"index":5,"kind":"parameter","displayName":"Ok Status Code Range","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"200-299","configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included"},"responsePayloadAsByteArray":{"index":6,"kind":"parameter","displayName":"Response Payload As Byte Array","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"Whether the response body should be byte or as io.vertx.core.buffer.Buffer"},"sessionManagement":{"index":7,"kind":"parameter","displayName":"Session Management","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"Enables session management via WebClientSession. By default the client is configured to use an in-memory CookieStore. The cookieStore option can be used to override this"},"throwExceptionOnFailure":{"index":8,"kind":"parameter","displayName":"Throw Exception On Failure","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"Disable throwing HttpOperationFailedException in case of failed responses from the remote server"},"timeout":{"index":9,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The amount of time in milliseconds after which if the request does not return any data within the timeout period a TimeoutException fails the request. Setting zero or a negative value disables the timeout."},"transferException":{"index":10,"kind":"parameter","displayName":"Transfer Exception","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was sent back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Camel will deserialize the incoming data from the request to a Java object, which can be a potential security risk."},"useCompression":{"index":11,"kind":"parameter","displayName":"Use Compression","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"Set whether compression is enabled to handled compressed (E.g gzipped) responses"},"vertxHttpBinding":{"index":12,"kind":"parameter","displayName":"Vertx Http Binding","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.vertx.http.VertxHttpBinding","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"A custom VertxHttpBinding which can control how to bind between Vert.x and Camel."},"webClientOptions":{"index":13,"kind":"parameter","displayName":"Web Client Options","group":"producer","label":"producer","required":false,"type":"object","javaType":"io.vertx.ext.web.client.WebClientOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"Sets customized options for configuring the Vert.x WebClient"},"lazyStartProducer":{"index":14,"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."},"proxyHost":{"index":15,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The proxy server host address"},"proxyPassword":{"index":16,"kind":"parameter","displayName":"Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The proxy server password if authentication is required"},"proxyPort":{"index":17,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The proxy server port"},"proxyType":{"index":18,"kind":"parameter","displayName":"Proxy Type","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"io.vertx.core.net.ProxyType","enum":["HTTP","SOCKS4","SOCKS5"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The proxy server type"},"proxyUsername":{"index":19,"kind":"parameter","displayName":"Proxy Username","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The proxy server username if authentication is required"},"basicAuthPassword":{"index":20,"kind":"parameter","displayName":"Basic Auth Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The password to use for basic authentication"},"basicAuthUsername":{"index":21,"kind":"parameter","displayName":"Basic Auth Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The user name to use for basic authentication"},"bearerToken":{"index":22,"kind":"parameter","displayName":"Bearer Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The bearer token to use for bearer token authentication"},"sslContextParameters":{"index":23,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}}} +{"component":{"kind":"component","name":"vertx-http","title":"Vert.x HTTP Client","description":"Send requests to external HTTP servers using Vert.x","deprecated":false,"firstVersion":"3.5.0","label":"http","javaType":"org.apache.camel.component.vertx.http.VertxHttpComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-vertx-http","version":"4.8.2","scheme":"vertx-http","extendsScheme":"","syntax":"vertx-http:httpUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"remote":true},"headers":{"CamelHttpMethod":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"io.vertx.core.http.HttpMethod","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http method","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#HTTP_METHOD"},"CamelHttpResponseCode":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP response code from the external server.","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#HTTP_RESPONSE_CODE"},"CamelHttpResponseText":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP response text from the external server.","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#HTTP_RESPONSE_TEXT"},"Content-Type":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP content type. Is set on both the IN and OUT message to provide a content type, such as text/html.","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#CONTENT_TYPE"},"CamelHttpQuery":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URI parameters. Will override existing URI parameters set directly on the endpoint.","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#HTTP_QUERY"},"CamelHttpUri":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URI to call. Will override the existing URI set directly on the endpoint. This URI is the URI of the http server to call. Its not the same as the Camel endpoint URI, where you can configure endpoint options such as security etc. This header does not support that, its only the URI of the http server.","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#HTTP_URI"},"CamelHttpPath":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Request URI's path, the header will be used to build the request URI with the HTTP_URI.","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#HTTP_PATH"},"Content-Encoding":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP content encoding. Is set to provide a content encoding, such as gzip.","constantName":"org.apache.camel.component.vertx.http.VertxHttpConstants#CONTENT_ENCODING"}},"properties":{"httpUri":{"index":0,"kind":"path","displayName":"Http Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The HTTP URI to connect to"},"connectTimeout":{"index":1,"kind":"parameter","displayName":"Connect Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The amount of time in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout."},"cookieStore":{"index":2,"kind":"parameter","displayName":"Cookie Store","group":"producer","label":"producer","required":false,"type":"object","javaType":"io.vertx.ext.web.client.spi.CookieStore","deprecated":false,"autowired":false,"secret":false,"defaultValue":"InMemoryCookieStore","configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"A custom CookieStore to use when session management is enabled. If this option is not set then an in-memory CookieStore is used"},"headerFilterStrategy":{"index":3,"kind":"parameter","displayName":"Header Filter Strategy","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"defaultValue":"VertxHttpHeaderFilterStrategy","configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"A custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message."},"httpMethod":{"index":4,"kind":"parameter","displayName":"Http Method","group":"producer","label":"producer","required":false,"type":"object","javaType":"io.vertx.core.http.HttpMethod","enum":["OPTIONS","GET","HEAD","POST","PUT","DELETE","TRACE","CONNECT","PATCH","PROPFIND","PROPPATCH","MKCOL","COPY","MOVE","LOCK","UNLOCK","MKCALENDAR","VERSION_CONTROL","REPORT","CHECKIN","CHECKOUT","UNCHECKOUT","MKWORKSPACE","UPDATE","LABEL","MERGE","BASELINE_CONTROL","MKACTIVITY","ORDERPATCH","ACL","SEARCH"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The HTTP method to use. The HttpMethod header cannot override this option if set"},"okStatusCodeRange":{"index":5,"kind":"parameter","displayName":"Ok Status Code Range","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"200-299","configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included"},"responsePayloadAsByteArray":{"index":6,"kind":"parameter","displayName":"Response Payload As Byte Array","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"Whether the response body should be byte or as io.vertx.core.buffer.Buffer"},"sessionManagement":{"index":7,"kind":"parameter","displayName":"Session Management","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"Enables session management via WebClientSession. By default the client is configured to use an in-memory CookieStore. The cookieStore option can be used to override this"},"throwExceptionOnFailure":{"index":8,"kind":"parameter","displayName":"Throw Exception On Failure","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"Disable throwing HttpOperationFailedException in case of failed responses from the remote server"},"timeout":{"index":9,"kind":"parameter","displayName":"Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The amount of time in milliseconds after which if the request does not return any data within the timeout period a TimeoutException fails the request. Setting zero or a negative value disables the timeout."},"transferException":{"index":10,"kind":"parameter","displayName":"Transfer Exception","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was sent back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Camel will deserialize the incoming data from the request to a Java object, which can be a potential security risk."},"useCompression":{"index":11,"kind":"parameter","displayName":"Use Compression","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"Set whether compression is enabled to handled compressed (E.g gzipped) responses"},"vertxHttpBinding":{"index":12,"kind":"parameter","displayName":"Vertx Http Binding","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.vertx.http.VertxHttpBinding","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"A custom VertxHttpBinding which can control how to bind between Vert.x and Camel."},"webClientOptions":{"index":13,"kind":"parameter","displayName":"Web Client Options","group":"producer","label":"producer","required":false,"type":"object","javaType":"io.vertx.ext.web.client.WebClientOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"Sets customized options for configuring the Vert.x WebClient"},"lazyStartProducer":{"index":14,"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."},"proxyHost":{"index":15,"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The proxy server host address"},"proxyPassword":{"index":16,"kind":"parameter","displayName":"Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The proxy server password if authentication is required"},"proxyPort":{"index":17,"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The proxy server port"},"proxyType":{"index":18,"kind":"parameter","displayName":"Proxy Type","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"io.vertx.core.net.ProxyType","enum":["HTTP","SOCKS4","SOCKS5"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The proxy server type"},"proxyUsername":{"index":19,"kind":"parameter","displayName":"Proxy Username","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The proxy server username if authentication is required"},"basicAuthPassword":{"index":20,"kind":"parameter","displayName":"Basic Auth Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The password to use for basic authentication"},"basicAuthUsername":{"index":21,"kind":"parameter","displayName":"Basic Auth Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The user name to use for basic authentication"},"bearerToken":{"index":22,"kind":"parameter","displayName":"Bearer Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"The bearer token to use for bearer token authentication"},"sslContextParameters":{"index":23,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.http.VertxHttpConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}}} , -{"component":{"kind":"component","name":"vertx-websocket","title":"Vert.x WebSocket","description":"Expose WebSocket endpoints and connect to remote WebSocket servers using Vert.x","deprecated":false,"firstVersion":"3.5.0","label":"http,networking","javaType":"org.apache.camel.component.vertx.websocket.VertxWebsocketComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-vertx-websocket","version":"4.8.1","scheme":"vertx-websocket","extendsScheme":"","syntax":"vertx-websocket:host:port/path","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelVertxWebsocket.connectionKey":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sends the message to the client with the given connection key. You can use a comma separated list of keys to send a message to multiple clients. Note that this option only applies when producing messages to endpoints hosted by the vertx-websocket consumer and not to an externally hosted WebSocket.","constantName":"org.apache.camel.component.vertx.websocket.VertxWebsocketConstants#CONNECTION_KEY"},"CamelVertxWebsocket.sendToAll":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sends the message to all clients which are currently connected. You can use the sendToAll option on the endpoint instead of using this header. Note that this option only applies when producing messages to endpoints hosted by the vertx-websocket consumer and not to an externally hosted WebSocket.","constantName":"org.apache.camel.component.vertx.websocket.VertxWebsocketConstants#SEND_TO_ALL"},"CamelVertxWebsocket.remoteAddress":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.vertx.core.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote address.","constantName":"org.apache.camel.component.vertx.websocket.VertxWebsocketConstants#REMOTE_ADDRESS"},"CamelVertxWebsocket.event":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.vertx.websocket.VertxWebsocketEvent","enum":["CLOSE","ERROR","MESSAGE","OPEN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The WebSocket event that triggered the message exchange.","constantName":"org.apache.camel.component.vertx.websocket.VertxWebsocketConstants#EVENT"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"WebSocket hostname, such as localhost or a remote host when in client mode."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"WebSocket port number to use."},"path":{"index":2,"kind":"path","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"WebSocket path to use."},"allowedOriginPattern":{"index":3,"kind":"parameter","displayName":"Allowed Origin Pattern","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Regex pattern to match the origin header sent by WebSocket clients"},"allowOriginHeader":{"index":4,"kind":"parameter","displayName":"Allow Origin Header","group":"consumer","label":"producer,consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Whether the WebSocket client should add the Origin header to the WebSocket handshake request."},"consumeAsClient":{"index":5,"kind":"parameter","displayName":"Consume As Client","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"When set to true, the consumer acts as a WebSocket client, creating exchanges on each received WebSocket event."},"fireWebSocketConnectionEvents":{"index":6,"kind":"parameter","displayName":"Fire Web Socket Connection Events","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Whether the server consumer will create a message exchange when a new WebSocket peer connects or disconnects"},"handshakeHeaders":{"index":7,"kind":"parameter","displayName":"Handshake Headers","group":"consumer","label":"producer,consumer","required":false,"type":"object","javaType":"java.util.Map","prefix":"handshake.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Headers to send in the HTTP handshake request. When the endpoint is a consumer, it only works when it consumes a remote host as a client (i.e. consumeAsClient is true)."},"maxReconnectAttempts":{"index":8,"kind":"parameter","displayName":"Max Reconnect Attempts","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"When consumeAsClient is set to true this sets the maximum number of allowed reconnection attempts to a previously closed WebSocket. A value of 0 (the default) will attempt to reconnect indefinitely."},"originHeaderUrl":{"index":9,"kind":"parameter","displayName":"Origin Header Url","group":"consumer","label":"producer,consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"The value of the Origin header that the WebSocket client should use on the WebSocket handshake request. When not specified, the WebSocket client will automatically determine the value for the Origin from the request URL."},"reconnectInitialDelay":{"index":10,"kind":"parameter","displayName":"Reconnect Initial Delay","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"When consumeAsClient is set to true this sets the initial delay in milliseconds before attempting to reconnect to a previously closed WebSocket."},"reconnectInterval":{"index":11,"kind":"parameter","displayName":"Reconnect Interval","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"When consumeAsClient is set to true this sets the interval in milliseconds at which reconnecting to a previously closed WebSocket occurs."},"router":{"index":12,"kind":"parameter","displayName":"Router","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"io.vertx.ext.web.Router","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"To use an existing vertx router for the HTTP server"},"serverOptions":{"index":13,"kind":"parameter","displayName":"Server Options","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"io.vertx.core.http.HttpServerOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer"},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"clientOptions":{"index":17,"kind":"parameter","displayName":"Client Options","group":"producer","label":"producer","required":false,"type":"object","javaType":"io.vertx.core.http.HttpClientOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Sets customized options for configuring the WebSocket client used in the producer"},"clientSubProtocols":{"index":18,"kind":"parameter","displayName":"Client Sub Protocols","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Comma separated list of WebSocket subprotocols that the client should use for the Sec-WebSocket-Protocol header"},"sendToAll":{"index":19,"kind":"parameter","displayName":"Send To All","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"To send to all websocket subscribers. Can be used to configure at the endpoint level, instead of providing the VertxWebsocketConstants.SEND_TO_ALL header on the message. Note that when using this option, the host name specified for the vertx-websocket producer URI must match one used for an existing vertx-websocket consumer. Note that this option only applies when producing messages to endpoints hosted by the vertx-websocket consumer and not to an externally hosted WebSocket."},"lazyStartProducer":{"index":20,"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."},"sslContextParameters":{"index":21,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}}} +{"component":{"kind":"component","name":"vertx-websocket","title":"Vert.x WebSocket","description":"Expose WebSocket endpoints and connect to remote WebSocket servers using Vert.x","deprecated":false,"firstVersion":"3.5.0","label":"http,networking","javaType":"org.apache.camel.component.vertx.websocket.VertxWebsocketComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-vertx-websocket","version":"4.8.2","scheme":"vertx-websocket","extendsScheme":"","syntax":"vertx-websocket:host:port/path","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true,"remote":true},"headers":{"CamelVertxWebsocket.connectionKey":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sends the message to the client with the given connection key. You can use a comma separated list of keys to send a message to multiple clients. Note that this option only applies when producing messages to endpoints hosted by the vertx-websocket consumer and not to an externally hosted WebSocket.","constantName":"org.apache.camel.component.vertx.websocket.VertxWebsocketConstants#CONNECTION_KEY"},"CamelVertxWebsocket.sendToAll":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sends the message to all clients which are currently connected. You can use the sendToAll option on the endpoint instead of using this header. Note that this option only applies when producing messages to endpoints hosted by the vertx-websocket consumer and not to an externally hosted WebSocket.","constantName":"org.apache.camel.component.vertx.websocket.VertxWebsocketConstants#SEND_TO_ALL"},"CamelVertxWebsocket.remoteAddress":{"index":2,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.vertx.core.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote address.","constantName":"org.apache.camel.component.vertx.websocket.VertxWebsocketConstants#REMOTE_ADDRESS"},"CamelVertxWebsocket.event":{"index":3,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.vertx.websocket.VertxWebsocketEvent","enum":["CLOSE","ERROR","MESSAGE","OPEN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The WebSocket event that triggered the message exchange.","constantName":"org.apache.camel.component.vertx.websocket.VertxWebsocketConstants#EVENT"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"WebSocket hostname, such as localhost or a remote host when in client mode."},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"WebSocket port number to use."},"path":{"index":2,"kind":"path","displayName":"Path","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"WebSocket path to use."},"allowedOriginPattern":{"index":3,"kind":"parameter","displayName":"Allowed Origin Pattern","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Regex pattern to match the origin header sent by WebSocket clients"},"allowOriginHeader":{"index":4,"kind":"parameter","displayName":"Allow Origin Header","group":"consumer","label":"producer,consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Whether the WebSocket client should add the Origin header to the WebSocket handshake request."},"consumeAsClient":{"index":5,"kind":"parameter","displayName":"Consume As Client","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"When set to true, the consumer acts as a WebSocket client, creating exchanges on each received WebSocket event."},"fireWebSocketConnectionEvents":{"index":6,"kind":"parameter","displayName":"Fire Web Socket Connection Events","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Whether the server consumer will create a message exchange when a new WebSocket peer connects or disconnects"},"handshakeHeaders":{"index":7,"kind":"parameter","displayName":"Handshake Headers","group":"consumer","label":"producer,consumer","required":false,"type":"object","javaType":"java.util.Map","prefix":"handshake.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Headers to send in the HTTP handshake request. When the endpoint is a consumer, it only works when it consumes a remote host as a client (i.e. consumeAsClient is true)."},"maxReconnectAttempts":{"index":8,"kind":"parameter","displayName":"Max Reconnect Attempts","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"When consumeAsClient is set to true this sets the maximum number of allowed reconnection attempts to a previously closed WebSocket. A value of 0 (the default) will attempt to reconnect indefinitely."},"originHeaderUrl":{"index":9,"kind":"parameter","displayName":"Origin Header Url","group":"consumer","label":"producer,consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"The value of the Origin header that the WebSocket client should use on the WebSocket handshake request. When not specified, the WebSocket client will automatically determine the value for the Origin from the request URL."},"reconnectInitialDelay":{"index":10,"kind":"parameter","displayName":"Reconnect Initial Delay","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"When consumeAsClient is set to true this sets the initial delay in milliseconds before attempting to reconnect to a previously closed WebSocket."},"reconnectInterval":{"index":11,"kind":"parameter","displayName":"Reconnect Interval","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"When consumeAsClient is set to true this sets the interval in milliseconds at which reconnecting to a previously closed WebSocket occurs."},"router":{"index":12,"kind":"parameter","displayName":"Router","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"io.vertx.ext.web.Router","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"To use an existing vertx router for the HTTP server"},"serverOptions":{"index":13,"kind":"parameter","displayName":"Server Options","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"io.vertx.core.http.HttpServerOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer"},"bridgeErrorHandler":{"index":14,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":15,"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":{"index":16,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"clientOptions":{"index":17,"kind":"parameter","displayName":"Client Options","group":"producer","label":"producer","required":false,"type":"object","javaType":"io.vertx.core.http.HttpClientOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Sets customized options for configuring the WebSocket client used in the producer"},"clientSubProtocols":{"index":18,"kind":"parameter","displayName":"Client Sub Protocols","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Comma separated list of WebSocket subprotocols that the client should use for the Sec-WebSocket-Protocol header"},"sendToAll":{"index":19,"kind":"parameter","displayName":"Send To All","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"To send to all websocket subscribers. Can be used to configure at the endpoint level, instead of providing the VertxWebsocketConstants.SEND_TO_ALL header on the message. Note that when using this option, the host name specified for the vertx-websocket producer URI must match one used for an existing vertx-websocket consumer. Note that this option only applies when producing messages to endpoints hosted by the vertx-websocket consumer and not to an externally hosted WebSocket."},"lazyStartProducer":{"index":20,"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."},"sslContextParameters":{"index":21,"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}}} , -{"component":{"kind":"component","name":"wasm","title":"Wasm","description":"Invoke Wasm functions.","deprecated":false,"firstVersion":"4.4.0","label":"core,script","javaType":"org.apache.camel.component.wasm.WasmComponent","supportLevel":"Experimental","groupId":"org.apache.camel","artifactId":"camel-wasm","version":"4.8.1","scheme":"wasm","extendsScheme":"","syntax":"wasm:functionName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"functionName":{"index":0,"kind":"path","displayName":"Function Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Function Name"},"module":{"index":1,"kind":"parameter","displayName":"Module","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.wasm.WasmConfiguration","configurationField":"configuration","description":"Set the module (the distributable, loadable, and executable unit of code in WebAssembly) resource that provides the producer function."},"lazyStartProducer":{"index":2,"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."}}} +{"component":{"kind":"component","name":"wasm","title":"Wasm","description":"Invoke Wasm functions.","deprecated":false,"firstVersion":"4.4.0","label":"core,script","javaType":"org.apache.camel.component.wasm.WasmComponent","supportLevel":"Experimental","groupId":"org.apache.camel","artifactId":"camel-wasm","version":"4.8.2","scheme":"wasm","extendsScheme":"","syntax":"wasm:functionName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"properties":{"functionName":{"index":0,"kind":"path","displayName":"Function Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Function Name"},"module":{"index":1,"kind":"parameter","displayName":"Module","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.wasm.WasmConfiguration","configurationField":"configuration","description":"Set the module (the distributable, loadable, and executable unit of code in WebAssembly) resource that provides the producer function."},"lazyStartProducer":{"index":2,"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."}}} , -{"component":{"kind":"component","name":"weather","title":"Weather","description":"Poll the weather information from Open Weather Map.","deprecated":false,"firstVersion":"2.12.0","label":"api","javaType":"org.apache.camel.component.weather.WeatherComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-weather","version":"4.8.1","scheme":"weather","extendsScheme":"","syntax":"weather:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelWeatherLocation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Used by the producer to override the endpoint location and use the location from this header instead.","constantName":"org.apache.camel.component.weather.WeatherConstants#WEATHER_LOCATION"},"CamelWeatherQuery":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The original query URL sent to the Open Weather Map site","constantName":"org.apache.camel.component.weather.WeatherConstants#WEATHER_QUERY"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"The name value is not used."},"appid":{"index":1,"kind":"parameter","displayName":"Appid","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"APPID ID used to authenticate the user connected to the API Server"},"headerName":{"index":2,"kind":"parameter","displayName":"Header Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"To store the weather result in this header instead of the message body. This is useable if you want to keep current message body as-is."},"language":{"index":3,"kind":"parameter","displayName":"Language","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.weather.WeatherLanguage","enum":["en","ru","it","es","sp","uk","ua","de","pt","ro","pl","fi","nl","fr","bg","sv","se","zh_tw","zh","zh_cn","tr","hr","ca"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"en","configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"Language of the response."},"mode":{"index":4,"kind":"parameter","displayName":"Mode","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.weather.WeatherMode","enum":["HTML","JSON","XML"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"JSON","configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"The output format of the weather data."},"period":{"index":5,"kind":"parameter","displayName":"Period","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"If null, the current weather will be returned, else use values of 5, 7, 14 days. Only the numeric value for the forecast period is actually parsed, so spelling, capitalisation of the time period is up to you (its ignored)"},"units":{"index":6,"kind":"parameter","displayName":"Units","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.weather.WeatherUnits","enum":["IMPERIAL","METRIC"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"The units for temperature measurement."},"weatherApi":{"index":7,"kind":"parameter","displayName":"Weather Api","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.weather.WeatherApi","enum":["Current","Station","Hourly","Daily"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"The API to use (current, forecast/3 hour, forecast daily, station)"},"sendEmptyMessageWhenIdle":{"index":8,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":12,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":13,"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."},"geoLocationProvider":{"index":14,"kind":"parameter","displayName":"Geo Location Provider","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.weather.geolocation.GeoLocationProvider","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"A custum geolocation provider to determine the longitude and latitude to use when no location information is set. The default implementaion uses the ipstack API and requires geolocationAccessKey and geolocationRequestHostIP"},"httpClient":{"index":15,"kind":"parameter","displayName":"Http Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.impl.classic.CloseableHttpClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"To use an existing configured http client (for example with http proxy)"},"cnt":{"index":16,"kind":"parameter","displayName":"Cnt","group":"filter","label":"filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"Number of results to be found"},"ids":{"index":17,"kind":"parameter","displayName":"Ids","group":"filter","label":"filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"List of id's of city/stations. You can separate multiple ids by comma."},"lat":{"index":18,"kind":"parameter","displayName":"Lat","group":"filter","label":"filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"Latitude of location. You can use lat and lon options instead of location. For boxed queries this is the bottom latitude."},"location":{"index":19,"kind":"parameter","displayName":"Location","group":"filter","label":"filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"If null Camel will try and determine your current location using the geolocation of your ip address, else specify the city,country. For well known city names, Open Weather Map will determine the best fit, but multiple results may be returned. Hence specifying and country as well will return more accurate data. If you specify current as the location then the component will try to get the current latitude and longitude and use that to get the weather details. You can use lat and lon options instead of location."},"lon":{"index":20,"kind":"parameter","displayName":"Lon","group":"filter","label":"filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"Longitude of location. You can use lat and lon options instead of location. For boxed queries this is the left longtitude."},"rightLon":{"index":21,"kind":"parameter","displayName":"Right Lon","group":"filter","label":"filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"For boxed queries this is the right longtitude. Needs to be used in combination with topLat and zoom."},"topLat":{"index":22,"kind":"parameter","displayName":"Top Lat","group":"filter","label":"filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"For boxed queries this is the top latitude. Needs to be used in combination with rightLon and zoom."},"zip":{"index":23,"kind":"parameter","displayName":"Zip","group":"filter","label":"filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"Zip-code, e.g. 94040,us"},"zoom":{"index":24,"kind":"parameter","displayName":"Zoom","group":"filter","label":"filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"For boxed queries this is the zoom. Needs to be used in combination with rightLon and topLat."},"backoffErrorThreshold":{"index":25,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":26,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":27,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":28,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":29,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":30,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":31,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":32,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":33,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":34,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":35,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":36,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":37,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":38,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"geolocationAccessKey":{"index":39,"kind":"parameter","displayName":"Geolocation Access Key","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"The geolocation service now needs an accessKey to be used"},"geolocationRequestHostIP":{"index":40,"kind":"parameter","displayName":"Geolocation Request Host IP","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"The geolocation service now needs to specify the IP associated to the accessKey you're using"}}} +{"component":{"kind":"component","name":"weather","title":"Weather","description":"Poll the weather information from Open Weather Map.","deprecated":false,"firstVersion":"2.12.0","label":"api","javaType":"org.apache.camel.component.weather.WeatherComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-weather","version":"4.8.2","scheme":"weather","extendsScheme":"","syntax":"weather:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelWeatherLocation":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Used by the producer to override the endpoint location and use the location from this header instead.","constantName":"org.apache.camel.component.weather.WeatherConstants#WEATHER_LOCATION"},"CamelWeatherQuery":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The original query URL sent to the Open Weather Map site","constantName":"org.apache.camel.component.weather.WeatherConstants#WEATHER_QUERY"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"The name value is not used."},"appid":{"index":1,"kind":"parameter","displayName":"Appid","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"APPID ID used to authenticate the user connected to the API Server"},"headerName":{"index":2,"kind":"parameter","displayName":"Header Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"To store the weather result in this header instead of the message body. This is useable if you want to keep current message body as-is."},"language":{"index":3,"kind":"parameter","displayName":"Language","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.weather.WeatherLanguage","enum":["en","ru","it","es","sp","uk","ua","de","pt","ro","pl","fi","nl","fr","bg","sv","se","zh_tw","zh","zh_cn","tr","hr","ca"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"en","configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"Language of the response."},"mode":{"index":4,"kind":"parameter","displayName":"Mode","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.weather.WeatherMode","enum":["HTML","JSON","XML"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"JSON","configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"The output format of the weather data."},"period":{"index":5,"kind":"parameter","displayName":"Period","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"If null, the current weather will be returned, else use values of 5, 7, 14 days. Only the numeric value for the forecast period is actually parsed, so spelling, capitalisation of the time period is up to you (its ignored)"},"units":{"index":6,"kind":"parameter","displayName":"Units","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.weather.WeatherUnits","enum":["IMPERIAL","METRIC"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"The units for temperature measurement."},"weatherApi":{"index":7,"kind":"parameter","displayName":"Weather Api","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.weather.WeatherApi","enum":["Current","Station","Hourly","Daily"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"The API to use (current, forecast/3 hour, forecast daily, station)"},"sendEmptyMessageWhenIdle":{"index":8,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":9,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":10,"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":{"index":11,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":12,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":13,"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."},"geoLocationProvider":{"index":14,"kind":"parameter","displayName":"Geo Location Provider","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.weather.geolocation.GeoLocationProvider","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"A custum geolocation provider to determine the longitude and latitude to use when no location information is set. The default implementaion uses the ipstack API and requires geolocationAccessKey and geolocationRequestHostIP"},"httpClient":{"index":15,"kind":"parameter","displayName":"Http Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.impl.classic.CloseableHttpClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"To use an existing configured http client (for example with http proxy)"},"cnt":{"index":16,"kind":"parameter","displayName":"Cnt","group":"filter","label":"filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"Number of results to be found"},"ids":{"index":17,"kind":"parameter","displayName":"Ids","group":"filter","label":"filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"List of id's of city/stations. You can separate multiple ids by comma."},"lat":{"index":18,"kind":"parameter","displayName":"Lat","group":"filter","label":"filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"Latitude of location. You can use lat and lon options instead of location. For boxed queries this is the bottom latitude."},"location":{"index":19,"kind":"parameter","displayName":"Location","group":"filter","label":"filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"If null Camel will try and determine your current location using the geolocation of your ip address, else specify the city,country. For well known city names, Open Weather Map will determine the best fit, but multiple results may be returned. Hence specifying and country as well will return more accurate data. If you specify current as the location then the component will try to get the current latitude and longitude and use that to get the weather details. You can use lat and lon options instead of location."},"lon":{"index":20,"kind":"parameter","displayName":"Lon","group":"filter","label":"filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"Longitude of location. You can use lat and lon options instead of location. For boxed queries this is the left longtitude."},"rightLon":{"index":21,"kind":"parameter","displayName":"Right Lon","group":"filter","label":"filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"For boxed queries this is the right longtitude. Needs to be used in combination with topLat and zoom."},"topLat":{"index":22,"kind":"parameter","displayName":"Top Lat","group":"filter","label":"filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"For boxed queries this is the top latitude. Needs to be used in combination with rightLon and zoom."},"zip":{"index":23,"kind":"parameter","displayName":"Zip","group":"filter","label":"filter","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"Zip-code, e.g. 94040,us"},"zoom":{"index":24,"kind":"parameter","displayName":"Zoom","group":"filter","label":"filter","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"For boxed queries this is the zoom. Needs to be used in combination with rightLon and topLat."},"backoffErrorThreshold":{"index":25,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":26,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":27,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":28,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":29,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":30,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":31,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":32,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":33,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":34,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":35,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":36,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":37,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":38,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"geolocationAccessKey":{"index":39,"kind":"parameter","displayName":"Geolocation Access Key","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"The geolocation service now needs an accessKey to be used"},"geolocationRequestHostIP":{"index":40,"kind":"parameter","displayName":"Geolocation Request Host IP","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.weather.WeatherConfiguration","configurationField":"configuration","description":"The geolocation service now needs to specify the IP associated to the accessKey you're using"}}} , -{"component":{"kind":"component","name":"web3j","title":"Web3j Ethereum Blockchain","description":"Interact with Ethereum nodes using web3j client API.","deprecated":false,"firstVersion":"2.22.0","label":"blockchain","javaType":"org.apache.camel.component.web3j.Web3jComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-web3j","version":"4.8.1","scheme":"web3j","extendsScheme":"","syntax":"web3j:nodeAddress","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"ETH_HASHRATE":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A hexadecimal string representation (32 bytes) of the hash rate.","constantName":"org.apache.camel.component.web3j.Web3jConstants#ETH_HASHRATE"},"ID":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id","constantName":"org.apache.camel.component.web3j.Web3jConstants#ID"},"AT_BLOCK":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The block number, or the string latest for the last mined block or pending, earliest for not yet mined transactions.","constantName":"org.apache.camel.component.web3j.Web3jConstants#AT_BLOCK"},"ADDRESS":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Contract address.","constantName":"org.apache.camel.component.web3j.Web3jConstants#ADDRESS"},"ADDRESSES":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Contract address or a list of addresses.","constantName":"org.apache.camel.component.web3j.Web3jConstants#ADDRESSES"},"FROM_ADDRESS":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The address the transaction is send from","constantName":"org.apache.camel.component.web3j.Web3jConstants#FROM_ADDRESS"},"TO_ADDRESS":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The address the transaction is directed to","constantName":"org.apache.camel.component.web3j.Web3jConstants#TO_ADDRESS"},"POSITION":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The transaction index position withing a block.","constantName":"org.apache.camel.component.web3j.Web3jConstants#POSITION"},"BLOCK_HASH":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hash of the block where this transaction was in.","constantName":"org.apache.camel.component.web3j.Web3jConstants#BLOCK_HASH"},"TRANSACTION_HASH":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The information about a transaction requested by transaction hash.","constantName":"org.apache.camel.component.web3j.Web3jConstants#TRANSACTION_HASH"},"SHA3_HASH_OF_DATA_TO_SIGN":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Message to sign by calculating an Ethereum specific signature.","constantName":"org.apache.camel.component.web3j.Web3jConstants#SHA3_HASH_OF_DATA_TO_SIGN"},"SIGNED_TRANSACTION_DATA":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The signed transaction data for a new message call transaction or a contract creation for signed transactions.","constantName":"org.apache.camel.component.web3j.Web3jConstants#SIGNED_TRANSACTION_DATA"},"FULL_TRANSACTION_OBJECTS":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If true it returns the full transaction objects, if false only the hashes of the transactions.","constantName":"org.apache.camel.component.web3j.Web3jConstants#FULL_TRANSACTION_OBJECTS"},"INDEX":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The transactions/uncle index position in the block.","constantName":"org.apache.camel.component.web3j.Web3jConstants#INDEX"},"SOURCE_CODE":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The source code to compile.","constantName":"org.apache.camel.component.web3j.Web3jConstants#SOURCE_CODE"},"FILTER_ID":{"index":15,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.math.BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The filter id to use.","constantName":"org.apache.camel.component.web3j.Web3jConstants#FILTER_ID"},"DATABASE_NAME":{"index":16,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local database name.","constantName":"org.apache.camel.component.web3j.Web3jConstants#DATABASE_NAME"},"KEY_NAME":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key name in the database.","constantName":"org.apache.camel.component.web3j.Web3jConstants#KEY_NAME"},"NONCE":{"index":18,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.math.BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The nonce found (64 bits) used for submitting a proof-of-work solution.","constantName":"org.apache.camel.component.web3j.Web3jConstants#NONCE"},"HEADER_POW_HASH":{"index":19,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The header's pow-hash (256 bits) used for submitting a proof-of-work solution.","constantName":"org.apache.camel.component.web3j.Web3jConstants#HEADER_POW_HASH"},"MIX_DIGEST":{"index":20,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The mix digest (256 bits) used for submitting a proof-of-work solution.","constantName":"org.apache.camel.component.web3j.Web3jConstants#MIX_DIGEST"},"CLIENT_ID":{"index":21,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A random hexadecimal(32 bytes) ID identifying the client.","constantName":"org.apache.camel.component.web3j.Web3jConstants#CLIENT_ID"},"GAS_PRICE":{"index":22,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.math.BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gas price used for each paid gas.","constantName":"org.apache.camel.component.web3j.Web3jConstants#GAS_PRICE"},"GAS_LIMIT":{"index":23,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.math.BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum gas allowed in this block.","constantName":"org.apache.camel.component.web3j.Web3jConstants#GAS_LIMIT"},"VALUE":{"index":24,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.math.BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value sent within a transaction.","constantName":"org.apache.camel.component.web3j.Web3jConstants#VALUE"},"DATA":{"index":25,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The compiled code of a contract OR the hash of the invoked method signature and encoded parameters.","constantName":"org.apache.camel.component.web3j.Web3jConstants#DATA"},"FROM_BLOCK":{"index":26,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The block number, or the string latest for the last mined block or pending, earliest for not yet mined transactions.","constantName":"org.apache.camel.component.web3j.Web3jConstants#FROM_BLOCK"},"TO_BLOCK":{"index":27,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The block number, or the string latest for the last mined block or pending, earliest for not yet mined transactions.","constantName":"org.apache.camel.component.web3j.Web3jConstants#TO_BLOCK"},"TOPICS":{"index":28,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Topics are order-dependent. Each topic can also be a list of topics. Specify multiple topics separated by comma.","constantName":"org.apache.camel.component.web3j.Web3jConstants#TOPICS"},"PRIORITY":{"index":29,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.math.BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The priority of a whisper message.","constantName":"org.apache.camel.component.web3j.Web3jConstants#PRIORITY"},"TTL":{"index":30,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.math.BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time to live in seconds of a whisper message.","constantName":"org.apache.camel.component.web3j.Web3jConstants#TTL"},"PRIVATE_FOR":{"index":31,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A transaction privateFor nodes with public keys in a Quorum network","constantName":"org.apache.camel.component.web3j.Web3jConstants#PRIVATE_FOR"},"PRIVATE_FROM":{"index":32,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A transaction privateFrom","constantName":"org.apache.camel.component.web3j.Web3jConstants#PRIVATE_FROM"},"ERROR_CODE":{"index":33,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The error code","constantName":"org.apache.camel.component.web3j.Web3jConstants#ERROR_CODE"},"ERROR_DATA":{"index":34,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The error data","constantName":"org.apache.camel.component.web3j.Web3jConstants#ERROR_DATA"},"ERROR_MESSAGE":{"index":35,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The error message","constantName":"org.apache.camel.component.web3j.Web3jConstants#ERROR_MESSAGE"},"status":{"index":36,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The status of the operation","constantName":"org.apache.camel.component.web3j.Web3jConstants#HEADER_STATUS"},"operation":{"index":37,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation","constantName":"org.apache.camel.component.web3j.Web3jConstants#HEADER_OPERATION"}},"properties":{"nodeAddress":{"index":0,"kind":"path","displayName":"Node Address","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the node address used to communicate"},"addresses":{"index":1,"kind":"parameter","displayName":"Addresses","group":"common","label":"common","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"Contract address or a list of addresses."},"fromAddress":{"index":2,"kind":"parameter","displayName":"From Address","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The address the transaction is send from"},"fromBlock":{"index":3,"kind":"parameter","displayName":"From Block","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"latest","configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The block number, or the string latest for the last mined block or pending, earliest for not yet mined transactions."},"fullTransactionObjects":{"index":4,"kind":"parameter","displayName":"Full Transaction Objects","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"If true it returns the full transaction objects, if false only the hashes of the transactions."},"gasLimit":{"index":5,"kind":"parameter","displayName":"Gas Limit","group":"common","label":"","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The maximum gas allowed in this block."},"privateFor":{"index":6,"kind":"parameter","displayName":"Private For","group":"common","label":"common","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"A transaction privateFor nodes with public keys in a Quorum network"},"quorumAPI":{"index":7,"kind":"parameter","displayName":"Quorum API","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"If true, this will support Quorum API."},"toAddress":{"index":8,"kind":"parameter","displayName":"To Address","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The address the transaction is directed to."},"toBlock":{"index":9,"kind":"parameter","displayName":"To Block","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"latest","configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The block number, or the string latest for the last mined block or pending, earliest for not yet mined transactions."},"topics":{"index":10,"kind":"parameter","displayName":"Topics","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"Topics are order-dependent. Each topic can also be a list of topics. Specify multiple topics separated by comma."},"web3j":{"index":11,"kind":"parameter","displayName":"Web3j","group":"common","label":"common","required":false,"type":"object","javaType":"org.web3j.protocol.Web3j","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The preconfigured Web3j object."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"address":{"index":15,"kind":"parameter","displayName":"Address","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"Contract address."},"atBlock":{"index":16,"kind":"parameter","displayName":"At Block","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"latest","configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The block number, or the string latest for the last mined block or pending, earliest for not yet mined transactions."},"blockHash":{"index":17,"kind":"parameter","displayName":"Block Hash","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"Hash of the block where this transaction was in."},"clientId":{"index":18,"kind":"parameter","displayName":"Client Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"A random hexadecimal(32 bytes) ID identifying the client."},"data":{"index":19,"kind":"parameter","displayName":"Data","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The compiled code of a contract OR the hash of the invoked method signature and encoded parameters."},"databaseName":{"index":20,"kind":"parameter","displayName":"Database Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The local database name."},"filterId":{"index":21,"kind":"parameter","displayName":"Filter Id","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The filter id to use."},"gasPrice":{"index":22,"kind":"parameter","displayName":"Gas Price","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"Gas price used for each paid gas."},"hashrate":{"index":23,"kind":"parameter","displayName":"Hashrate","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"A hexadecimal string representation (32 bytes) of the hash rate."},"headerPowHash":{"index":24,"kind":"parameter","displayName":"Header Pow Hash","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The header's pow-hash (256 bits) used for submitting a proof-of-work solution."},"index":{"index":25,"kind":"parameter","displayName":"Index","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The transactions/uncle index position in the block."},"keyName":{"index":26,"kind":"parameter","displayName":"Key Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The key name in the database."},"mixDigest":{"index":27,"kind":"parameter","displayName":"Mix Digest","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The mix digest (256 bits) used for submitting a proof-of-work solution."},"nonce":{"index":28,"kind":"parameter","displayName":"Nonce","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The nonce found (64 bits) used for submitting a proof-of-work solution."},"operation":{"index":29,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"transaction","configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"Operation to use."},"position":{"index":30,"kind":"parameter","displayName":"Position","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The transaction index position withing a block."},"priority":{"index":31,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The priority of a whisper message."},"sha3HashOfDataToSign":{"index":32,"kind":"parameter","displayName":"Sha3 Hash Of Data To Sign","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"Message to sign by calculating an Ethereum specific signature."},"signedTransactionData":{"index":33,"kind":"parameter","displayName":"Signed Transaction Data","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The signed transaction data for a new message call transaction or a contract creation for signed transactions."},"sourceCode":{"index":34,"kind":"parameter","displayName":"Source Code","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The source code to compile."},"transactionHash":{"index":35,"kind":"parameter","displayName":"Transaction Hash","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The information about a transaction requested by transaction hash."},"ttl":{"index":36,"kind":"parameter","displayName":"Ttl","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The time to live in seconds of a whisper message."},"value":{"index":37,"kind":"parameter","displayName":"Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The value sent within a transaction."},"lazyStartProducer":{"index":38,"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."}}} +{"component":{"kind":"component","name":"web3j","title":"Web3j Ethereum Blockchain","description":"Interact with Ethereum nodes using web3j client API.","deprecated":false,"firstVersion":"2.22.0","label":"blockchain","javaType":"org.apache.camel.component.web3j.Web3jComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-web3j","version":"4.8.2","scheme":"web3j","extendsScheme":"","syntax":"web3j:nodeAddress","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"ETH_HASHRATE":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A hexadecimal string representation (32 bytes) of the hash rate.","constantName":"org.apache.camel.component.web3j.Web3jConstants#ETH_HASHRATE"},"ID":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id","constantName":"org.apache.camel.component.web3j.Web3jConstants#ID"},"AT_BLOCK":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The block number, or the string latest for the last mined block or pending, earliest for not yet mined transactions.","constantName":"org.apache.camel.component.web3j.Web3jConstants#AT_BLOCK"},"ADDRESS":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Contract address.","constantName":"org.apache.camel.component.web3j.Web3jConstants#ADDRESS"},"ADDRESSES":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Contract address or a list of addresses.","constantName":"org.apache.camel.component.web3j.Web3jConstants#ADDRESSES"},"FROM_ADDRESS":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The address the transaction is send from","constantName":"org.apache.camel.component.web3j.Web3jConstants#FROM_ADDRESS"},"TO_ADDRESS":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The address the transaction is directed to","constantName":"org.apache.camel.component.web3j.Web3jConstants#TO_ADDRESS"},"POSITION":{"index":7,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The transaction index position withing a block.","constantName":"org.apache.camel.component.web3j.Web3jConstants#POSITION"},"BLOCK_HASH":{"index":8,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hash of the block where this transaction was in.","constantName":"org.apache.camel.component.web3j.Web3jConstants#BLOCK_HASH"},"TRANSACTION_HASH":{"index":9,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The information about a transaction requested by transaction hash.","constantName":"org.apache.camel.component.web3j.Web3jConstants#TRANSACTION_HASH"},"SHA3_HASH_OF_DATA_TO_SIGN":{"index":10,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Message to sign by calculating an Ethereum specific signature.","constantName":"org.apache.camel.component.web3j.Web3jConstants#SHA3_HASH_OF_DATA_TO_SIGN"},"SIGNED_TRANSACTION_DATA":{"index":11,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The signed transaction data for a new message call transaction or a contract creation for signed transactions.","constantName":"org.apache.camel.component.web3j.Web3jConstants#SIGNED_TRANSACTION_DATA"},"FULL_TRANSACTION_OBJECTS":{"index":12,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If true it returns the full transaction objects, if false only the hashes of the transactions.","constantName":"org.apache.camel.component.web3j.Web3jConstants#FULL_TRANSACTION_OBJECTS"},"INDEX":{"index":13,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The transactions/uncle index position in the block.","constantName":"org.apache.camel.component.web3j.Web3jConstants#INDEX"},"SOURCE_CODE":{"index":14,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The source code to compile.","constantName":"org.apache.camel.component.web3j.Web3jConstants#SOURCE_CODE"},"FILTER_ID":{"index":15,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.math.BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The filter id to use.","constantName":"org.apache.camel.component.web3j.Web3jConstants#FILTER_ID"},"DATABASE_NAME":{"index":16,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local database name.","constantName":"org.apache.camel.component.web3j.Web3jConstants#DATABASE_NAME"},"KEY_NAME":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key name in the database.","constantName":"org.apache.camel.component.web3j.Web3jConstants#KEY_NAME"},"NONCE":{"index":18,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.math.BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The nonce found (64 bits) used for submitting a proof-of-work solution.","constantName":"org.apache.camel.component.web3j.Web3jConstants#NONCE"},"HEADER_POW_HASH":{"index":19,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The header's pow-hash (256 bits) used for submitting a proof-of-work solution.","constantName":"org.apache.camel.component.web3j.Web3jConstants#HEADER_POW_HASH"},"MIX_DIGEST":{"index":20,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The mix digest (256 bits) used for submitting a proof-of-work solution.","constantName":"org.apache.camel.component.web3j.Web3jConstants#MIX_DIGEST"},"CLIENT_ID":{"index":21,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A random hexadecimal(32 bytes) ID identifying the client.","constantName":"org.apache.camel.component.web3j.Web3jConstants#CLIENT_ID"},"GAS_PRICE":{"index":22,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.math.BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gas price used for each paid gas.","constantName":"org.apache.camel.component.web3j.Web3jConstants#GAS_PRICE"},"GAS_LIMIT":{"index":23,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.math.BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum gas allowed in this block.","constantName":"org.apache.camel.component.web3j.Web3jConstants#GAS_LIMIT"},"VALUE":{"index":24,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.math.BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value sent within a transaction.","constantName":"org.apache.camel.component.web3j.Web3jConstants#VALUE"},"DATA":{"index":25,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The compiled code of a contract OR the hash of the invoked method signature and encoded parameters.","constantName":"org.apache.camel.component.web3j.Web3jConstants#DATA"},"FROM_BLOCK":{"index":26,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The block number, or the string latest for the last mined block or pending, earliest for not yet mined transactions.","constantName":"org.apache.camel.component.web3j.Web3jConstants#FROM_BLOCK"},"TO_BLOCK":{"index":27,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The block number, or the string latest for the last mined block or pending, earliest for not yet mined transactions.","constantName":"org.apache.camel.component.web3j.Web3jConstants#TO_BLOCK"},"TOPICS":{"index":28,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Topics are order-dependent. Each topic can also be a list of topics. Specify multiple topics separated by comma.","constantName":"org.apache.camel.component.web3j.Web3jConstants#TOPICS"},"PRIORITY":{"index":29,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.math.BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The priority of a whisper message.","constantName":"org.apache.camel.component.web3j.Web3jConstants#PRIORITY"},"TTL":{"index":30,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.math.BigInteger","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time to live in seconds of a whisper message.","constantName":"org.apache.camel.component.web3j.Web3jConstants#TTL"},"PRIVATE_FOR":{"index":31,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A transaction privateFor nodes with public keys in a Quorum network","constantName":"org.apache.camel.component.web3j.Web3jConstants#PRIVATE_FOR"},"PRIVATE_FROM":{"index":32,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A transaction privateFrom","constantName":"org.apache.camel.component.web3j.Web3jConstants#PRIVATE_FROM"},"ERROR_CODE":{"index":33,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The error code","constantName":"org.apache.camel.component.web3j.Web3jConstants#ERROR_CODE"},"ERROR_DATA":{"index":34,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The error data","constantName":"org.apache.camel.component.web3j.Web3jConstants#ERROR_DATA"},"ERROR_MESSAGE":{"index":35,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The error message","constantName":"org.apache.camel.component.web3j.Web3jConstants#ERROR_MESSAGE"},"status":{"index":36,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The status of the operation","constantName":"org.apache.camel.component.web3j.Web3jConstants#HEADER_STATUS"},"operation":{"index":37,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation","constantName":"org.apache.camel.component.web3j.Web3jConstants#HEADER_OPERATION"}},"properties":{"nodeAddress":{"index":0,"kind":"path","displayName":"Node Address","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the node address used to communicate"},"addresses":{"index":1,"kind":"parameter","displayName":"Addresses","group":"common","label":"common","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"Contract address or a list of addresses."},"fromAddress":{"index":2,"kind":"parameter","displayName":"From Address","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The address the transaction is send from"},"fromBlock":{"index":3,"kind":"parameter","displayName":"From Block","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"latest","configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The block number, or the string latest for the last mined block or pending, earliest for not yet mined transactions."},"fullTransactionObjects":{"index":4,"kind":"parameter","displayName":"Full Transaction Objects","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"If true it returns the full transaction objects, if false only the hashes of the transactions."},"gasLimit":{"index":5,"kind":"parameter","displayName":"Gas Limit","group":"common","label":"","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The maximum gas allowed in this block."},"privateFor":{"index":6,"kind":"parameter","displayName":"Private For","group":"common","label":"common","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"A transaction privateFor nodes with public keys in a Quorum network"},"quorumAPI":{"index":7,"kind":"parameter","displayName":"Quorum API","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"If true, this will support Quorum API."},"toAddress":{"index":8,"kind":"parameter","displayName":"To Address","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The address the transaction is directed to."},"toBlock":{"index":9,"kind":"parameter","displayName":"To Block","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"latest","configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The block number, or the string latest for the last mined block or pending, earliest for not yet mined transactions."},"topics":{"index":10,"kind":"parameter","displayName":"Topics","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"Topics are order-dependent. Each topic can also be a list of topics. Specify multiple topics separated by comma."},"web3j":{"index":11,"kind":"parameter","displayName":"Web3j","group":"common","label":"common","required":false,"type":"object","javaType":"org.web3j.protocol.Web3j","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The preconfigured Web3j object."},"bridgeErrorHandler":{"index":12,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":13,"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":{"index":14,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"address":{"index":15,"kind":"parameter","displayName":"Address","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"Contract address."},"atBlock":{"index":16,"kind":"parameter","displayName":"At Block","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"latest","configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The block number, or the string latest for the last mined block or pending, earliest for not yet mined transactions."},"blockHash":{"index":17,"kind":"parameter","displayName":"Block Hash","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"Hash of the block where this transaction was in."},"clientId":{"index":18,"kind":"parameter","displayName":"Client Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"A random hexadecimal(32 bytes) ID identifying the client."},"data":{"index":19,"kind":"parameter","displayName":"Data","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The compiled code of a contract OR the hash of the invoked method signature and encoded parameters."},"databaseName":{"index":20,"kind":"parameter","displayName":"Database Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The local database name."},"filterId":{"index":21,"kind":"parameter","displayName":"Filter Id","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The filter id to use."},"gasPrice":{"index":22,"kind":"parameter","displayName":"Gas Price","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"Gas price used for each paid gas."},"hashrate":{"index":23,"kind":"parameter","displayName":"Hashrate","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"A hexadecimal string representation (32 bytes) of the hash rate."},"headerPowHash":{"index":24,"kind":"parameter","displayName":"Header Pow Hash","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The header's pow-hash (256 bits) used for submitting a proof-of-work solution."},"index":{"index":25,"kind":"parameter","displayName":"Index","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The transactions/uncle index position in the block."},"keyName":{"index":26,"kind":"parameter","displayName":"Key Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The key name in the database."},"mixDigest":{"index":27,"kind":"parameter","displayName":"Mix Digest","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The mix digest (256 bits) used for submitting a proof-of-work solution."},"nonce":{"index":28,"kind":"parameter","displayName":"Nonce","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The nonce found (64 bits) used for submitting a proof-of-work solution."},"operation":{"index":29,"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"transaction","configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"Operation to use."},"position":{"index":30,"kind":"parameter","displayName":"Position","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The transaction index position withing a block."},"priority":{"index":31,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The priority of a whisper message."},"sha3HashOfDataToSign":{"index":32,"kind":"parameter","displayName":"Sha3 Hash Of Data To Sign","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"Message to sign by calculating an Ethereum specific signature."},"signedTransactionData":{"index":33,"kind":"parameter","displayName":"Signed Transaction Data","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The signed transaction data for a new message call transaction or a contract creation for signed transactions."},"sourceCode":{"index":34,"kind":"parameter","displayName":"Source Code","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The source code to compile."},"transactionHash":{"index":35,"kind":"parameter","displayName":"Transaction Hash","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The information about a transaction requested by transaction hash."},"ttl":{"index":36,"kind":"parameter","displayName":"Ttl","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The time to live in seconds of a whisper message."},"value":{"index":37,"kind":"parameter","displayName":"Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.math.BigInteger","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.web3j.Web3jConfiguration","configurationField":"configuration","description":"The value sent within a transaction."},"lazyStartProducer":{"index":38,"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."}}} , -{"component":{"kind":"component","name":"webhook","title":"Webhook","description":"Expose webhook endpoints to receive push notifications for other Camel components.","deprecated":false,"firstVersion":"3.0.0","label":"cloud","javaType":"org.apache.camel.component.webhook.WebhookComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-webhook","version":"4.8.1","scheme":"webhook","extendsScheme":"","syntax":"webhook:endpointUri","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":true},"properties":{"endpointUri":{"index":0,"kind":"path","displayName":"Endpoint Uri","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.webhook.WebhookConfiguration","configurationField":"configuration","description":"The delegate uri. Must belong to a component that supports webhooks."},"webhookAutoRegister":{"index":1,"kind":"parameter","displayName":"Webhook Auto Register","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.webhook.WebhookConfiguration","configurationField":"configuration","description":"Automatically register the webhook at startup and unregister it on shutdown."},"webhookBasePath":{"index":2,"kind":"parameter","displayName":"Webhook Base Path","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.webhook.WebhookConfiguration","configurationField":"configuration","description":"The first (base) path element where the webhook will be exposed. It's a good practice to set it to a random string, so that it cannot be guessed by unauthorized parties."},"webhookComponentName":{"index":3,"kind":"parameter","displayName":"Webhook Component Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.webhook.WebhookConfiguration","configurationField":"configuration","description":"The Camel Rest component to use for the REST transport, such as netty-http."},"webhookExternalUrl":{"index":4,"kind":"parameter","displayName":"Webhook External Url","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.webhook.WebhookConfiguration","configurationField":"configuration","description":"The URL of the current service as seen by the webhook provider"},"webhookPath":{"index":5,"kind":"parameter","displayName":"Webhook Path","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.webhook.WebhookConfiguration","configurationField":"configuration","description":"The path where the webhook endpoint will be exposed (relative to basePath, if any)"},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} +{"component":{"kind":"component","name":"webhook","title":"Webhook","description":"Expose webhook endpoints to receive push notifications for other Camel components.","deprecated":false,"firstVersion":"3.0.0","label":"cloud","javaType":"org.apache.camel.component.webhook.WebhookComponent","supportLevel":"Stable","metadata":{"protocol":"http"},"groupId":"org.apache.camel","artifactId":"camel-webhook","version":"4.8.2","scheme":"webhook","extendsScheme":"","syntax":"webhook:endpointUri","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":true},"properties":{"endpointUri":{"index":0,"kind":"path","displayName":"Endpoint Uri","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.webhook.WebhookConfiguration","configurationField":"configuration","description":"The delegate uri. Must belong to a component that supports webhooks."},"webhookAutoRegister":{"index":1,"kind":"parameter","displayName":"Webhook Auto Register","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.webhook.WebhookConfiguration","configurationField":"configuration","description":"Automatically register the webhook at startup and unregister it on shutdown."},"webhookBasePath":{"index":2,"kind":"parameter","displayName":"Webhook Base Path","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.webhook.WebhookConfiguration","configurationField":"configuration","description":"The first (base) path element where the webhook will be exposed. It's a good practice to set it to a random string, so that it cannot be guessed by unauthorized parties."},"webhookComponentName":{"index":3,"kind":"parameter","displayName":"Webhook Component Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.webhook.WebhookConfiguration","configurationField":"configuration","description":"The Camel Rest component to use for the REST transport, such as netty-http."},"webhookExternalUrl":{"index":4,"kind":"parameter","displayName":"Webhook External Url","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.webhook.WebhookConfiguration","configurationField":"configuration","description":"The URL of the current service as seen by the webhook provider"},"webhookPath":{"index":5,"kind":"parameter","displayName":"Webhook Path","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.webhook.WebhookConfiguration","configurationField":"configuration","description":"The path where the webhook endpoint will be exposed (relative to basePath, if any)"},"bridgeErrorHandler":{"index":6,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":7,"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":{"index":8,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} , -{"component":{"kind":"component","name":"whatsapp","title":"WhatsApp","description":"Send messages to WhatsApp.","deprecated":false,"firstVersion":"3.19.0","label":"cloud,api,chat","javaType":"org.apache.camel.component.whatsapp.WhatsAppComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-whatsapp","version":"4.8.1","scheme":"whatsapp","extendsScheme":"","syntax":"whatsapp:phoneNumberId","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelWhatsAppPhoneNumberId":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Phone Number ID taken from WhatsApp Meta for Developers Dashboard","constantName":"org.apache.camel.component.whatsapp.WhatsAppConstants#WHATSAPP_PHONE_NUMBER_ID"},"CamelWhatsAppRecipientPhoneNumberId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Recipient phone number associated with Phone Number ID","constantName":"org.apache.camel.component.whatsapp.WhatsAppConstants#WHATSAPP_RECIPIENT_PHONE_NUMBER_ID"}},"properties":{"phoneNumberId":{"index":0,"kind":"path","displayName":"Phone Number Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.whatsapp.WhatsAppConfiguration","configurationField":"configuration","description":"The phone number ID taken from whatsapp-business dashboard."},"lazyStartProducer":{"index":1,"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."},"apiVersion":{"index":2,"kind":"parameter","displayName":"Api Version","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.whatsapp.WhatsAppConfiguration","configurationField":"configuration","description":"Facebook graph api version."},"baseUri":{"index":3,"kind":"parameter","displayName":"Base Uri","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.whatsapp.WhatsAppConfiguration","configurationField":"configuration","description":"Can be used to set an alternative base URI, e.g. when you want to test the component against a mock WhatsApp API"},"httpClient":{"index":4,"kind":"parameter","displayName":"Http Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.net.http.HttpClient","deprecated":false,"autowired":false,"secret":false,"description":"HttpClient implementation"},"webhookPath":{"index":5,"kind":"parameter","displayName":"Webhook Path","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"webhook","configurationClass":"org.apache.camel.component.whatsapp.WhatsAppConfiguration","configurationField":"configuration","description":"Webhook path"},"webhookVerifyToken":{"index":6,"kind":"parameter","displayName":"Webhook Verify Token","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.whatsapp.WhatsAppConfiguration","configurationField":"configuration","description":"Webhook verify token"},"whatsappService":{"index":7,"kind":"parameter","displayName":"Whatsapp Service","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.whatsapp.WhatsAppService","deprecated":false,"autowired":false,"secret":false,"description":"WhatsApp service implementation"},"authorizationToken":{"index":8,"kind":"parameter","displayName":"Authorization Token","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.whatsapp.WhatsAppConfiguration","configurationField":"configuration","description":"The authorization access token taken from whatsapp-business dashboard."}}} +{"component":{"kind":"component","name":"whatsapp","title":"WhatsApp","description":"Send messages to WhatsApp.","deprecated":false,"firstVersion":"3.19.0","label":"cloud,api,chat","javaType":"org.apache.camel.component.whatsapp.WhatsAppComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-whatsapp","version":"4.8.2","scheme":"whatsapp","extendsScheme":"","syntax":"whatsapp:phoneNumberId","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelWhatsAppPhoneNumberId":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Phone Number ID taken from WhatsApp Meta for Developers Dashboard","constantName":"org.apache.camel.component.whatsapp.WhatsAppConstants#WHATSAPP_PHONE_NUMBER_ID"},"CamelWhatsAppRecipientPhoneNumberId":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Recipient phone number associated with Phone Number ID","constantName":"org.apache.camel.component.whatsapp.WhatsAppConstants#WHATSAPP_RECIPIENT_PHONE_NUMBER_ID"}},"properties":{"phoneNumberId":{"index":0,"kind":"path","displayName":"Phone Number Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.whatsapp.WhatsAppConfiguration","configurationField":"configuration","description":"The phone number ID taken from whatsapp-business dashboard."},"lazyStartProducer":{"index":1,"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."},"apiVersion":{"index":2,"kind":"parameter","displayName":"Api Version","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.whatsapp.WhatsAppConfiguration","configurationField":"configuration","description":"Facebook graph api version."},"baseUri":{"index":3,"kind":"parameter","displayName":"Base Uri","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.whatsapp.WhatsAppConfiguration","configurationField":"configuration","description":"Can be used to set an alternative base URI, e.g. when you want to test the component against a mock WhatsApp API"},"httpClient":{"index":4,"kind":"parameter","displayName":"Http Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.net.http.HttpClient","deprecated":false,"autowired":false,"secret":false,"description":"HttpClient implementation"},"webhookPath":{"index":5,"kind":"parameter","displayName":"Webhook Path","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"webhook","configurationClass":"org.apache.camel.component.whatsapp.WhatsAppConfiguration","configurationField":"configuration","description":"Webhook path"},"webhookVerifyToken":{"index":6,"kind":"parameter","displayName":"Webhook Verify Token","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.whatsapp.WhatsAppConfiguration","configurationField":"configuration","description":"Webhook verify token"},"whatsappService":{"index":7,"kind":"parameter","displayName":"Whatsapp Service","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.whatsapp.WhatsAppService","deprecated":false,"autowired":false,"secret":false,"description":"WhatsApp service implementation"},"authorizationToken":{"index":8,"kind":"parameter","displayName":"Authorization Token","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.whatsapp.WhatsAppConfiguration","configurationField":"configuration","description":"The authorization access token taken from whatsapp-business dashboard."}}} , -{"component":{"kind":"component","name":"wordpress","title":"WordPress","description":"Manage posts and users using the WordPress API.","deprecated":false,"firstVersion":"2.21.0","label":"cloud,api,cms","javaType":"org.apache.camel.component.wordpress.WordpressComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-wordpress","version":"4.8.1","scheme":"wordpress","extendsScheme":"","syntax":"wordpress:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["post","user"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The endpoint operation."},"operationDetail":{"index":1,"kind":"path","displayName":"Operation Detail","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["delete"],"deprecated":false,"autowired":false,"secret":false,"description":"The second part of an endpoint operation. Needed only when endpoint semantic is not enough, like wordpress:post:delete"},"apiVersion":{"index":2,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2","configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"The Wordpress REST API version"},"criteria":{"index":3,"kind":"parameter","displayName":"Criteria","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","prefix":"criteria.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"The criteria to use with complex searches."},"force":{"index":4,"kind":"parameter","displayName":"Force","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"Whether to bypass trash and force deletion."},"id":{"index":5,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"The entity ID. Should be passed when the operation performed requires a specific entity, e.g. deleting a post"},"password":{"index":6,"kind":"parameter","displayName":"Password","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"Password from authorized user"},"searchCriteria":{"index":7,"kind":"parameter","displayName":"Search Criteria","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.wordpress.api.model.SearchCriteria","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"Search criteria"},"url":{"index":8,"kind":"parameter","displayName":"Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"The Wordpress API URL from your site, e.g. http://myblog.com/wp-json/"},"user":{"index":9,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"Authorized user to perform writing operations"},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":13,"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."}}} +{"component":{"kind":"component","name":"wordpress","title":"WordPress","description":"Manage posts and users using the WordPress API.","deprecated":false,"firstVersion":"2.21.0","label":"cloud,api,cms","javaType":"org.apache.camel.component.wordpress.WordpressComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-wordpress","version":"4.8.2","scheme":"wordpress","extendsScheme":"","syntax":"wordpress:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"operation":{"index":0,"kind":"path","displayName":"Operation","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["post","user"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The endpoint operation."},"operationDetail":{"index":1,"kind":"path","displayName":"Operation Detail","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["delete"],"deprecated":false,"autowired":false,"secret":false,"description":"The second part of an endpoint operation. Needed only when endpoint semantic is not enough, like wordpress:post:delete"},"apiVersion":{"index":2,"kind":"parameter","displayName":"Api Version","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2","configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"The Wordpress REST API version"},"criteria":{"index":3,"kind":"parameter","displayName":"Criteria","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","prefix":"criteria.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"The criteria to use with complex searches."},"force":{"index":4,"kind":"parameter","displayName":"Force","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"Whether to bypass trash and force deletion."},"id":{"index":5,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"The entity ID. Should be passed when the operation performed requires a specific entity, e.g. deleting a post"},"password":{"index":6,"kind":"parameter","displayName":"Password","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"Password from authorized user"},"searchCriteria":{"index":7,"kind":"parameter","displayName":"Search Criteria","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.wordpress.api.model.SearchCriteria","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"Search criteria"},"url":{"index":8,"kind":"parameter","displayName":"Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"The Wordpress API URL from your site, e.g. http://myblog.com/wp-json/"},"user":{"index":9,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.wordpress.WordpressConfiguration","configurationField":"configuration","description":"Authorized user to perform writing operations"},"bridgeErrorHandler":{"index":10,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":11,"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":{"index":12,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":13,"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."}}} , -{"component":{"kind":"component","name":"workday","title":"Workday","description":"Detect and parse documents using Workday.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,api,saas","javaType":"org.apache.camel.component.workday.WorkdayComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-workday","version":"4.8.1","scheme":"workday","extendsScheme":"","syntax":"workday:entity:path","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelWorkdayURL":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The workday URL","constantName":"org.apache.camel.component.workday.producer.WorkdayDefaultProducer#WORKDAY_URL_HEADER"}},"properties":{"entity":{"index":0,"kind":"path","displayName":"Entity","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.workday.WorkdayConfiguration.Entity","enum":["report","commonAPI"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"The entity to be requested or subscribed via API."},"path":{"index":1,"kind":"path","displayName":"Path","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"The API path to access an entity structure."},"lazyStartProducer":{"index":2,"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."},"httpConnectionManager":{"index":3,"kind":"parameter","displayName":"Http Connection Manager","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"Pool connection manager for advanced configuration."},"reportFormat":{"index":4,"kind":"parameter","displayName":"Report Format","group":"format","label":"format","required":false,"type":"string","javaType":"java.lang.String","enum":["json"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"json","configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"Workday Report as a service output format."},"host":{"index":5,"kind":"parameter","displayName":"Host","group":"host","label":"host","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"Workday Host name."},"clientId":{"index":6,"kind":"parameter","displayName":"Client Id","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"Workday client Id generated by API client for integrations."},"clientSecret":{"index":7,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"Workday client Secret generated by API client for integrations."},"tokenRefresh":{"index":8,"kind":"parameter","displayName":"Token Refresh","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"Workday token Refresh generated for integrations system user."},"tenant":{"index":9,"kind":"parameter","displayName":"Tenant","group":"tenant","label":"tenant","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"Workday Tenant name."}}} +{"component":{"kind":"component","name":"workday","title":"Workday","description":"Detect and parse documents using Workday.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,api,saas","javaType":"org.apache.camel.component.workday.WorkdayComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-workday","version":"4.8.2","scheme":"workday","extendsScheme":"","syntax":"workday:entity:path","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"CamelWorkdayURL":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The workday URL","constantName":"org.apache.camel.component.workday.producer.WorkdayDefaultProducer#WORKDAY_URL_HEADER"}},"properties":{"entity":{"index":0,"kind":"path","displayName":"Entity","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.workday.WorkdayConfiguration.Entity","enum":["report","commonAPI"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"The entity to be requested or subscribed via API."},"path":{"index":1,"kind":"path","displayName":"Path","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"The API path to access an entity structure."},"lazyStartProducer":{"index":2,"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."},"httpConnectionManager":{"index":3,"kind":"parameter","displayName":"Http Connection Manager","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"Pool connection manager for advanced configuration."},"reportFormat":{"index":4,"kind":"parameter","displayName":"Report Format","group":"format","label":"format","required":false,"type":"string","javaType":"java.lang.String","enum":["json"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"json","configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"Workday Report as a service output format."},"host":{"index":5,"kind":"parameter","displayName":"Host","group":"host","label":"host","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"Workday Host name."},"clientId":{"index":6,"kind":"parameter","displayName":"Client Id","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"Workday client Id generated by API client for integrations."},"clientSecret":{"index":7,"kind":"parameter","displayName":"Client Secret","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"Workday client Secret generated by API client for integrations."},"tokenRefresh":{"index":8,"kind":"parameter","displayName":"Token Refresh","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"Workday token Refresh generated for integrations system user."},"tenant":{"index":9,"kind":"parameter","displayName":"Tenant","group":"tenant","label":"tenant","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.workday.WorkdayConfiguration","configurationField":"workdayConfiguration","description":"Workday Tenant name."}}} , -{"component":{"kind":"component","name":"xchange","title":"XChange","description":"Access market data and trade on Bitcoin and Altcoin exchanges.","deprecated":false,"firstVersion":"2.21.0","label":"blockchain","javaType":"org.apache.camel.component.xchange.XChangeComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xchange","version":"4.8.1","scheme":"xchange","extendsScheme":"","syntax":"xchange:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"Currency":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.knowm.xchange.currency.Currency","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The target currency","constantName":"org.apache.camel.component.xchange.XChangeConfiguration#HEADER_CURRENCY"},"CurrencyPair":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.knowm.xchange.currency.CurrencyPair","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The target currency pair","constantName":"org.apache.camel.component.xchange.XChangeConfiguration#HEADER_CURRENCY_PAIR"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xchange.XChangeConfiguration","configurationField":"configuration","description":"The exchange to connect to"},"currency":{"index":1,"kind":"parameter","displayName":"Currency","group":"producer","label":"","required":false,"type":"object","javaType":"org.knowm.xchange.currency.Currency","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xchange.XChangeConfiguration","configurationField":"configuration","description":"The currency"},"currencyPair":{"index":2,"kind":"parameter","displayName":"Currency Pair","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xchange.XChangeConfiguration","configurationField":"configuration","description":"The currency pair"},"method":{"index":3,"kind":"parameter","displayName":"Method","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.xchange.XChangeConfiguration.XChangeMethod","enum":["balances","fundingHistory","wallets","currencies","currencyMetaData","currencyPairs","currencyPairMetaData","ticker"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xchange.XChangeConfiguration","configurationField":"configuration","description":"The method to execute"},"service":{"index":4,"kind":"parameter","displayName":"Service","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.xchange.XChangeConfiguration.XChangeService","enum":["marketdata","metadata","account"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xchange.XChangeConfiguration","configurationField":"configuration","description":"The service to call"},"lazyStartProducer":{"index":5,"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."}}} +{"component":{"kind":"component","name":"xchange","title":"XChange","description":"Access market data and trade on Bitcoin and Altcoin exchanges.","deprecated":false,"firstVersion":"2.21.0","label":"blockchain","javaType":"org.apache.camel.component.xchange.XChangeComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xchange","version":"4.8.2","scheme":"xchange","extendsScheme":"","syntax":"xchange:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":true},"headers":{"Currency":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.knowm.xchange.currency.Currency","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The target currency","constantName":"org.apache.camel.component.xchange.XChangeConfiguration#HEADER_CURRENCY"},"CurrencyPair":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.knowm.xchange.currency.CurrencyPair","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The target currency pair","constantName":"org.apache.camel.component.xchange.XChangeConfiguration#HEADER_CURRENCY_PAIR"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xchange.XChangeConfiguration","configurationField":"configuration","description":"The exchange to connect to"},"currency":{"index":1,"kind":"parameter","displayName":"Currency","group":"producer","label":"","required":false,"type":"object","javaType":"org.knowm.xchange.currency.Currency","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xchange.XChangeConfiguration","configurationField":"configuration","description":"The currency"},"currencyPair":{"index":2,"kind":"parameter","displayName":"Currency Pair","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xchange.XChangeConfiguration","configurationField":"configuration","description":"The currency pair"},"method":{"index":3,"kind":"parameter","displayName":"Method","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.xchange.XChangeConfiguration.XChangeMethod","enum":["balances","fundingHistory","wallets","currencies","currencyMetaData","currencyPairs","currencyPairMetaData","ticker"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xchange.XChangeConfiguration","configurationField":"configuration","description":"The method to execute"},"service":{"index":4,"kind":"parameter","displayName":"Service","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.xchange.XChangeConfiguration.XChangeService","enum":["marketdata","metadata","account"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xchange.XChangeConfiguration","configurationField":"configuration","description":"The service to call"},"lazyStartProducer":{"index":5,"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."}}} , -{"component":{"kind":"component","name":"xj","title":"XJ","description":"Transform JSON and XML message using a XSLT.","deprecated":false,"firstVersion":"3.0.0","label":"transformation","javaType":"org.apache.camel.component.xj.XJComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xj","version":"4.8.1","scheme":"xj","extendsScheme":"","syntax":"xj:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelXsltFileName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XSLT file name","constantName":"org.apache.camel.component.xj.XJConstants#XSLT_FILE_NAME"},"CamelXsltResourceUri":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to load and use instead of the endpoint configured.","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_RESOURCE_URI"},"CamelXsltStylesheet":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_STYLESHEET"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the template. The following is supported by the default URIResolver. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod"},"allowStAX":{"index":1,"kind":"parameter","displayName":"Allow StAX","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to allow using StAX as the javax.xml.transform.Source. You can enable this if the XSLT library supports StAX such as the Saxon library (camel-saxon). The Xalan library (default in JVM) does not support StAXSource."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Cache for the resource content (the stylesheet file) when it is loaded on startup. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation."},"deleteOutputFile":{"index":4,"kind":"parameter","displayName":"Delete Output File","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If you have output=file then this option dictates whether or not the output file should be deleted when the Exchange is done processing. For example suppose the output file is a temporary file, then it can be a good idea to delete it after use."},"failOnNullBody":{"index":5,"kind":"parameter","displayName":"Fail On Null Body","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to throw an exception if the input body is null."},"output":{"index":6,"kind":"parameter","displayName":"Output","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.XsltOutput","enum":["string","bytes","DOM","file"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"string","description":"Option to specify which output type to use. Possible values are: string, bytes, DOM, file. The first three options are all in memory based, where as file is streamed directly to a java.io.File. For file you must specify the filename in the IN header with the key XsltConstants.XSLT_FILE_NAME which is also CamelXsltFileName. Also any paths leading to the filename must be created beforehand, otherwise an exception is thrown at runtime."},"transformDirection":{"index":7,"kind":"parameter","displayName":"Transform Direction","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.xj.TransformDirection","enum":["XML2JSON","JSON2XML"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Transform direction. Either XML2JSON or JSON2XML"},"transformerCacheSize":{"index":8,"kind":"parameter","displayName":"Transformer Cache Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer()."},"lazyStartProducer":{"index":9,"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."},"entityResolver":{"index":10,"kind":"parameter","displayName":"Entity Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.xml.sax.EntityResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.xml.sax.EntityResolver with javax.xml.transform.sax.SAXSource."},"errorListener":{"index":11,"kind":"parameter","displayName":"Error Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.ErrorListener","deprecated":false,"autowired":false,"secret":false,"description":"Allows to configure to use a custom javax.xml.transform.ErrorListener. Beware when doing this then the default error listener which captures any errors or fatal errors and store information on the Exchange as properties is not in use. So only use this option for special use-cases."},"resultHandlerFactory":{"index":12,"kind":"parameter","displayName":"Result Handler Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.ResultHandlerFactory","deprecated":false,"autowired":false,"secret":false,"description":"Allows you to use a custom org.apache.camel.builder.xml.ResultHandlerFactory which is capable of using custom org.apache.camel.builder.xml.ResultHandler types."},"saxonConfiguration":{"index":13,"kind":"parameter","displayName":"Saxon Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"net.sf.saxon.Configuration","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom Saxon configuration"},"saxonExtensionFunctions":{"index":14,"kind":"parameter","displayName":"Saxon Extension Functions","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry, where you can comma to separate multiple values to lookup."},"secureProcessing":{"index":15,"kind":"parameter","displayName":"Secure Processing","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Feature for XML secure processing (see javax.xml.XMLConstants). This is enabled by default. However, when using Saxon Professional you may need to turn this off to allow Saxon to be able to use Java extension functions."},"transformerFactory":{"index":16,"kind":"parameter","displayName":"Transformer Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.TransformerFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom XSLT transformer factory"},"transformerFactoryClass":{"index":17,"kind":"parameter","displayName":"Transformer Factory Class","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom XSLT transformer factory, specified as a FQN class name"},"transformerFactoryConfigurationStrategy":{"index":18,"kind":"parameter","displayName":"Transformer Factory Configuration Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.TransformerFactoryConfigurationStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A configuration strategy to apply on freshly created instances of TransformerFactory."},"uriResolver":{"index":19,"kind":"parameter","displayName":"Uri Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.URIResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom javax.xml.transform.URIResolver"},"xsltMessageLogger":{"index":20,"kind":"parameter","displayName":"Xslt Message Logger","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.XsltMessageLogger","deprecated":false,"autowired":false,"secret":false,"description":"A consumer to messages generated during XSLT transformations."}}} +{"component":{"kind":"component","name":"xj","title":"XJ","description":"Transform JSON and XML message using a XSLT.","deprecated":false,"firstVersion":"3.0.0","label":"transformation","javaType":"org.apache.camel.component.xj.XJComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xj","version":"4.8.2","scheme":"xj","extendsScheme":"","syntax":"xj:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelXsltFileName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XSLT file name","constantName":"org.apache.camel.component.xj.XJConstants#XSLT_FILE_NAME"},"CamelXsltResourceUri":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to load and use instead of the endpoint configured.","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_RESOURCE_URI"},"CamelXsltStylesheet":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_STYLESHEET"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the template. The following is supported by the default URIResolver. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod"},"allowStAX":{"index":1,"kind":"parameter","displayName":"Allow StAX","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to allow using StAX as the javax.xml.transform.Source. You can enable this if the XSLT library supports StAX such as the Saxon library (camel-saxon). The Xalan library (default in JVM) does not support StAXSource."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Cache for the resource content (the stylesheet file) when it is loaded on startup. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation."},"deleteOutputFile":{"index":4,"kind":"parameter","displayName":"Delete Output File","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If you have output=file then this option dictates whether or not the output file should be deleted when the Exchange is done processing. For example suppose the output file is a temporary file, then it can be a good idea to delete it after use."},"failOnNullBody":{"index":5,"kind":"parameter","displayName":"Fail On Null Body","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to throw an exception if the input body is null."},"output":{"index":6,"kind":"parameter","displayName":"Output","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.XsltOutput","enum":["string","bytes","DOM","file"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"string","description":"Option to specify which output type to use. Possible values are: string, bytes, DOM, file. The first three options are all in memory based, where as file is streamed directly to a java.io.File. For file you must specify the filename in the IN header with the key XsltConstants.XSLT_FILE_NAME which is also CamelXsltFileName. Also any paths leading to the filename must be created beforehand, otherwise an exception is thrown at runtime."},"transformDirection":{"index":7,"kind":"parameter","displayName":"Transform Direction","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.xj.TransformDirection","enum":["XML2JSON","JSON2XML"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Transform direction. Either XML2JSON or JSON2XML"},"transformerCacheSize":{"index":8,"kind":"parameter","displayName":"Transformer Cache Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer()."},"lazyStartProducer":{"index":9,"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."},"entityResolver":{"index":10,"kind":"parameter","displayName":"Entity Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.xml.sax.EntityResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.xml.sax.EntityResolver with javax.xml.transform.sax.SAXSource."},"errorListener":{"index":11,"kind":"parameter","displayName":"Error Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.ErrorListener","deprecated":false,"autowired":false,"secret":false,"description":"Allows to configure to use a custom javax.xml.transform.ErrorListener. Beware when doing this then the default error listener which captures any errors or fatal errors and store information on the Exchange as properties is not in use. So only use this option for special use-cases."},"resultHandlerFactory":{"index":12,"kind":"parameter","displayName":"Result Handler Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.ResultHandlerFactory","deprecated":false,"autowired":false,"secret":false,"description":"Allows you to use a custom org.apache.camel.builder.xml.ResultHandlerFactory which is capable of using custom org.apache.camel.builder.xml.ResultHandler types."},"saxonConfiguration":{"index":13,"kind":"parameter","displayName":"Saxon Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"net.sf.saxon.Configuration","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom Saxon configuration"},"saxonExtensionFunctions":{"index":14,"kind":"parameter","displayName":"Saxon Extension Functions","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry, where you can comma to separate multiple values to lookup."},"secureProcessing":{"index":15,"kind":"parameter","displayName":"Secure Processing","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Feature for XML secure processing (see javax.xml.XMLConstants). This is enabled by default. However, when using Saxon Professional you may need to turn this off to allow Saxon to be able to use Java extension functions."},"transformerFactory":{"index":16,"kind":"parameter","displayName":"Transformer Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.TransformerFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom XSLT transformer factory"},"transformerFactoryClass":{"index":17,"kind":"parameter","displayName":"Transformer Factory Class","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom XSLT transformer factory, specified as a FQN class name"},"transformerFactoryConfigurationStrategy":{"index":18,"kind":"parameter","displayName":"Transformer Factory Configuration Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.TransformerFactoryConfigurationStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A configuration strategy to apply on freshly created instances of TransformerFactory."},"uriResolver":{"index":19,"kind":"parameter","displayName":"Uri Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.URIResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom javax.xml.transform.URIResolver"},"xsltMessageLogger":{"index":20,"kind":"parameter","displayName":"Xslt Message Logger","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.XsltMessageLogger","deprecated":false,"autowired":false,"secret":false,"description":"A consumer to messages generated during XSLT transformations."}}} , -{"component":{"kind":"component","name":"xmlsecurity-sign","title":"XML Security Sign","description":"Sign XML payloads using the XML signature specification.","deprecated":false,"firstVersion":"2.12.0","label":"security,transformation","javaType":"org.apache.camel.component.xmlsecurity.XmlSignerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xmlsecurity","version":"4.8.1","scheme":"xmlsecurity-sign","extendsScheme":"","syntax":"xmlsecurity-sign:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelXmlSignatureMessageIsPlainText":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Header for indicating that the message body contains non-xml plain text. This header is used in the XML signature generator. If the value is set to Boolean#TRUE then the message body is treated as plain text Overwrites the configuration parameter XmlSignerConfiguration#setPlainText(Boolean)","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_MESSAGE_IS_PLAIN_TEXT"},"CamelXmlSignaturePlainTextEncoding":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Header indicating the encoding of the plain text message body. Used in the XML signature generator if the header HEADER_MESSAGE_IS_PLAIN_TEXT is set to Boolean#TRUE. Overwrites the configuration parameter XmlSignerConfiguration#setPlainTextEncoding(String).","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_PLAIN_TEXT_ENCODING"},"CamelXmlSignatureOmitXmlDeclaration":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Header which indicates that either the resulting signature document in the signature generation case or the resulting output of the verifier should not contain an XML declaration. If the header is not specified then a XML declaration is created. There is one exception: If the verifier result is a plain text this header has no effect. Possible values of the header are Boolean#TRUE or Boolean#FALSE. Overwrites the configuration parameter XmlSignatureConfiguration#setOmitXmlDeclaration(Boolean).","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_OMIT_XML_DECLARATION"},"CamelXmlSignatureContentReferenceUri":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content reference URI","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_CONTENT_REFERENCE_URI"},"CamelXmlSignatureContentReferenceType":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content reference type","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_CONTENT_REFERENCE_TYPE"},"CamelXmlSignatureSchemaResourceUri":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The schema resource URI","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_SCHEMA_RESOURCE_URI"},"CamelXmlSignatureXpathsToIdAttributes":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"XPaths to id attributes","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XPATHS_TO_ID_ATTRIBUTES"},"CamelXmlSignatureTransformMethods":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Header for dynamic specifying the transform methods of the reference to the signed data. The value of the header must be a comma separated list with the transform algorithms, for example: http://www.w3.org/2000/09/xmldsig#enveloped-signature,http://www.w3.org/TR/2001/REC-xml-c14n-20010315 Used for the XML signer. This header will overwrite the configuration property transformMethods. You cannot use transform algorithms, which need parameters like http://www.w3.org/TR/1999/REC-xslt-19991116, http://www.w3.org/2002/06/xmldsig-filter2, or http://www.w3.org/TR/1999/REC-xpath-19991116.","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_TRANSFORM_METHODS"},"CamelXmlSignatureXAdESQualifyingPropertiesId":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of QualifyingProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_QUALIFYING_PROPERTIES_ID"},"CamelXmlSignatureXAdESSignedDataObjectPropertiesId":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of SignedDataObjectProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_SIGNED_DATA_OBJECT_PROPERTIES_ID"},"CamelXmlSignatureXAdESSignedSignaturePropertiesId":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of SignedSignatureProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_SIGNED_SIGNATURE_PROPERTIES_ID"},"CamelXmlSignatureXAdESDataObjectFormatEncoding":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the value of the Encoding element of the DataObjectFormat element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_DATA_OBJECT_FORMAT_ENCODING"},"CamelXmlSignatureXAdESNamespace":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"overwrites the XAdES namespace parameter value","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_NAMESPACE"},"CamelXmlSignatureXAdESPrefix":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"overwrites the XAdES prefix parameter value","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_PREFIX"},"CamelCharsetName":{"index":14,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the charset","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#CHARSET_NAME"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name part in the URI can be chosen by the user to distinguish between different signer endpoints within the camel context."},"addKeyInfoReference":{"index":1,"kind":"parameter","displayName":"Add Key Info Reference","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"In order to protect the KeyInfo element from tampering you can add a reference to the signed info element so that it is protected via the signature value. The default value is true. Only relevant when a KeyInfo is returned by KeyAccessor. and KeyInfo#getId() is not null."},"baseUri":{"index":2,"kind":"parameter","displayName":"Base Uri","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"You can set a base URI which is used in the URI dereferencing. Relative URIs are then concatenated with the base URI."},"canonicalizationMethod":{"index":3,"kind":"parameter","displayName":"Canonicalization Method","group":"producer","label":"","required":false,"type":"object","javaType":"javax.xml.crypto.AlgorithmMethod","deprecated":false,"autowired":false,"secret":false,"defaultValue":"http://www.w3.org/TR/2001/REC-xml-c14n-20010315","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Canonicalization method used to canonicalize the SignedInfo element before the digest is calculated. You can use the helper methods XmlSignatureHelper.getCanonicalizationMethod(String algorithm) or getCanonicalizationMethod(String algorithm, List inclusiveNamespacePrefixes) to create a canonicalization method."},"clearHeaders":{"index":4,"kind":"parameter","displayName":"Clear Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true."},"contentObjectId":{"index":5,"kind":"parameter","displayName":"Content Object Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Sets the content object Id attribute value. By default a UUID is generated. If you set the null value, then a new UUID will be generated. Only used in the enveloping case."},"contentReferenceType":{"index":6,"kind":"parameter","displayName":"Content Reference Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Type of the content reference. The default value is null. This value can be overwritten by the header XmlSignatureConstants#HEADER_CONTENT_REFERENCE_TYPE."},"contentReferenceUri":{"index":7,"kind":"parameter","displayName":"Content Reference Uri","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Reference URI for the content to be signed. Only used in the enveloped case. If the reference URI contains an ID attribute value, then the resource schema URI ( setSchemaResourceUri(String)) must also be set because the schema validator will then find out which attributes are ID attributes. Will be ignored in the enveloping or detached case."},"cryptoContextProperties":{"index":8,"kind":"parameter","displayName":"Crypto Context Properties","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Sets the crypto context properties. See {link XMLCryptoContext#setProperty(String, Object)}. Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value Boolean#TRUE for the XML validation. If you want to switch these features off you must set the property value to Boolean#FALSE. org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference"},"digestAlgorithm":{"index":9,"kind":"parameter","displayName":"Digest Algorithm","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Digest algorithm URI. Optional parameter. This digest algorithm is used for calculating the digest of the input message. If this digest algorithm is not specified then the digest algorithm is calculated from the signature algorithm. Example: http://www.w3.org/2001/04/xmlenc#sha256"},"disallowDoctypeDecl":{"index":10,"kind":"parameter","displayName":"Disallow Doctype Decl","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is Boolean#TRUE."},"keyAccessor":{"index":11,"kind":"parameter","displayName":"Key Accessor","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xmlsecurity.api.KeyAccessor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"For the signing process, a private key is necessary. You specify a key accessor bean which provides this private key. The key accessor bean must implement the KeyAccessor interface. The package org.apache.camel.component.xmlsecurity.api contains the default implementation class DefaultKeyAccessor which reads the private key from a Java keystore."},"omitXmlDeclaration":{"index":12,"kind":"parameter","displayName":"Omit Xml Declaration","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Indicator whether the XML declaration in the outgoing message body should be omitted. Default value is false. Can be overwritten by the header XmlSignatureConstants#HEADER_OMIT_XML_DECLARATION."},"outputXmlEncoding":{"index":13,"kind":"parameter","displayName":"Output Xml Encoding","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"The character encoding of the resulting signed XML document. If null then the encoding of the original XML document is used."},"parentLocalName":{"index":14,"kind":"parameter","displayName":"Parent Local Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Local name of the parent element to which the XML signature element will be added. Only relevant for enveloped XML signature. Alternatively you can also use setParentXpath(XPathFilterParameterSpec). Default value is null. The value must be null for enveloping and detached XML signature. This parameter or the parameter setParentXpath(XPathFilterParameterSpec) for enveloped signature and the parameter setXpathsToIdAttributes(List) for detached signature must not be set in the same configuration. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown."},"parentNamespace":{"index":15,"kind":"parameter","displayName":"Parent Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Namespace of the parent element to which the XML signature element will be added."},"parentXpath":{"index":16,"kind":"parameter","displayName":"Parent Xpath","group":"producer","label":"","required":false,"type":"object","javaType":"javax.xml.crypto.dsig.spec.XPathFilterParameterSpec","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Sets the XPath to find the parent node in the enveloped case. Either you specify the parent node via this method or the local name and namespace of the parent with the methods setParentLocalName(String) and setParentNamespace(String). Default value is null. The value must be null for enveloping and detached XML signature. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown."},"plainText":{"index":17,"kind":"parameter","displayName":"Plain Text","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Indicator whether the message body contains plain text. The default value is false, indicating that the message body contains XML. The value can be overwritten by the header XmlSignatureConstants#HEADER_MESSAGE_IS_PLAIN_TEXT."},"plainTextEncoding":{"index":18,"kind":"parameter","displayName":"Plain Text Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"UTF-8","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Encoding of the plain text. Only relevant if the message body is plain text (see parameter plainText. Default value is UTF-8."},"prefixForXmlSignatureNamespace":{"index":19,"kind":"parameter","displayName":"Prefix For Xml Signature Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ds","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Namespace prefix for the XML signature namespace http://www.w3.org/2000/09/xmldsig#. Default value is ds. If null or an empty value is set then no prefix is used for the XML signature namespace. See best practice http://www.w3.org/TR/xmldsig-bestpractices/#signing-xml- without-namespaces"},"properties":{"index":20,"kind":"parameter","displayName":"Properties","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xmlsecurity.api.XmlSignatureProperties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"For adding additional References and Objects to the XML signature which contain additional properties, you can provide a bean which implements the XmlSignatureProperties interface."},"schemaResourceUri":{"index":21,"kind":"parameter","displayName":"Schema Resource Uri","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Classpath to the XML Schema. Must be specified in the detached XML Signature case for determining the ID attributes, might be set in the enveloped and enveloping case. If set, then the XML document is validated with the specified XML schema. The schema resource URI can be overwritten by the header XmlSignatureConstants#HEADER_SCHEMA_RESOURCE_URI."},"signatureAlgorithm":{"index":22,"kind":"parameter","displayName":"Signature Algorithm","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"http://www.w3.org/2001/04/xmldsig-more#rsa-sha256","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Signature algorithm. Default value is http://www.w3.org/2000/09/xmldsig#rsa-sha1."},"signatureId":{"index":23,"kind":"parameter","displayName":"Signature Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Sets the signature Id. If this parameter is not set (null value) then a unique ID is generated for the signature ID (default). If this parameter is set to (empty string) then no Id attribute is created in the signature element."},"transformMethods":{"index":24,"kind":"parameter","displayName":"Transform Methods","group":"producer","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Transforms which are executed on the message body before the digest is calculated. By default, C14n is added and in the case of enveloped signature (see option parentLocalName) also http://www.w3.org/2000/09/xmldsig#enveloped-signature is added at position 0 of the list. Use methods in XmlSignatureHelper to create the transform methods."},"xpathsToIdAttributes":{"index":25,"kind":"parameter","displayName":"Xpaths To Id Attributes","group":"producer","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Define the elements which are signed in the detached case via XPATH expressions to ID attributes (attributes of type ID). For each element found via the XPATH expression a detached signature is created whose reference URI contains the corresponding attribute value (preceded by '#'). The signature becomes the last sibling of the signed element. Elements with deeper hierarchy level are signed first. You can also set the XPATH list dynamically via the header XmlSignatureConstants#HEADER_XPATHS_TO_ID_ATTRIBUTES. The parameter setParentLocalName(String) or setParentXpath(XPathFilterParameterSpec) for enveloped signature and this parameter for detached signature must not be set in the same configuration."},"lazyStartProducer":{"index":26,"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."},"uriDereferencer":{"index":27,"kind":"parameter","displayName":"Uri Dereferencer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.crypto.URIDereferencer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"If you want to restrict the remote access via reference URIs, you can set an own dereferencer. Optional parameter. If not set the provider default dereferencer is used which can resolve URI fragments, HTTP, file and XPpointer URIs. Attention: The implementation is provider dependent!"}}} +{"component":{"kind":"component","name":"xmlsecurity-sign","title":"XML Security Sign","description":"Sign XML payloads using the XML signature specification.","deprecated":false,"firstVersion":"2.12.0","label":"security,transformation","javaType":"org.apache.camel.component.xmlsecurity.XmlSignerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xmlsecurity","version":"4.8.2","scheme":"xmlsecurity-sign","extendsScheme":"","syntax":"xmlsecurity-sign:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelXmlSignatureMessageIsPlainText":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Header for indicating that the message body contains non-xml plain text. This header is used in the XML signature generator. If the value is set to Boolean#TRUE then the message body is treated as plain text Overwrites the configuration parameter XmlSignerConfiguration#setPlainText(Boolean)","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_MESSAGE_IS_PLAIN_TEXT"},"CamelXmlSignaturePlainTextEncoding":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Header indicating the encoding of the plain text message body. Used in the XML signature generator if the header HEADER_MESSAGE_IS_PLAIN_TEXT is set to Boolean#TRUE. Overwrites the configuration parameter XmlSignerConfiguration#setPlainTextEncoding(String).","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_PLAIN_TEXT_ENCODING"},"CamelXmlSignatureOmitXmlDeclaration":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Header which indicates that either the resulting signature document in the signature generation case or the resulting output of the verifier should not contain an XML declaration. If the header is not specified then a XML declaration is created. There is one exception: If the verifier result is a plain text this header has no effect. Possible values of the header are Boolean#TRUE or Boolean#FALSE. Overwrites the configuration parameter XmlSignatureConfiguration#setOmitXmlDeclaration(Boolean).","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_OMIT_XML_DECLARATION"},"CamelXmlSignatureContentReferenceUri":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content reference URI","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_CONTENT_REFERENCE_URI"},"CamelXmlSignatureContentReferenceType":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content reference type","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_CONTENT_REFERENCE_TYPE"},"CamelXmlSignatureSchemaResourceUri":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The schema resource URI","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_SCHEMA_RESOURCE_URI"},"CamelXmlSignatureXpathsToIdAttributes":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"XPaths to id attributes","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XPATHS_TO_ID_ATTRIBUTES"},"CamelXmlSignatureTransformMethods":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Header for dynamic specifying the transform methods of the reference to the signed data. The value of the header must be a comma separated list with the transform algorithms, for example: http://www.w3.org/2000/09/xmldsig#enveloped-signature,http://www.w3.org/TR/2001/REC-xml-c14n-20010315 Used for the XML signer. This header will overwrite the configuration property transformMethods. You cannot use transform algorithms, which need parameters like http://www.w3.org/TR/1999/REC-xslt-19991116, http://www.w3.org/2002/06/xmldsig-filter2, or http://www.w3.org/TR/1999/REC-xpath-19991116.","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_TRANSFORM_METHODS"},"CamelXmlSignatureXAdESQualifyingPropertiesId":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of QualifyingProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_QUALIFYING_PROPERTIES_ID"},"CamelXmlSignatureXAdESSignedDataObjectPropertiesId":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of SignedDataObjectProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_SIGNED_DATA_OBJECT_PROPERTIES_ID"},"CamelXmlSignatureXAdESSignedSignaturePropertiesId":{"index":10,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of SignedSignatureProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_SIGNED_SIGNATURE_PROPERTIES_ID"},"CamelXmlSignatureXAdESDataObjectFormatEncoding":{"index":11,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the value of the Encoding element of the DataObjectFormat element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_DATA_OBJECT_FORMAT_ENCODING"},"CamelXmlSignatureXAdESNamespace":{"index":12,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"overwrites the XAdES namespace parameter value","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_NAMESPACE"},"CamelXmlSignatureXAdESPrefix":{"index":13,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"overwrites the XAdES prefix parameter value","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_PREFIX"},"CamelCharsetName":{"index":14,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the charset","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#CHARSET_NAME"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name part in the URI can be chosen by the user to distinguish between different signer endpoints within the camel context."},"addKeyInfoReference":{"index":1,"kind":"parameter","displayName":"Add Key Info Reference","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"In order to protect the KeyInfo element from tampering you can add a reference to the signed info element so that it is protected via the signature value. The default value is true. Only relevant when a KeyInfo is returned by KeyAccessor. and KeyInfo#getId() is not null."},"baseUri":{"index":2,"kind":"parameter","displayName":"Base Uri","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"You can set a base URI which is used in the URI dereferencing. Relative URIs are then concatenated with the base URI."},"canonicalizationMethod":{"index":3,"kind":"parameter","displayName":"Canonicalization Method","group":"producer","label":"","required":false,"type":"object","javaType":"javax.xml.crypto.AlgorithmMethod","deprecated":false,"autowired":false,"secret":false,"defaultValue":"http://www.w3.org/TR/2001/REC-xml-c14n-20010315","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Canonicalization method used to canonicalize the SignedInfo element before the digest is calculated. You can use the helper methods XmlSignatureHelper.getCanonicalizationMethod(String algorithm) or getCanonicalizationMethod(String algorithm, List inclusiveNamespacePrefixes) to create a canonicalization method."},"clearHeaders":{"index":4,"kind":"parameter","displayName":"Clear Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true."},"contentObjectId":{"index":5,"kind":"parameter","displayName":"Content Object Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Sets the content object Id attribute value. By default a UUID is generated. If you set the null value, then a new UUID will be generated. Only used in the enveloping case."},"contentReferenceType":{"index":6,"kind":"parameter","displayName":"Content Reference Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Type of the content reference. The default value is null. This value can be overwritten by the header XmlSignatureConstants#HEADER_CONTENT_REFERENCE_TYPE."},"contentReferenceUri":{"index":7,"kind":"parameter","displayName":"Content Reference Uri","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Reference URI for the content to be signed. Only used in the enveloped case. If the reference URI contains an ID attribute value, then the resource schema URI ( setSchemaResourceUri(String)) must also be set because the schema validator will then find out which attributes are ID attributes. Will be ignored in the enveloping or detached case."},"cryptoContextProperties":{"index":8,"kind":"parameter","displayName":"Crypto Context Properties","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Sets the crypto context properties. See {link XMLCryptoContext#setProperty(String, Object)}. Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value Boolean#TRUE for the XML validation. If you want to switch these features off you must set the property value to Boolean#FALSE. org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference"},"digestAlgorithm":{"index":9,"kind":"parameter","displayName":"Digest Algorithm","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Digest algorithm URI. Optional parameter. This digest algorithm is used for calculating the digest of the input message. If this digest algorithm is not specified then the digest algorithm is calculated from the signature algorithm. Example: http://www.w3.org/2001/04/xmlenc#sha256"},"disallowDoctypeDecl":{"index":10,"kind":"parameter","displayName":"Disallow Doctype Decl","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is Boolean#TRUE."},"keyAccessor":{"index":11,"kind":"parameter","displayName":"Key Accessor","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xmlsecurity.api.KeyAccessor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"For the signing process, a private key is necessary. You specify a key accessor bean which provides this private key. The key accessor bean must implement the KeyAccessor interface. The package org.apache.camel.component.xmlsecurity.api contains the default implementation class DefaultKeyAccessor which reads the private key from a Java keystore."},"omitXmlDeclaration":{"index":12,"kind":"parameter","displayName":"Omit Xml Declaration","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Indicator whether the XML declaration in the outgoing message body should be omitted. Default value is false. Can be overwritten by the header XmlSignatureConstants#HEADER_OMIT_XML_DECLARATION."},"outputXmlEncoding":{"index":13,"kind":"parameter","displayName":"Output Xml Encoding","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"The character encoding of the resulting signed XML document. If null then the encoding of the original XML document is used."},"parentLocalName":{"index":14,"kind":"parameter","displayName":"Parent Local Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Local name of the parent element to which the XML signature element will be added. Only relevant for enveloped XML signature. Alternatively you can also use setParentXpath(XPathFilterParameterSpec). Default value is null. The value must be null for enveloping and detached XML signature. This parameter or the parameter setParentXpath(XPathFilterParameterSpec) for enveloped signature and the parameter setXpathsToIdAttributes(List) for detached signature must not be set in the same configuration. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown."},"parentNamespace":{"index":15,"kind":"parameter","displayName":"Parent Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Namespace of the parent element to which the XML signature element will be added."},"parentXpath":{"index":16,"kind":"parameter","displayName":"Parent Xpath","group":"producer","label":"","required":false,"type":"object","javaType":"javax.xml.crypto.dsig.spec.XPathFilterParameterSpec","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Sets the XPath to find the parent node in the enveloped case. Either you specify the parent node via this method or the local name and namespace of the parent with the methods setParentLocalName(String) and setParentNamespace(String). Default value is null. The value must be null for enveloping and detached XML signature. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown."},"plainText":{"index":17,"kind":"parameter","displayName":"Plain Text","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Indicator whether the message body contains plain text. The default value is false, indicating that the message body contains XML. The value can be overwritten by the header XmlSignatureConstants#HEADER_MESSAGE_IS_PLAIN_TEXT."},"plainTextEncoding":{"index":18,"kind":"parameter","displayName":"Plain Text Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"UTF-8","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Encoding of the plain text. Only relevant if the message body is plain text (see parameter plainText. Default value is UTF-8."},"prefixForXmlSignatureNamespace":{"index":19,"kind":"parameter","displayName":"Prefix For Xml Signature Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ds","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Namespace prefix for the XML signature namespace http://www.w3.org/2000/09/xmldsig#. Default value is ds. If null or an empty value is set then no prefix is used for the XML signature namespace. See best practice http://www.w3.org/TR/xmldsig-bestpractices/#signing-xml- without-namespaces"},"properties":{"index":20,"kind":"parameter","displayName":"Properties","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xmlsecurity.api.XmlSignatureProperties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"For adding additional References and Objects to the XML signature which contain additional properties, you can provide a bean which implements the XmlSignatureProperties interface."},"schemaResourceUri":{"index":21,"kind":"parameter","displayName":"Schema Resource Uri","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Classpath to the XML Schema. Must be specified in the detached XML Signature case for determining the ID attributes, might be set in the enveloped and enveloping case. If set, then the XML document is validated with the specified XML schema. The schema resource URI can be overwritten by the header XmlSignatureConstants#HEADER_SCHEMA_RESOURCE_URI."},"signatureAlgorithm":{"index":22,"kind":"parameter","displayName":"Signature Algorithm","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"http://www.w3.org/2001/04/xmldsig-more#rsa-sha256","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Signature algorithm. Default value is http://www.w3.org/2000/09/xmldsig#rsa-sha1."},"signatureId":{"index":23,"kind":"parameter","displayName":"Signature Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Sets the signature Id. If this parameter is not set (null value) then a unique ID is generated for the signature ID (default). If this parameter is set to (empty string) then no Id attribute is created in the signature element."},"transformMethods":{"index":24,"kind":"parameter","displayName":"Transform Methods","group":"producer","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Transforms which are executed on the message body before the digest is calculated. By default, C14n is added and in the case of enveloped signature (see option parentLocalName) also http://www.w3.org/2000/09/xmldsig#enveloped-signature is added at position 0 of the list. Use methods in XmlSignatureHelper to create the transform methods."},"xpathsToIdAttributes":{"index":25,"kind":"parameter","displayName":"Xpaths To Id Attributes","group":"producer","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Define the elements which are signed in the detached case via XPATH expressions to ID attributes (attributes of type ID). For each element found via the XPATH expression a detached signature is created whose reference URI contains the corresponding attribute value (preceded by '#'). The signature becomes the last sibling of the signed element. Elements with deeper hierarchy level are signed first. You can also set the XPATH list dynamically via the header XmlSignatureConstants#HEADER_XPATHS_TO_ID_ATTRIBUTES. The parameter setParentLocalName(String) or setParentXpath(XPathFilterParameterSpec) for enveloped signature and this parameter for detached signature must not be set in the same configuration."},"lazyStartProducer":{"index":26,"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."},"uriDereferencer":{"index":27,"kind":"parameter","displayName":"Uri Dereferencer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.crypto.URIDereferencer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"If you want to restrict the remote access via reference URIs, you can set an own dereferencer. Optional parameter. If not set the provider default dereferencer is used which can resolve URI fragments, HTTP, file and XPpointer URIs. Attention: The implementation is provider dependent!"}}} , -{"component":{"kind":"component","name":"xmlsecurity-verify","title":"XML Security Verify","description":"Verify XML payloads using the XML signature specification.","deprecated":false,"firstVersion":"2.12.0","label":"security,transformation","javaType":"org.apache.camel.component.xmlsecurity.XmlVerifierComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xmlsecurity","version":"4.8.1","scheme":"xmlsecurity-verify","extendsScheme":"","syntax":"xmlsecurity-verify:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelXmlSignatureOmitXmlDeclaration":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Header which indicates that either the resulting signature document in the signature generation case or the resulting output of the verifier should not contain an XML declaration. If the header is not specified then a XML declaration is created. There is one exception: If the verifier result is a plain text this header has no effect. Possible values of the header are Boolean#TRUE or Boolean#FALSE. Overwrites the configuration parameter XmlSignatureConfiguration#setOmitXmlDeclaration(Boolean).","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_OMIT_XML_DECLARATION"},"CamelXmlSignatureSchemaResourceUri":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The schema resource URI","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_SCHEMA_RESOURCE_URI"},"CamelXmlSignatureXpathsToIdAttributes":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"XPaths to id attributes","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XPATHS_TO_ID_ATTRIBUTES"},"CamelXmlSignatureXAdESQualifyingPropertiesId":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of QualifyingProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_QUALIFYING_PROPERTIES_ID"},"CamelXmlSignatureXAdESSignedDataObjectPropertiesId":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of SignedDataObjectProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_SIGNED_DATA_OBJECT_PROPERTIES_ID"},"CamelXmlSignatureXAdESSignedSignaturePropertiesId":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of SignedSignatureProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_SIGNED_SIGNATURE_PROPERTIES_ID"},"CamelXmlSignatureXAdESDataObjectFormatEncoding":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the value of the Encoding element of the DataObjectFormat element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_DATA_OBJECT_FORMAT_ENCODING"},"CamelXmlSignatureXAdESNamespace":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"overwrites the XAdES namespace parameter value","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_NAMESPACE"},"CamelXmlSignatureXAdESPrefix":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"overwrites the XAdES prefix parameter value","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_PREFIX"},"CamelCharsetName":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the charset","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#CHARSET_NAME"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name part in the URI can be chosen by the user to distinguish between different verify endpoints within the camel context."},"baseUri":{"index":1,"kind":"parameter","displayName":"Base Uri","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"You can set a base URI which is used in the URI dereferencing. Relative URIs are then concatenated with the base URI."},"clearHeaders":{"index":2,"kind":"parameter","displayName":"Clear Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true."},"cryptoContextProperties":{"index":3,"kind":"parameter","displayName":"Crypto Context Properties","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Sets the crypto context properties. See {link XMLCryptoContext#setProperty(String, Object)}. Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value Boolean#TRUE for the XML validation. If you want to switch these features off you must set the property value to Boolean#FALSE. org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference"},"disallowDoctypeDecl":{"index":4,"kind":"parameter","displayName":"Disallow Doctype Decl","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is Boolean#TRUE."},"keySelector":{"index":5,"kind":"parameter","displayName":"Key Selector","group":"producer","label":"","required":false,"type":"object","javaType":"javax.xml.crypto.KeySelector","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Provides the key for validating the XML signature."},"omitXmlDeclaration":{"index":6,"kind":"parameter","displayName":"Omit Xml Declaration","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Indicator whether the XML declaration in the outgoing message body should be omitted. Default value is false. Can be overwritten by the header XmlSignatureConstants#HEADER_OMIT_XML_DECLARATION."},"outputNodeSearch":{"index":7,"kind":"parameter","displayName":"Output Node Search","group":"producer","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Sets the output node search value for determining the node from the XML signature document which shall be set to the output message body. The class of the value depends on the type of the output node search. The output node search is forwarded to XmlSignature2Message."},"outputNodeSearchType":{"index":8,"kind":"parameter","displayName":"Output Node Search Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Determines the search type for determining the output node which is serialized into the output message bodyF. See setOutputNodeSearch(Object). The supported default search types you can find in DefaultXmlSignature2Message."},"outputXmlEncoding":{"index":9,"kind":"parameter","displayName":"Output Xml Encoding","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"The character encoding of the resulting signed XML document. If null then the encoding of the original XML document is used."},"removeSignatureElements":{"index":10,"kind":"parameter","displayName":"Remove Signature Elements","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Indicator whether the XML signature elements (elements with local name Signature and namesapce http://www.w3.org/2000/09/xmldsig#) shall be removed from the document set to the output message. Normally, this is only necessary, if the XML signature is enveloped. The default value is Boolean#FALSE. This parameter is forwarded to XmlSignature2Message. This indicator has no effect if the output node search is of type DefaultXmlSignature2Message#OUTPUT_NODE_SEARCH_TYPE_DEFAULT.F"},"schemaResourceUri":{"index":11,"kind":"parameter","displayName":"Schema Resource Uri","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Classpath to the XML Schema. Must be specified in the detached XML Signature case for determining the ID attributes, might be set in the enveloped and enveloping case. If set, then the XML document is validated with the specified XML schema. The schema resource URI can be overwritten by the header XmlSignatureConstants#HEADER_SCHEMA_RESOURCE_URI."},"secureValidation":{"index":12,"kind":"parameter","displayName":"Secure Validation","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Enables secure validation. If true then secure validation is enabled."},"validationFailedHandler":{"index":13,"kind":"parameter","displayName":"Validation Failed Handler","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xmlsecurity.api.ValidationFailedHandler","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Handles the different validation failed situations. The default implementation throws specific exceptions for the different situations (All exceptions have the package name org.apache.camel.component.xmlsecurity.api and are a sub-class of XmlSignatureInvalidException. If the signature value validation fails, a XmlSignatureInvalidValueException is thrown. If a reference validation fails, a XmlSignatureInvalidContentHashException is thrown. For more detailed information, see the JavaDoc."},"xmlSignature2Message":{"index":14,"kind":"parameter","displayName":"Xml Signature2 Message","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xmlsecurity.api.XmlSignature2Message","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Bean which maps the XML signature to the output-message after the validation. How this mapping should be done can be configured by the options outputNodeSearchType, outputNodeSearch, and removeSignatureElements. The default implementation offers three possibilities which are related to the three output node search types Default, ElementName, and XPath. The default implementation determines a node which is then serialized and set to the body of the output message If the search type is ElementName then the output node (which must be in this case an element) is determined by the local name and namespace defined in the search value (see option outputNodeSearch). If the search type is XPath then the output node is determined by the XPath specified in the search value (in this case the output node can be of type Element, TextNode or Document). If the output node search type is Default then the following rules apply: In the enveloped XML signature case (there is a reference with URI= and transform http://www.w3.org/2000/09/xmldsig#enveloped-signature), the incoming XML document without the Signature element is set to the output message body. In the non-enveloped XML signature case, the message body is determined from a referenced Object; this is explained in more detail in chapter Output Node Determination in Enveloping XML Signature Case."},"xmlSignatureChecker":{"index":15,"kind":"parameter","displayName":"Xml Signature Checker","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xmlsecurity.api.XmlSignatureChecker","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"This interface allows the application to check the XML signature before the validation is executed. This step is recommended in http://www.w3.org/TR/xmldsig-bestpractices/#check-what-is-signed"},"lazyStartProducer":{"index":16,"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."},"uriDereferencer":{"index":17,"kind":"parameter","displayName":"Uri Dereferencer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.crypto.URIDereferencer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"If you want to restrict the remote access via reference URIs, you can set an own dereferencer. Optional parameter. If not set the provider default dereferencer is used which can resolve URI fragments, HTTP, file and XPpointer URIs. Attention: The implementation is provider dependent!"}}} +{"component":{"kind":"component","name":"xmlsecurity-verify","title":"XML Security Verify","description":"Verify XML payloads using the XML signature specification.","deprecated":false,"firstVersion":"2.12.0","label":"security,transformation","javaType":"org.apache.camel.component.xmlsecurity.XmlVerifierComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xmlsecurity","version":"4.8.2","scheme":"xmlsecurity-verify","extendsScheme":"","syntax":"xmlsecurity-verify:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelXmlSignatureOmitXmlDeclaration":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Header which indicates that either the resulting signature document in the signature generation case or the resulting output of the verifier should not contain an XML declaration. If the header is not specified then a XML declaration is created. There is one exception: If the verifier result is a plain text this header has no effect. Possible values of the header are Boolean#TRUE or Boolean#FALSE. Overwrites the configuration parameter XmlSignatureConfiguration#setOmitXmlDeclaration(Boolean).","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_OMIT_XML_DECLARATION"},"CamelXmlSignatureSchemaResourceUri":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The schema resource URI","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_SCHEMA_RESOURCE_URI"},"CamelXmlSignatureXpathsToIdAttributes":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"XPaths to id attributes","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XPATHS_TO_ID_ATTRIBUTES"},"CamelXmlSignatureXAdESQualifyingPropertiesId":{"index":3,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of QualifyingProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_QUALIFYING_PROPERTIES_ID"},"CamelXmlSignatureXAdESSignedDataObjectPropertiesId":{"index":4,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of SignedDataObjectProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_SIGNED_DATA_OBJECT_PROPERTIES_ID"},"CamelXmlSignatureXAdESSignedSignaturePropertiesId":{"index":5,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of SignedSignatureProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_SIGNED_SIGNATURE_PROPERTIES_ID"},"CamelXmlSignatureXAdESDataObjectFormatEncoding":{"index":6,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the value of the Encoding element of the DataObjectFormat element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_DATA_OBJECT_FORMAT_ENCODING"},"CamelXmlSignatureXAdESNamespace":{"index":7,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"overwrites the XAdES namespace parameter value","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_NAMESPACE"},"CamelXmlSignatureXAdESPrefix":{"index":8,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"overwrites the XAdES prefix parameter value","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_PREFIX"},"CamelCharsetName":{"index":9,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the charset","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#CHARSET_NAME"}},"properties":{"name":{"index":0,"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name part in the URI can be chosen by the user to distinguish between different verify endpoints within the camel context."},"baseUri":{"index":1,"kind":"parameter","displayName":"Base Uri","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"You can set a base URI which is used in the URI dereferencing. Relative URIs are then concatenated with the base URI."},"clearHeaders":{"index":2,"kind":"parameter","displayName":"Clear Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true."},"cryptoContextProperties":{"index":3,"kind":"parameter","displayName":"Crypto Context Properties","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Sets the crypto context properties. See {link XMLCryptoContext#setProperty(String, Object)}. Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value Boolean#TRUE for the XML validation. If you want to switch these features off you must set the property value to Boolean#FALSE. org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference"},"disallowDoctypeDecl":{"index":4,"kind":"parameter","displayName":"Disallow Doctype Decl","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is Boolean#TRUE."},"keySelector":{"index":5,"kind":"parameter","displayName":"Key Selector","group":"producer","label":"","required":false,"type":"object","javaType":"javax.xml.crypto.KeySelector","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Provides the key for validating the XML signature."},"omitXmlDeclaration":{"index":6,"kind":"parameter","displayName":"Omit Xml Declaration","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Indicator whether the XML declaration in the outgoing message body should be omitted. Default value is false. Can be overwritten by the header XmlSignatureConstants#HEADER_OMIT_XML_DECLARATION."},"outputNodeSearch":{"index":7,"kind":"parameter","displayName":"Output Node Search","group":"producer","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Sets the output node search value for determining the node from the XML signature document which shall be set to the output message body. The class of the value depends on the type of the output node search. The output node search is forwarded to XmlSignature2Message."},"outputNodeSearchType":{"index":8,"kind":"parameter","displayName":"Output Node Search Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Determines the search type for determining the output node which is serialized into the output message bodyF. See setOutputNodeSearch(Object). The supported default search types you can find in DefaultXmlSignature2Message."},"outputXmlEncoding":{"index":9,"kind":"parameter","displayName":"Output Xml Encoding","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"The character encoding of the resulting signed XML document. If null then the encoding of the original XML document is used."},"removeSignatureElements":{"index":10,"kind":"parameter","displayName":"Remove Signature Elements","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Indicator whether the XML signature elements (elements with local name Signature and namesapce http://www.w3.org/2000/09/xmldsig#) shall be removed from the document set to the output message. Normally, this is only necessary, if the XML signature is enveloped. The default value is Boolean#FALSE. This parameter is forwarded to XmlSignature2Message. This indicator has no effect if the output node search is of type DefaultXmlSignature2Message#OUTPUT_NODE_SEARCH_TYPE_DEFAULT.F"},"schemaResourceUri":{"index":11,"kind":"parameter","displayName":"Schema Resource Uri","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"supportFileReference":true,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Classpath to the XML Schema. Must be specified in the detached XML Signature case for determining the ID attributes, might be set in the enveloped and enveloping case. If set, then the XML document is validated with the specified XML schema. The schema resource URI can be overwritten by the header XmlSignatureConstants#HEADER_SCHEMA_RESOURCE_URI."},"secureValidation":{"index":12,"kind":"parameter","displayName":"Secure Validation","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Enables secure validation. If true then secure validation is enabled."},"validationFailedHandler":{"index":13,"kind":"parameter","displayName":"Validation Failed Handler","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xmlsecurity.api.ValidationFailedHandler","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Handles the different validation failed situations. The default implementation throws specific exceptions for the different situations (All exceptions have the package name org.apache.camel.component.xmlsecurity.api and are a sub-class of XmlSignatureInvalidException. If the signature value validation fails, a XmlSignatureInvalidValueException is thrown. If a reference validation fails, a XmlSignatureInvalidContentHashException is thrown. For more detailed information, see the JavaDoc."},"xmlSignature2Message":{"index":14,"kind":"parameter","displayName":"Xml Signature2 Message","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xmlsecurity.api.XmlSignature2Message","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"Bean which maps the XML signature to the output-message after the validation. How this mapping should be done can be configured by the options outputNodeSearchType, outputNodeSearch, and removeSignatureElements. The default implementation offers three possibilities which are related to the three output node search types Default, ElementName, and XPath. The default implementation determines a node which is then serialized and set to the body of the output message If the search type is ElementName then the output node (which must be in this case an element) is determined by the local name and namespace defined in the search value (see option outputNodeSearch). If the search type is XPath then the output node is determined by the XPath specified in the search value (in this case the output node can be of type Element, TextNode or Document). If the output node search type is Default then the following rules apply: In the enveloped XML signature case (there is a reference with URI= and transform http://www.w3.org/2000/09/xmldsig#enveloped-signature), the incoming XML document without the Signature element is set to the output message body. In the non-enveloped XML signature case, the message body is determined from a referenced Object; this is explained in more detail in chapter Output Node Determination in Enveloping XML Signature Case."},"xmlSignatureChecker":{"index":15,"kind":"parameter","displayName":"Xml Signature Checker","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xmlsecurity.api.XmlSignatureChecker","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"This interface allows the application to check the XML signature before the validation is executed. This step is recommended in http://www.w3.org/TR/xmldsig-bestpractices/#check-what-is-signed"},"lazyStartProducer":{"index":16,"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."},"uriDereferencer":{"index":17,"kind":"parameter","displayName":"Uri Dereferencer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.crypto.URIDereferencer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration","configurationField":"configuration","description":"If you want to restrict the remote access via reference URIs, you can set an own dereferencer. Optional parameter. If not set the provider default dereferencer is used which can resolve URI fragments, HTTP, file and XPpointer URIs. Attention: The implementation is provider dependent!"}}} , -{"component":{"kind":"component","name":"xmpp","title":"XMPP","description":"Send and receive messages to/from an XMPP chat server.","deprecated":false,"firstVersion":"1.0","label":"chat,messaging","javaType":"org.apache.camel.component.xmpp.XmppComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xmpp","version":"4.8.1","scheme":"xmpp","extendsScheme":"","syntax":"xmpp:host:port/participant","alternativeSyntax":"xmpp:user:password@host:port/participant","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelXmppDoc":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.jivesoftware.smack.packet.Message","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XMPP message","constantName":"org.apache.camel.component.xmpp.XmppConstants#DOC_HEADER"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname for the chat server"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Port number for the chat server"},"participant":{"index":2,"kind":"path","displayName":"Participant","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"JID (Jabber ID) of person to receive messages. room parameter has precedence over participant."},"login":{"index":3,"kind":"parameter","displayName":"Login","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to login the user."},"nickname":{"index":4,"kind":"parameter","displayName":"Nickname","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Use nickname when joining room. If room is specified and nickname is not, user will be used for the nickname."},"pubsub":{"index":5,"kind":"parameter","displayName":"Pubsub","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Accept pubsub packets on input, default is false"},"room":{"index":6,"kind":"parameter","displayName":"Room","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"If this option is specified, the component will connect to MUC (Multi User Chat). Usually, the domain name for MUC is different from the login domain. For example, if you are supermanjabber.org and want to join the krypton room, then the room URL is kryptonconference.jabber.org. Note the conference part. It is not a requirement to provide the full room JID. If the room parameter does not contain the symbol, the domain part will be discovered and added by Camel"},"serviceName":{"index":7,"kind":"parameter","displayName":"Service Name","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the service you are connecting to. For Google Talk, this would be gmail.com."},"testConnectionOnStartup":{"index":8,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether to test the connection on startup. This is used to ensure that the XMPP client has a valid connection to the XMPP server when the route starts. Camel throws an exception on startup if a connection cannot be established. When this option is set to false, Camel will attempt to establish a lazy connection when needed by a producer, and will poll for a consumer connection until the connection is established. Default is true."},"createAccount":{"index":9,"kind":"parameter","displayName":"Create Account","group":"common (advanced)","label":"common,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, an attempt to create an account will be made. Default is false."},"resource":{"index":10,"kind":"parameter","displayName":"Resource","group":"common (advanced)","label":"common,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Camel","description":"XMPP resource. The default is Camel."},"connectionPollDelay":{"index":11,"kind":"parameter","displayName":"Connection Poll Delay","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"description":"The amount of time in seconds between polls (in seconds) to verify the health of the XMPP connection, or between attempts to establish an initial consumer connection. Camel will try to re-establish a connection if it has become inactive. Default is 10 seconds."},"doc":{"index":12,"kind":"parameter","displayName":"Doc","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Set a doc header on the IN message containing a Document form of the incoming packet; default is true if presence or pubsub are true, otherwise false"},"bridgeErrorHandler":{"index":13,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":14,"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":{"index":15,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":16,"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."},"connectionConfig":{"index":17,"kind":"parameter","displayName":"Connection Config","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.jivesoftware.smack.ConnectionConfiguration","deprecated":false,"autowired":false,"secret":false,"description":"To use an existing connection configuration. Currently org.jivesoftware.smack.tcp.XMPPTCPConnectionConfiguration is only supported (XMPP over TCP)."},"headerFilterStrategy":{"index":18,"kind":"parameter","displayName":"Header Filter Strategy","group":"filter","label":"filter","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Password for login"},"roomPassword":{"index":20,"kind":"parameter","displayName":"Room Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Password for room"},"user":{"index":21,"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"User name (without server name). If not specified, anonymous login will be attempted."}}} +{"component":{"kind":"component","name":"xmpp","title":"XMPP","description":"Send and receive messages to/from an XMPP chat server.","deprecated":false,"firstVersion":"1.0","label":"chat,messaging","javaType":"org.apache.camel.component.xmpp.XmppComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xmpp","version":"4.8.2","scheme":"xmpp","extendsScheme":"","syntax":"xmpp:host:port/participant","alternativeSyntax":"xmpp:user:password@host:port/participant","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelXmppDoc":{"index":0,"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.jivesoftware.smack.packet.Message","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XMPP message","constantName":"org.apache.camel.component.xmpp.XmppConstants#DOC_HEADER"}},"properties":{"host":{"index":0,"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname for the chat server"},"port":{"index":1,"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Port number for the chat server"},"participant":{"index":2,"kind":"path","displayName":"Participant","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"JID (Jabber ID) of person to receive messages. room parameter has precedence over participant."},"login":{"index":3,"kind":"parameter","displayName":"Login","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to login the user."},"nickname":{"index":4,"kind":"parameter","displayName":"Nickname","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Use nickname when joining room. If room is specified and nickname is not, user will be used for the nickname."},"pubsub":{"index":5,"kind":"parameter","displayName":"Pubsub","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Accept pubsub packets on input, default is false"},"room":{"index":6,"kind":"parameter","displayName":"Room","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"If this option is specified, the component will connect to MUC (Multi User Chat). Usually, the domain name for MUC is different from the login domain. For example, if you are supermanjabber.org and want to join the krypton room, then the room URL is kryptonconference.jabber.org. Note the conference part. It is not a requirement to provide the full room JID. If the room parameter does not contain the symbol, the domain part will be discovered and added by Camel"},"serviceName":{"index":7,"kind":"parameter","displayName":"Service Name","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the service you are connecting to. For Google Talk, this would be gmail.com."},"testConnectionOnStartup":{"index":8,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether to test the connection on startup. This is used to ensure that the XMPP client has a valid connection to the XMPP server when the route starts. Camel throws an exception on startup if a connection cannot be established. When this option is set to false, Camel will attempt to establish a lazy connection when needed by a producer, and will poll for a consumer connection until the connection is established. Default is true."},"createAccount":{"index":9,"kind":"parameter","displayName":"Create Account","group":"common (advanced)","label":"common,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, an attempt to create an account will be made. Default is false."},"resource":{"index":10,"kind":"parameter","displayName":"Resource","group":"common (advanced)","label":"common,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Camel","description":"XMPP resource. The default is Camel."},"connectionPollDelay":{"index":11,"kind":"parameter","displayName":"Connection Poll Delay","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"description":"The amount of time in seconds between polls (in seconds) to verify the health of the XMPP connection, or between attempts to establish an initial consumer connection. Camel will try to re-establish a connection if it has become inactive. Default is 10 seconds."},"doc":{"index":12,"kind":"parameter","displayName":"Doc","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Set a doc header on the IN message containing a Document form of the incoming packet; default is true if presence or pubsub are true, otherwise false"},"bridgeErrorHandler":{"index":13,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":14,"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":{"index":15,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":16,"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."},"connectionConfig":{"index":17,"kind":"parameter","displayName":"Connection Config","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.jivesoftware.smack.ConnectionConfiguration","deprecated":false,"autowired":false,"secret":false,"description":"To use an existing connection configuration. Currently org.jivesoftware.smack.tcp.XMPPTCPConnectionConfiguration is only supported (XMPP over TCP)."},"headerFilterStrategy":{"index":18,"kind":"parameter","displayName":"Header Filter Strategy","group":"filter","label":"filter","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"password":{"index":19,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Password for login"},"roomPassword":{"index":20,"kind":"parameter","displayName":"Room Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Password for room"},"user":{"index":21,"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"User name (without server name). If not specified, anonymous login will be attempted."}}} , -{"component":{"kind":"component","name":"xquery","title":"XQuery","description":"Query and/or transform XML payloads using XQuery and Saxon.","deprecated":false,"firstVersion":"1.0.0","label":"transformation","javaType":"org.apache.camel.component.xquery.XQueryComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-saxon","version":"4.8.1","scheme":"xquery","extendsScheme":"","syntax":"xquery:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the template to load from classpath or file system"},"allowStAX":{"index":1,"kind":"parameter","displayName":"Allow St AX","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow using StAX mode"},"namespacePrefixes":{"index":2,"kind":"parameter","displayName":"Namespace Prefixes","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"Allows to control which namespace prefixes to use for a set of namespace mappings"},"resultsFormat":{"index":3,"kind":"parameter","displayName":"Results Format","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xquery.ResultFormat","enum":["Bytes","BytesSource","DOM","DOMSource","List","String","StringSource"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DOM","description":"What output result to use"},"resultType":{"index":4,"kind":"parameter","displayName":"Result Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"What output result to use defined as a class"},"source":{"index":5,"kind":"parameter","displayName":"Source","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Source to use, instead of message body. You can prefix with variable:, header:, or property: to specify kind of source. Otherwise, the source is assumed to be a variable. Use empty or null to use default source, which is the message body."},"stripsAllWhiteSpace":{"index":6,"kind":"parameter","displayName":"Strips All White Space","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to strip all whitespaces"},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":12,"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."},"configuration":{"index":13,"kind":"parameter","displayName":"Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"net.sf.saxon.Configuration","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom Saxon configuration"},"configurationProperties":{"index":14,"kind":"parameter","displayName":"Configuration Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"To set custom Saxon configuration properties"},"moduleURIResolver":{"index":15,"kind":"parameter","displayName":"Module URIResolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"net.sf.saxon.lib.ModuleURIResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use the custom ModuleURIResolver"},"parameters":{"index":16,"kind":"parameter","displayName":"Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"Additional parameters"},"properties":{"index":17,"kind":"parameter","displayName":"Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"description":"Properties to configure the serialization parameters"},"staticQueryContext":{"index":18,"kind":"parameter","displayName":"Static Query Context","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"net.sf.saxon.query.StaticQueryContext","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom Saxon StaticQueryContext"},"backoffErrorThreshold":{"index":19,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":20,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":21,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":22,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":23,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":24,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":25,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":26,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":27,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":28,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":29,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":30,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":31,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":32,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} +{"component":{"kind":"component","name":"xquery","title":"XQuery","description":"Query and/or transform XML payloads using XQuery and Saxon.","deprecated":false,"firstVersion":"1.0.0","label":"transformation","javaType":"org.apache.camel.component.xquery.XQueryComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-saxon","version":"4.8.2","scheme":"xquery","extendsScheme":"","syntax":"xquery:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":false},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the template to load from classpath or file system"},"allowStAX":{"index":1,"kind":"parameter","displayName":"Allow St AX","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow using StAX mode"},"namespacePrefixes":{"index":2,"kind":"parameter","displayName":"Namespace Prefixes","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"Allows to control which namespace prefixes to use for a set of namespace mappings"},"resultsFormat":{"index":3,"kind":"parameter","displayName":"Results Format","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xquery.ResultFormat","enum":["Bytes","BytesSource","DOM","DOMSource","List","String","StringSource"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DOM","description":"What output result to use"},"resultType":{"index":4,"kind":"parameter","displayName":"Result Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.Class","deprecated":false,"autowired":false,"secret":false,"description":"What output result to use defined as a class"},"source":{"index":5,"kind":"parameter","displayName":"Source","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Source to use, instead of message body. You can prefix with variable:, header:, or property: to specify kind of source. Otherwise, the source is assumed to be a variable. Use empty or null to use default source, which is the message body."},"stripsAllWhiteSpace":{"index":6,"kind":"parameter","displayName":"Strips All White Space","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to strip all whitespaces"},"sendEmptyMessageWhenIdle":{"index":7,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":8,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":9,"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":{"index":10,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":11,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":12,"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."},"configuration":{"index":13,"kind":"parameter","displayName":"Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"net.sf.saxon.Configuration","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom Saxon configuration"},"configurationProperties":{"index":14,"kind":"parameter","displayName":"Configuration Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"To set custom Saxon configuration properties"},"moduleURIResolver":{"index":15,"kind":"parameter","displayName":"Module URIResolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"net.sf.saxon.lib.ModuleURIResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use the custom ModuleURIResolver"},"parameters":{"index":16,"kind":"parameter","displayName":"Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"Additional parameters"},"properties":{"index":17,"kind":"parameter","displayName":"Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"description":"Properties to configure the serialization parameters"},"staticQueryContext":{"index":18,"kind":"parameter","displayName":"Static Query Context","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"net.sf.saxon.query.StaticQueryContext","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom Saxon StaticQueryContext"},"backoffErrorThreshold":{"index":19,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":20,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":21,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":22,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":23,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":24,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":25,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":26,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":27,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":28,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":29,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":30,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":31,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":32,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}} , -{"component":{"kind":"component","name":"xslt","title":"XSLT","description":"Transforms XML payload using an XSLT template.","deprecated":false,"firstVersion":"1.3.0","label":"core,transformation","javaType":"org.apache.camel.component.xslt.XsltComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xslt","version":"4.8.1","scheme":"xslt","extendsScheme":"","syntax":"xslt:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelXsltResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to load and use instead of the endpoint configured.","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_RESOURCE_URI"},"CamelXsltStylesheet":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_STYLESHEET"},"CamelXsltFileName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XSLT file name","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_FILE_NAME"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the template. The following is supported by the default URIResolver. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod"},"allowTemplateFromHeader":{"index":1,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":2,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Cache for the resource content (the stylesheet file) when it is loaded on startup. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation."},"deleteOutputFile":{"index":3,"kind":"parameter","displayName":"Delete Output File","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If you have output=file then this option dictates whether or not the output file should be deleted when the Exchange is done processing. For example suppose the output file is a temporary file, then it can be a good idea to delete it after use."},"failOnNullBody":{"index":4,"kind":"parameter","displayName":"Fail On Null Body","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to throw an exception if the input body is null."},"output":{"index":5,"kind":"parameter","displayName":"Output","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.XsltOutput","enum":["string","bytes","DOM","file"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"string","description":"Option to specify which output type to use. Possible values are: string, bytes, DOM, file. The first three options are all in memory based, where as file is streamed directly to a java.io.File. For file you must specify the filename in the IN header with the key XsltConstants.XSLT_FILE_NAME which is also CamelXsltFileName. Also any paths leading to the filename must be created beforehand, otherwise an exception is thrown at runtime."},"transformerCacheSize":{"index":6,"kind":"parameter","displayName":"Transformer Cache Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer()."},"lazyStartProducer":{"index":7,"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."},"entityResolver":{"index":8,"kind":"parameter","displayName":"Entity Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.xml.sax.EntityResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.xml.sax.EntityResolver with javax.xml.transform.sax.SAXSource."},"errorListener":{"index":9,"kind":"parameter","displayName":"Error Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.ErrorListener","deprecated":false,"autowired":false,"secret":false,"description":"Allows to configure to use a custom javax.xml.transform.ErrorListener. Beware when doing this then the default error listener which captures any errors or fatal errors and store information on the Exchange as properties is not in use. So only use this option for special use-cases."},"resultHandlerFactory":{"index":10,"kind":"parameter","displayName":"Result Handler Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.ResultHandlerFactory","deprecated":false,"autowired":false,"secret":false,"description":"Allows you to use a custom org.apache.camel.builder.xml.ResultHandlerFactory which is capable of using custom org.apache.camel.builder.xml.ResultHandler types."},"transformerFactory":{"index":11,"kind":"parameter","displayName":"Transformer Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.TransformerFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom XSLT transformer factory"},"transformerFactoryClass":{"index":12,"kind":"parameter","displayName":"Transformer Factory Class","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom XSLT transformer factory, specified as a FQN class name"},"transformerFactoryConfigurationStrategy":{"index":13,"kind":"parameter","displayName":"Transformer Factory Configuration Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.TransformerFactoryConfigurationStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A configuration strategy to apply on freshly created instances of TransformerFactory."},"uriResolver":{"index":14,"kind":"parameter","displayName":"Uri Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.URIResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom javax.xml.transform.URIResolver"},"xsltMessageLogger":{"index":15,"kind":"parameter","displayName":"Xslt Message Logger","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.XsltMessageLogger","deprecated":false,"autowired":false,"secret":false,"description":"A consumer to messages generated during XSLT transformations."}}} +{"component":{"kind":"component","name":"xslt","title":"XSLT","description":"Transforms XML payload using an XSLT template.","deprecated":false,"firstVersion":"1.3.0","label":"core,transformation","javaType":"org.apache.camel.component.xslt.XsltComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xslt","version":"4.8.2","scheme":"xslt","extendsScheme":"","syntax":"xslt:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelXsltResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to load and use instead of the endpoint configured.","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_RESOURCE_URI"},"CamelXsltStylesheet":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_STYLESHEET"},"CamelXsltFileName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XSLT file name","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_FILE_NAME"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the template. The following is supported by the default URIResolver. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod"},"allowTemplateFromHeader":{"index":1,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":2,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Cache for the resource content (the stylesheet file) when it is loaded on startup. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation."},"deleteOutputFile":{"index":3,"kind":"parameter","displayName":"Delete Output File","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If you have output=file then this option dictates whether or not the output file should be deleted when the Exchange is done processing. For example suppose the output file is a temporary file, then it can be a good idea to delete it after use."},"failOnNullBody":{"index":4,"kind":"parameter","displayName":"Fail On Null Body","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to throw an exception if the input body is null."},"output":{"index":5,"kind":"parameter","displayName":"Output","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.XsltOutput","enum":["string","bytes","DOM","file"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"string","description":"Option to specify which output type to use. Possible values are: string, bytes, DOM, file. The first three options are all in memory based, where as file is streamed directly to a java.io.File. For file you must specify the filename in the IN header with the key XsltConstants.XSLT_FILE_NAME which is also CamelXsltFileName. Also any paths leading to the filename must be created beforehand, otherwise an exception is thrown at runtime."},"transformerCacheSize":{"index":6,"kind":"parameter","displayName":"Transformer Cache Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer()."},"lazyStartProducer":{"index":7,"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."},"entityResolver":{"index":8,"kind":"parameter","displayName":"Entity Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.xml.sax.EntityResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.xml.sax.EntityResolver with javax.xml.transform.sax.SAXSource."},"errorListener":{"index":9,"kind":"parameter","displayName":"Error Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.ErrorListener","deprecated":false,"autowired":false,"secret":false,"description":"Allows to configure to use a custom javax.xml.transform.ErrorListener. Beware when doing this then the default error listener which captures any errors or fatal errors and store information on the Exchange as properties is not in use. So only use this option for special use-cases."},"resultHandlerFactory":{"index":10,"kind":"parameter","displayName":"Result Handler Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.ResultHandlerFactory","deprecated":false,"autowired":false,"secret":false,"description":"Allows you to use a custom org.apache.camel.builder.xml.ResultHandlerFactory which is capable of using custom org.apache.camel.builder.xml.ResultHandler types."},"transformerFactory":{"index":11,"kind":"parameter","displayName":"Transformer Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.TransformerFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom XSLT transformer factory"},"transformerFactoryClass":{"index":12,"kind":"parameter","displayName":"Transformer Factory Class","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom XSLT transformer factory, specified as a FQN class name"},"transformerFactoryConfigurationStrategy":{"index":13,"kind":"parameter","displayName":"Transformer Factory Configuration Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.TransformerFactoryConfigurationStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A configuration strategy to apply on freshly created instances of TransformerFactory."},"uriResolver":{"index":14,"kind":"parameter","displayName":"Uri Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.URIResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom javax.xml.transform.URIResolver"},"xsltMessageLogger":{"index":15,"kind":"parameter","displayName":"Xslt Message Logger","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.XsltMessageLogger","deprecated":false,"autowired":false,"secret":false,"description":"A consumer to messages generated during XSLT transformations."}}} , -{"component":{"kind":"component","name":"xslt-saxon","title":"XSLT Saxon","description":"Transform XML payloads using an XSLT template using Saxon.","deprecated":false,"firstVersion":"3.0.0","label":"core,transformation","javaType":"org.apache.camel.component.xslt.saxon.XsltSaxonComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xslt-saxon","version":"4.8.1","scheme":"xslt-saxon","extendsScheme":"","syntax":"xslt-saxon:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelXsltResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to load and use instead of the endpoint configured.","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_RESOURCE_URI"},"CamelXsltStylesheet":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_STYLESHEET"},"CamelXsltFileName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XSLT file name","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_FILE_NAME"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the template. The following is supported by the default URIResolver. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod"},"allowStAX":{"index":1,"kind":"parameter","displayName":"Allow StAX","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to allow using StAX as the javax.xml.transform.Source. You can enable this if the XSLT library supports StAX such as the Saxon library (camel-saxon). The Xalan library (default in JVM) does not support StAXSource."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Cache for the resource content (the stylesheet file) when it is loaded on startup. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation."},"deleteOutputFile":{"index":4,"kind":"parameter","displayName":"Delete Output File","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If you have output=file then this option dictates whether or not the output file should be deleted when the Exchange is done processing. For example suppose the output file is a temporary file, then it can be a good idea to delete it after use."},"failOnNullBody":{"index":5,"kind":"parameter","displayName":"Fail On Null Body","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to throw an exception if the input body is null."},"output":{"index":6,"kind":"parameter","displayName":"Output","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.XsltOutput","enum":["string","bytes","DOM","file"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"string","description":"Option to specify which output type to use. Possible values are: string, bytes, DOM, file. The first three options are all in memory based, where as file is streamed directly to a java.io.File. For file you must specify the filename in the IN header with the key XsltConstants.XSLT_FILE_NAME which is also CamelXsltFileName. Also any paths leading to the filename must be created beforehand, otherwise an exception is thrown at runtime."},"transformerCacheSize":{"index":7,"kind":"parameter","displayName":"Transformer Cache Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer()."},"lazyStartProducer":{"index":8,"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."},"entityResolver":{"index":9,"kind":"parameter","displayName":"Entity Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.xml.sax.EntityResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.xml.sax.EntityResolver with javax.xml.transform.sax.SAXSource."},"errorListener":{"index":10,"kind":"parameter","displayName":"Error Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.ErrorListener","deprecated":false,"autowired":false,"secret":false,"description":"Allows to configure to use a custom javax.xml.transform.ErrorListener. Beware when doing this then the default error listener which captures any errors or fatal errors and store information on the Exchange as properties is not in use. So only use this option for special use-cases."},"resultHandlerFactory":{"index":11,"kind":"parameter","displayName":"Result Handler Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.ResultHandlerFactory","deprecated":false,"autowired":false,"secret":false,"description":"Allows you to use a custom org.apache.camel.builder.xml.ResultHandlerFactory which is capable of using custom org.apache.camel.builder.xml.ResultHandler types."},"saxonConfiguration":{"index":12,"kind":"parameter","displayName":"Saxon Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"net.sf.saxon.Configuration","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom Saxon configuration"},"saxonExtensionFunctions":{"index":13,"kind":"parameter","displayName":"Saxon Extension Functions","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry, where you can comma to separate multiple values to lookup."},"secureProcessing":{"index":14,"kind":"parameter","displayName":"Secure Processing","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Feature for XML secure processing (see javax.xml.XMLConstants). This is enabled by default. However, when using Saxon Professional you may need to turn this off to allow Saxon to be able to use Java extension functions."},"transformerFactory":{"index":15,"kind":"parameter","displayName":"Transformer Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.TransformerFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom XSLT transformer factory"},"transformerFactoryClass":{"index":16,"kind":"parameter","displayName":"Transformer Factory Class","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom XSLT transformer factory, specified as a FQN class name"},"transformerFactoryConfigurationStrategy":{"index":17,"kind":"parameter","displayName":"Transformer Factory Configuration Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.TransformerFactoryConfigurationStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A configuration strategy to apply on freshly created instances of TransformerFactory."},"uriResolver":{"index":18,"kind":"parameter","displayName":"Uri Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.URIResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom javax.xml.transform.URIResolver"},"xsltMessageLogger":{"index":19,"kind":"parameter","displayName":"Xslt Message Logger","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.XsltMessageLogger","deprecated":false,"autowired":false,"secret":false,"description":"A consumer to messages generated during XSLT transformations."}}} +{"component":{"kind":"component","name":"xslt-saxon","title":"XSLT Saxon","description":"Transform XML payloads using an XSLT template using Saxon.","deprecated":false,"firstVersion":"3.0.0","label":"core,transformation","javaType":"org.apache.camel.component.xslt.saxon.XsltSaxonComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xslt-saxon","version":"4.8.2","scheme":"xslt-saxon","extendsScheme":"","syntax":"xslt-saxon:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false,"remote":false},"headers":{"CamelXsltResourceUri":{"index":0,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A URI for the template resource to load and use instead of the endpoint configured.","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_RESOURCE_URI"},"CamelXsltStylesheet":{"index":1,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template to use instead of the endpoint configured.","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_STYLESHEET"},"CamelXsltFileName":{"index":2,"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XSLT file name","constantName":"org.apache.camel.component.xslt.XsltConstants#XSLT_FILE_NAME"}},"properties":{"resourceUri":{"index":0,"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the template. The following is supported by the default URIResolver. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod"},"allowStAX":{"index":1,"kind":"parameter","displayName":"Allow StAX","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to allow using StAX as the javax.xml.transform.Source. You can enable this if the XSLT library supports StAX such as the Saxon library (camel-saxon). The Xalan library (default in JVM) does not support StAXSource."},"allowTemplateFromHeader":{"index":2,"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"contentCache":{"index":3,"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Cache for the resource content (the stylesheet file) when it is loaded on startup. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation."},"deleteOutputFile":{"index":4,"kind":"parameter","displayName":"Delete Output File","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If you have output=file then this option dictates whether or not the output file should be deleted when the Exchange is done processing. For example suppose the output file is a temporary file, then it can be a good idea to delete it after use."},"failOnNullBody":{"index":5,"kind":"parameter","displayName":"Fail On Null Body","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether or not to throw an exception if the input body is null."},"output":{"index":6,"kind":"parameter","displayName":"Output","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.XsltOutput","enum":["string","bytes","DOM","file"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"string","description":"Option to specify which output type to use. Possible values are: string, bytes, DOM, file. The first three options are all in memory based, where as file is streamed directly to a java.io.File. For file you must specify the filename in the IN header with the key XsltConstants.XSLT_FILE_NAME which is also CamelXsltFileName. Also any paths leading to the filename must be created beforehand, otherwise an exception is thrown at runtime."},"transformerCacheSize":{"index":7,"kind":"parameter","displayName":"Transformer Cache Size","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer()."},"lazyStartProducer":{"index":8,"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."},"entityResolver":{"index":9,"kind":"parameter","displayName":"Entity Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.xml.sax.EntityResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom org.xml.sax.EntityResolver with javax.xml.transform.sax.SAXSource."},"errorListener":{"index":10,"kind":"parameter","displayName":"Error Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.ErrorListener","deprecated":false,"autowired":false,"secret":false,"description":"Allows to configure to use a custom javax.xml.transform.ErrorListener. Beware when doing this then the default error listener which captures any errors or fatal errors and store information on the Exchange as properties is not in use. So only use this option for special use-cases."},"resultHandlerFactory":{"index":11,"kind":"parameter","displayName":"Result Handler Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.ResultHandlerFactory","deprecated":false,"autowired":false,"secret":false,"description":"Allows you to use a custom org.apache.camel.builder.xml.ResultHandlerFactory which is capable of using custom org.apache.camel.builder.xml.ResultHandler types."},"saxonConfiguration":{"index":12,"kind":"parameter","displayName":"Saxon Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"net.sf.saxon.Configuration","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom Saxon configuration"},"saxonExtensionFunctions":{"index":13,"kind":"parameter","displayName":"Saxon Extension Functions","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry, where you can comma to separate multiple values to lookup."},"secureProcessing":{"index":14,"kind":"parameter","displayName":"Secure Processing","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Feature for XML secure processing (see javax.xml.XMLConstants). This is enabled by default. However, when using Saxon Professional you may need to turn this off to allow Saxon to be able to use Java extension functions."},"transformerFactory":{"index":15,"kind":"parameter","displayName":"Transformer Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.TransformerFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom XSLT transformer factory"},"transformerFactoryClass":{"index":16,"kind":"parameter","displayName":"Transformer Factory Class","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom XSLT transformer factory, specified as a FQN class name"},"transformerFactoryConfigurationStrategy":{"index":17,"kind":"parameter","displayName":"Transformer Factory Configuration Strategy","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.TransformerFactoryConfigurationStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A configuration strategy to apply on freshly created instances of TransformerFactory."},"uriResolver":{"index":18,"kind":"parameter","displayName":"Uri Resolver","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.transform.URIResolver","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom javax.xml.transform.URIResolver"},"xsltMessageLogger":{"index":19,"kind":"parameter","displayName":"Xslt Message Logger","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.xslt.XsltMessageLogger","deprecated":false,"autowired":false,"secret":false,"description":"A consumer to messages generated during XSLT transformations."}}} , -{"component":{"kind":"component","name":"zeebe","title":"Zeebe","description":"Zeebe component which integrates with Camunda Zeebe to interact with the API.","deprecated":false,"firstVersion":"3.21.0","label":"workflow,saas","javaType":"org.apache.camel.component.zeebe.ZeebeComponent","supportLevel":"Experimental","groupId":"org.apache.camel","artifactId":"camel-zeebe","version":"4.8.1","scheme":"zeebe","extendsScheme":"","syntax":"zeebe:operationName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelZeebeResourceName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the resource.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#RESOURCE_NAME"},"CamelZeebeIsSuccess":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"True if the operation was successful.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#IS_SUCCESS"},"CamelZeebeErrorMessage":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of an error, the error message.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#ERROR_MESSAGE"},"CamelZeebeErrorCode":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of an error, the error code if available.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#ERROR_CODE"},"CamelZeebeBPMNProcessId":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The process ID of a deployed process.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#BPMN_PROCESS_ID"},"CamelZeebeVersion":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The version of a deployed process.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#VERSION"},"CamelZeebeProcessDefinitionKey":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The process definition key of a deployed process.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#PROCESS_DEFINITION_KEY"},"CamelZeebeJobKey":{"index":7,"kind":"header","displayName":"","group":"common","label":"common","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of a job. The worker consumer adds the job key to the headers and the operations completeJob and failJob accept the job key in the header if no JobRequest is provided in the body.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#JOB_KEY"}},"properties":{"operationName":{"index":0,"kind":"path","displayName":"Operation Name","group":"common","label":"common","required":true,"type":"object","javaType":"org.apache.camel.component.zeebe.internal.OperationName","enum":["startProcess","cancelProcess","publishMessage","completeJob","failJob","updateJobRetries","worker","throwError","deployResource"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to use"},"formatJSON":{"index":1,"kind":"parameter","displayName":"Format JSON","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Format the result in the body as JSON."},"jobKey":{"index":2,"kind":"parameter","displayName":"Job Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"JobKey for the job worker."},"timeout":{"index":3,"kind":"parameter","displayName":"Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":10,"description":"Timeout for job worker."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":7,"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."}}} +{"component":{"kind":"component","name":"zeebe","title":"Zeebe","description":"Zeebe component which integrates with Camunda Zeebe to interact with the API.","deprecated":false,"firstVersion":"3.21.0","label":"workflow,saas","javaType":"org.apache.camel.component.zeebe.ZeebeComponent","supportLevel":"Experimental","groupId":"org.apache.camel","artifactId":"camel-zeebe","version":"4.8.2","scheme":"zeebe","extendsScheme":"","syntax":"zeebe:operationName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelZeebeResourceName":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the resource.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#RESOURCE_NAME"},"CamelZeebeIsSuccess":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"True if the operation was successful.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#IS_SUCCESS"},"CamelZeebeErrorMessage":{"index":2,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of an error, the error message.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#ERROR_MESSAGE"},"CamelZeebeErrorCode":{"index":3,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of an error, the error code if available.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#ERROR_CODE"},"CamelZeebeBPMNProcessId":{"index":4,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The process ID of a deployed process.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#BPMN_PROCESS_ID"},"CamelZeebeVersion":{"index":5,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The version of a deployed process.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#VERSION"},"CamelZeebeProcessDefinitionKey":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The process definition key of a deployed process.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#PROCESS_DEFINITION_KEY"},"CamelZeebeJobKey":{"index":7,"kind":"header","displayName":"","group":"common","label":"common","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of a job. The worker consumer adds the job key to the headers and the operations completeJob and failJob accept the job key in the header if no JobRequest is provided in the body.","constantName":"org.apache.camel.component.zeebe.ZeebeConstants#JOB_KEY"}},"properties":{"operationName":{"index":0,"kind":"path","displayName":"Operation Name","group":"common","label":"common","required":true,"type":"object","javaType":"org.apache.camel.component.zeebe.internal.OperationName","enum":["startProcess","cancelProcess","publishMessage","completeJob","failJob","updateJobRetries","worker","throwError","deployResource"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to use"},"formatJSON":{"index":1,"kind":"parameter","displayName":"Format JSON","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Format the result in the body as JSON."},"jobKey":{"index":2,"kind":"parameter","displayName":"Job Key","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"JobKey for the job worker."},"timeout":{"index":3,"kind":"parameter","displayName":"Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":10,"description":"Timeout for job worker."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"index":7,"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."}}} , -{"component":{"kind":"component","name":"zendesk","title":"Zendesk","description":"Manage Zendesk tickets, users, organizations, etc.","deprecated":false,"firstVersion":"2.19.0","label":"cloud,api,saas","javaType":"org.apache.camel.component.zendesk.ZendeskComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-zendesk","version":"4.8.1","scheme":"zendesk","extendsScheme":"","syntax":"zendesk:methodName","async":false,"api":true,"apiSyntax":"methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"methodName":{"index":0,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.zendesk.internal.ZendeskApiMethod","enum":["ADD_TAG_TO_ORGANISATIONS","ADD_TAG_TO_TICKET","ADD_TAG_TO_TOPICS","ASSOCIATE_ATTACHMENTS_TO_ARTICLE","CHANGE_USER_PASSWORD","CREATE_ARTICLE","CREATE_ARTICLE_1","CREATE_ARTICLE_TRANSLATION","CREATE_AUTOMATION","CREATE_CATEGORY","CREATE_CATEGORY_TRANSLATION","CREATE_COMMENT","CREATE_CONTENT_TAG","CREATE_DYNAMIC_CONTENT_ITEM","CREATE_DYNAMIC_CONTENT_ITEM_VARIANT","CREATE_FORUM","CREATE_GROUP","CREATE_GROUP_MEMBERSHIP","CREATE_GROUP_MEMBERSHIP_1","CREATE_MACRO","CREATE_OR_UPDATE_ORGANIZATION","CREATE_OR_UPDATE_USER","CREATE_OR_UPDATE_USERS","CREATE_OR_UPDATE_USERS_1","CREATE_OR_UPDATE_USERS_ASYNC","CREATE_ORGANIZATION","CREATE_ORGANIZATION_MEMBERSHIP","CREATE_ORGANIZATION_MEMBERSHIP_1","CREATE_ORGANIZATION_MEMBERSHIPS","CREATE_ORGANIZATION_MEMBERSHIPS_1","CREATE_ORGANIZATION_MEMBERSHIPS_ASYNC","CREATE_ORGANIZATIONS","CREATE_ORGANIZATIONS_1","CREATE_ORGANIZATIONS_ASYNC","CREATE_PERMISSION_GROUP","CREATE_REQUEST","CREATE_SATISFACTION_RATING","CREATE_SATISFACTION_RATING_1","CREATE_SECTION","CREATE_SECTION_TRANSLATION","CREATE_TARGET","CREATE_TICKET","CREATE_TICKET_ASYNC","CREATE_TICKET_FIELD","CREATE_TICKET_FORM","CREATE_TICKET_FROM_TWEET","CREATE_TICKETS","CREATE_TICKETS_1","CREATE_TICKETS_ASYNC","CREATE_TOPIC","CREATE_TRIGGER","CREATE_UPLOAD","CREATE_UPLOAD_1","CREATE_UPLOAD_2","CREATE_UPLOAD_ARTICLE","CREATE_UPLOAD_ARTICLE_1","CREATE_USER","CREATE_USER_IDENTITY","CREATE_USER_IDENTITY_1","CREATE_USER_SEGMENT","CREATE_USERS","CREATE_USERS_1","CREATE_USERS_ASYNC","DELETE_ARTICLE","DELETE_ARTICLE_ATTACHMENT","DELETE_ARTICLE_ATTACHMENT_1","DELETE_ATTACHMENT","DELETE_ATTACHMENT_1","DELETE_AUTOMATION","DELETE_CATEGORY","DELETE_CONTENT_TAG","DELETE_DYNAMIC_CONTENT_ITEM","DELETE_DYNAMIC_CONTENT_ITEM_VARIANT","DELETE_FORUM","DELETE_GROUP","DELETE_GROUP_1","DELETE_GROUP_MEMBERSHIP","DELETE_GROUP_MEMBERSHIP_1","DELETE_GROUP_MEMBERSHIP_2","DELETE_GROUP_MEMBERSHIP_3","DELETE_ORGANIZATION","DELETE_ORGANIZATION_1","DELETE_ORGANIZATION_MEMBERSHIP","DELETE_ORGANIZATION_MEMBERSHIP_1","DELETE_ORGANIZATION_MEMBERSHIP_2","DELETE_ORGANIZATION_MEMBERSHIPS","DELETE_ORGANIZATIONS","DELETE_PERMISSION_GROUP","DELETE_PERMISSION_GROUP_1","DELETE_SECTION","DELETE_SUSPENDED_TICKET","DELETE_SUSPENDED_TICKET_1","DELETE_TARGET","DELETE_TICKET","DELETE_TICKET_1","DELETE_TICKET_FIELD","DELETE_TICKET_FIELD_1","DELETE_TICKET_FORM","DELETE_TICKET_FORM_1","DELETE_TICKETS","DELETE_TOPIC","DELETE_TRANSLATION","DELETE_TRANSLATION_1","DELETE_TRIGGER","DELETE_UPLOAD","DELETE_UPLOAD_1","DELETE_USER","DELETE_USER_1","DELETE_USER_IDENTITY","DELETE_USER_IDENTITY_1","DELETE_USER_IDENTITY_2","DELETE_USER_SEGMENT","DELETE_USER_SEGMENT_1","DELETE_USERS","GET_ACTIVE_TRIGGERS","GET_ARTICLE","GET_ARTICLE_FROM_SEARCH","GET_ARTICLE_FROM_SEARCH_1","GET_ARTICLE_SUBSCRIPTIONS","GET_ARTICLE_SUBSCRIPTIONS_1","GET_ARTICLE_TRANSLATIONS","GET_ARTICLES","GET_ARTICLES_1","GET_ARTICLES_2","GET_ARTICLES_3","GET_ARTICLES_4","GET_ARTICLES_5","GET_ARTICLES_FROM_ALL_LABELS","GET_ARTICLES_FROM_ANY_LABELS","GET_ARTICLES_FROM_PAGE","GET_ARTICLES_INCREMENTALLY","GET_ASSIGNABLE_GROUP_MEMBERSHIPS","GET_ASSIGNABLE_GROUP_MEMBERSHIPS_1","GET_ASSIGNABLE_GROUPS","GET_ASSIGNED_TICKETS_COUNT_FOR_USER","GET_ATTACHMENT","GET_ATTACHMENT_1","GET_ATTACHMENTS_FROM_ARTICLE","GET_AUTHENTICATED_USER","GET_AUTO_COMPLETE_ORGANIZATIONS","GET_AUTOMATION","GET_AUTOMATIONS","GET_BRANDS","GET_CC_REQUESTS","GET_CATEGORIES","GET_CATEGORY","GET_CATEGORY_TRANSLATIONS","GET_CCD_TICKETS_COUNT_FOR_USER","GET_COMPLIANCE_DELETION_STATUSES","GET_CONTENT_TAG","GET_CONTENT_TAGS","GET_CONTENT_TAGS_1","GET_CONTENT_TAGS_2","GET_CURRENT_USER","GET_CUSTOM_AGENT_ROLES","GET_CUSTOM_TICKET_STATUSES","GET_DELETED_TICKETS","GET_DELETED_TICKETS_1","GET_DYNAMIC_CONTENT_ITEM","GET_DYNAMIC_CONTENT_ITEM_VARIANT","GET_DYNAMIC_CONTENT_ITEM_VARIANTS","GET_DYNAMIC_CONTENT_ITEMS","GET_FORUM","GET_FORUMS","GET_FORUMS_1","GET_GROUP","GET_GROUP_MEMBERSHIP","GET_GROUP_MEMBERSHIP_1","GET_GROUP_MEMBERSHIP_BY_USER","GET_GROUP_MEMBERSHIPS","GET_GROUP_MEMBERSHIPS_1","GET_GROUP_ORGANIZATION","GET_GROUP_USERS","GET_GROUPS","GET_HELP_CENTER_LOCALES","GET_HOLIDAYS_FOR_SCHEDULE","GET_HOLIDAYS_FOR_SCHEDULE_1","GET_INCREMENTAL_TICKETS_RESULT","GET_JIRA_LINKS","GET_JOB_STATUS","GET_JOB_STATUS_ASYNC","GET_JOB_STATUSES","GET_JOB_STATUSES_ASYNC","GET_LOCALES","GET_MACRO","GET_MACROS","GET_OPEN_REQUESTS","GET_ORGANIZATION","GET_ORGANIZATION_FIELDS","GET_ORGANIZATION_MEMBERSHIP","GET_ORGANIZATION_MEMBERSHIP_BY_USER","GET_ORGANIZATION_MEMBERSHIP_FOR_USER","GET_ORGANIZATION_MEMBERSHIPS","GET_ORGANIZATION_MEMBERSHIPS_FOR_ORG","GET_ORGANIZATION_MEMBERSHIPS_FOR_USER","GET_ORGANIZATION_REQUESTS","GET_ORGANIZATION_TICKETS","GET_ORGANIZATION_USERS","GET_ORGANIZATIONS","GET_ORGANIZATIONS_1","GET_ORGANIZATIONS_INCREMENTALLY","GET_PERMISSION_GROUP","GET_PERMISSION_GROUPS","GET_RECENT_TICKETS","GET_REQUEST","GET_REQUEST_COMMENT","GET_REQUEST_COMMENT_1","GET_REQUEST_COMMENT_2","GET_REQUEST_COMMENTS","GET_REQUEST_COMMENTS_1","GET_REQUESTS","GET_SATISFACTION_RATING","GET_SATISFACTION_RATINGS","GET_SCHEDULE","GET_SCHEDULE_1","GET_SCHEDULES","GET_SEARCH_TICKET_RESULTS","GET_SECTION","GET_SECTION_SUBSCRIPTIONS","GET_SECTION_SUBSCRIPTIONS_1","GET_SECTION_TRANSLATIONS","GET_SECTIONS","GET_SECTIONS_1","GET_SECTIONS_2","GET_SOLVED_REQUESTS","GET_SUSPENDED_TICKETS","GET_TARGET","GET_TARGETS","GET_TICKET","GET_TICKET_AUDIT","GET_TICKET_AUDIT_1","GET_TICKET_AUDIT_2","GET_TICKET_AUDITS","GET_TICKET_AUDITS_1","GET_TICKET_COLLABORATORS","GET_TICKET_COMMENTS","GET_TICKET_COMMENTS_1","GET_TICKET_FIELD","GET_TICKET_FIELDS","GET_TICKET_FORM","GET_TICKET_FORMS","GET_TICKET_INCIDENTS","GET_TICKET_METRIC","GET_TICKET_METRIC_BY_TICKET","GET_TICKET_METRICS","GET_TICKETS","GET_TICKETS_1","GET_TICKETS_BY_EXTERNAL_ID","GET_TICKETS_BY_EXTERNAL_ID_1","GET_TICKETS_COUNT","GET_TICKETS_COUNT_FOR_ORGANIZATION","GET_TICKETS_FROM_SEARCH","GET_TICKETS_INCREMENTALLY","GET_TICKETS_INCREMENTALLY_1","GET_TIME_ZONES","GET_TOPIC","GET_TOPICS","GET_TOPICS_1","GET_TOPICS_2","GET_TOPICS_3","GET_TOPICS_BY_USER","GET_TRIGGER","GET_TRIGGERS","GET_TRIGGERS_1","GET_TWITTER_MONITORS","GET_USER","GET_USER_CCD_TICKETS","GET_USER_FIELDS","GET_USER_IDENTITIES","GET_USER_IDENTITIES_1","GET_USER_IDENTITY","GET_USER_IDENTITY_1","GET_USER_IDENTITY_2","GET_USER_RELATED_INFO","GET_USER_REQUESTED_TICKETS","GET_USER_REQUESTS","GET_USER_REQUESTS_1","GET_USER_SEGMENT","GET_USER_SEGMENTS","GET_USER_SEGMENTS_1","GET_USER_SEGMENTS_APPLICABLE","GET_USER_SUBSCRIPTIONS","GET_USER_SUBSCRIPTIONS_1","GET_USERS","GET_USERS_1","GET_USERS_BY_EXTERNAL_IDS","GET_USERS_BY_EXTERNAL_IDS_1","GET_USERS_BY_ROLE","GET_USERS_INCREMENTALLY","GET_VIEW","GET_VIEWS","IMPORT_TICKET","IMPORT_TOPIC","LIST_HELP_CENTER_LOCALES","LOOKUP_ORGANIZATIONS_BY_EXTERNAL_ID","LOOKUP_USER_BY_EMAIL","LOOKUP_USER_BY_EXTERNAL_ID","MACROS_SHOW_CHANGES_TO_TICKET","MACROS_SHOW_TICKET_AFTER_CHANGES","MAKE_PRIVATE_TICKET_AUDIT","MAKE_PRIVATE_TICKET_AUDIT_1","MAKE_PRIVATE_TICKET_AUDIT_2","MARK_TICKET_AS_SPAM","MARK_TICKET_AS_SPAM_1","MERGE_USERS","NOTIFY_APP","PERMANENTLY_DELETE_TICKET","PERMANENTLY_DELETE_TICKET_1","PERMANENTLY_DELETE_TICKETS","PERMANENTLY_DELETE_USER","PERMANENTLY_DELETE_USER_1","QUEUE_CREATE_TICKET_ASYNC","REMOVE_TAG_FROM_ORGANISATIONS","REMOVE_TAG_FROM_TICKET","REMOVE_TAG_FROM_TOPICS","REQUEST_VERIFY_USER_IDENTITY","REQUEST_VERIFY_USER_IDENTITY_1","REQUEST_VERIFY_USER_IDENTITY_2","RESET_USER_PASSWORD","RESET_USER_PASSWORD_1","SEARCH_TRIGGERS","SEARCH_TRIGGERS_1","SET_GROUP_MEMBERSHIP_AS_DEFAULT","SET_ORGANIZATION_MEMBERSHIP_AS_DEFAULT","SET_TAG_ON_ORGANISATIONS","SET_TAG_ON_TICKET","SET_TAG_ON_TOPICS","SET_USER_PRIMARY_IDENTITY","SET_USER_PRIMARY_IDENTITY_1","SET_USER_PRIMARY_IDENTITY_2","SHOW_ARTICLE_TRANSLATION","SHOW_CATEGORY_TRANSLATION","SHOW_SECTION_TRANSLATION","SUSPEND_USER","TRUST_TICKET_AUDIT","TRUST_TICKET_AUDIT_1","TRUST_TICKET_AUDIT_2","UNSUSPEND_USER","UPDATE_ARTICLE","UPDATE_ARTICLE_TRANSLATION","UPDATE_AUTOMATION","UPDATE_CATEGORY","UPDATE_CATEGORY_TRANSLATION","UPDATE_CONTENT_TAG","UPDATE_DYNAMIC_CONTENT_ITEM","UPDATE_DYNAMIC_CONTENT_ITEM_VARIANT","UPDATE_FORUM","UPDATE_GROUP","UPDATE_INSTALLATION","UPDATE_MACRO","UPDATE_ORGANIZATION","UPDATE_ORGANIZATIONS","UPDATE_ORGANIZATIONS_1","UPDATE_ORGANIZATIONS_ASYNC","UPDATE_PERMISSION_GROUP","UPDATE_REQUEST","UPDATE_SECTION","UPDATE_SECTION_TRANSLATION","UPDATE_TICKET","UPDATE_TICKET_FIELD","UPDATE_TICKET_FORM","UPDATE_TICKETS","UPDATE_TICKETS_1","UPDATE_TICKETS_ASYNC","UPDATE_TOPIC","UPDATE_TRIGGER","UPDATE_USER","UPDATE_USER_IDENTITY","UPDATE_USER_IDENTITY_1","UPDATE_USER_SEGMENT","UPDATE_USERS","UPDATE_USERS_1","UPDATE_USERS_ASYNC","VERIFY_USER_IDENTITY","VERIFY_USER_IDENTITY_1","VERIFY_USER_IDENTITY_2"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.zendesk.ZendeskConfiguration","configurationField":"configuration","description":"What operation to use"},"inBody":{"index":1,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"serverUrl":{"index":2,"kind":"parameter","displayName":"Server Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.zendesk.ZendeskConfiguration","configurationField":"configuration","description":"The server URL to connect."},"sendEmptyMessageWhenIdle":{"index":3,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":7,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":8,"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."},"backoffErrorThreshold":{"index":9,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":10,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":11,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":12,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":13,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":14,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":15,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":16,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":17,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":18,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":19,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":20,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":21,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":22,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"oauthToken":{"index":23,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.zendesk.ZendeskConfiguration","configurationField":"configuration","description":"The OAuth token."},"password":{"index":24,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.zendesk.ZendeskConfiguration","configurationField":"configuration","description":"The password."},"token":{"index":25,"kind":"parameter","displayName":"Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.zendesk.ZendeskConfiguration","configurationField":"configuration","description":"The security token."},"username":{"index":26,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.zendesk.ZendeskConfiguration","configurationField":"configuration","description":"The user name."}},"apis":{"DEFAULT":{"consumerOnly":false,"producerOnly":false,"description":"","methods":{"addTagToOrganisations":{"description":"","signatures":["java.util.List addTagToOrganisations(long id, String[] tags)"]},"addTagToTicket":{"description":"","signatures":["java.util.List addTagToTicket(long id, String[] tags)"]},"addTagToTopics":{"description":"","signatures":["java.util.List addTagToTopics(long id, String[] tags)"]},"associateAttachmentsToArticle":{"description":"","signatures":["void associateAttachmentsToArticle(String idArticle, java.util.List attachments)"]},"changeUserPassword":{"description":"","signatures":["void changeUserPassword(org.zendesk.client.v2.model.User user, String oldPassword, String newPassword)"]},"createArticle":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Article createArticle(org.zendesk.client.v2.model.hc.Article article)","org.zendesk.client.v2.model.hc.Article createArticle(org.zendesk.client.v2.model.hc.Article article, boolean notifySubscribers)"]},"createArticleTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation createArticleTranslation(Long articleId, org.zendesk.client.v2.model.hc.Translation translation)"]},"createAutomation":{"description":"","signatures":["org.zendesk.client.v2.model.Automation createAutomation(org.zendesk.client.v2.model.Automation automation)"]},"createCategory":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Category createCategory(org.zendesk.client.v2.model.hc.Category category)"]},"createCategoryTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation createCategoryTranslation(Long categoryId, org.zendesk.client.v2.model.hc.Translation translation)"]},"createComment":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket createComment(long ticketId, org.zendesk.client.v2.model.Comment comment)"]},"createContentTag":{"description":"","signatures":["org.zendesk.client.v2.model.hc.ContentTag createContentTag(org.zendesk.client.v2.model.hc.ContentTag contentTag)"]},"createDynamicContentItem":{"description":"","signatures":["org.zendesk.client.v2.model.dynamic.DynamicContentItem createDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item)"]},"createDynamicContentItemVariant":{"description":"","signatures":["org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant createDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant)"]},"createForum":{"description":"","signatures":["org.zendesk.client.v2.model.Forum createForum(org.zendesk.client.v2.model.Forum forum)"]},"createGroup":{"description":"","signatures":["org.zendesk.client.v2.model.Group createGroup(org.zendesk.client.v2.model.Group group)"]},"createGroupMembership":{"description":"","signatures":["org.zendesk.client.v2.model.GroupMembership createGroupMembership(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership)","org.zendesk.client.v2.model.GroupMembership createGroupMembership(org.zendesk.client.v2.model.GroupMembership groupMembership)"]},"createMacro":{"description":"","signatures":["org.zendesk.client.v2.model.Macro createMacro(org.zendesk.client.v2.model.Macro macro)"]},"createOrUpdateOrganization":{"description":"","signatures":["org.zendesk.client.v2.model.Organization createOrUpdateOrganization(org.zendesk.client.v2.model.Organization organization)"]},"createOrUpdateUser":{"description":"","signatures":["org.zendesk.client.v2.model.User createOrUpdateUser(org.zendesk.client.v2.model.User user)"]},"createOrUpdateUsers":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus createOrUpdateUsers(java.util.List users)","org.zendesk.client.v2.model.JobStatus createOrUpdateUsers(org.zendesk.client.v2.model.User[] users)"]},"createOrUpdateUsersAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture createOrUpdateUsersAsync(java.util.List users)"]},"createOrganization":{"description":"","signatures":["org.zendesk.client.v2.model.Organization createOrganization(org.zendesk.client.v2.model.Organization organization)"]},"createOrganizationMembership":{"description":"","signatures":["org.zendesk.client.v2.model.OrganizationMembership createOrganizationMembership(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership)","org.zendesk.client.v2.model.OrganizationMembership createOrganizationMembership(org.zendesk.client.v2.model.OrganizationMembership organizationMembership)"]},"createOrganizationMemberships":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus createOrganizationMemberships(java.util.List organizationMemberships)","org.zendesk.client.v2.model.JobStatus createOrganizationMemberships(org.zendesk.client.v2.model.OrganizationMembership[] organizationMemberships)"]},"createOrganizationMembershipsAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture createOrganizationMembershipsAsync(java.util.List organizationMemberships)"]},"createOrganizations":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus createOrganizations(java.util.List organizations)","org.zendesk.client.v2.model.JobStatus createOrganizations(org.zendesk.client.v2.model.Organization[] organizations)"]},"createOrganizationsAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture createOrganizationsAsync(java.util.List organizations)"]},"createPermissionGroup":{"description":"Create permission group","signatures":["org.zendesk.client.v2.model.hc.PermissionGroup createPermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup)"]},"createRequest":{"description":"","signatures":["org.zendesk.client.v2.model.Request createRequest(org.zendesk.client.v2.model.Request request)"]},"createSatisfactionRating":{"description":"","signatures":["org.zendesk.client.v2.model.SatisfactionRating createSatisfactionRating(long ticketId, org.zendesk.client.v2.model.SatisfactionRating satisfactionRating)","org.zendesk.client.v2.model.SatisfactionRating createSatisfactionRating(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.SatisfactionRating satisfactionRating)"]},"createSection":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Section createSection(org.zendesk.client.v2.model.hc.Section section)"]},"createSectionTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation createSectionTranslation(Long sectionId, org.zendesk.client.v2.model.hc.Translation translation)"]},"createTarget":{"description":"","signatures":["org.zendesk.client.v2.model.targets.Target createTarget(org.zendesk.client.v2.model.targets.Target target)"]},"createTicket":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket createTicket(org.zendesk.client.v2.model.Ticket ticket)"]},"createTicketAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture createTicketAsync(org.zendesk.client.v2.model.Ticket ticket)"]},"createTicketField":{"description":"","signatures":["org.zendesk.client.v2.model.Field createTicketField(org.zendesk.client.v2.model.Field field)"]},"createTicketForm":{"description":"","signatures":["org.zendesk.client.v2.model.TicketForm createTicketForm(org.zendesk.client.v2.model.TicketForm ticketForm)"]},"createTicketFromTweet":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket createTicketFromTweet(long tweetId, long monitorId)"]},"createTickets":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus createTickets(java.util.List tickets)","org.zendesk.client.v2.model.JobStatus createTickets(org.zendesk.client.v2.model.Ticket[] tickets)"]},"createTicketsAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture createTicketsAsync(java.util.List tickets)"]},"createTopic":{"description":"","signatures":["org.zendesk.client.v2.model.Topic createTopic(org.zendesk.client.v2.model.Topic topic)"]},"createTrigger":{"description":"","signatures":["org.zendesk.client.v2.model.Trigger createTrigger(org.zendesk.client.v2.model.Trigger trigger)"]},"createUpload":{"description":"","signatures":["org.zendesk.client.v2.model.Attachment$Upload createUpload(String fileName, String contentType, byte[] content)","org.zendesk.client.v2.model.Attachment$Upload createUpload(String fileName, byte[] content)","org.zendesk.client.v2.model.Attachment$Upload createUpload(String token, String fileName, String contentType, byte[] content)"]},"createUploadArticle":{"description":"","signatures":["org.zendesk.client.v2.model.hc.ArticleAttachments createUploadArticle(long articleId, java.io.File file)","org.zendesk.client.v2.model.hc.ArticleAttachments createUploadArticle(long articleId, java.io.File file, boolean inline)"]},"createUser":{"description":"","signatures":["org.zendesk.client.v2.model.User createUser(org.zendesk.client.v2.model.User user)"]},"createUserIdentity":{"description":"","signatures":["org.zendesk.client.v2.model.Identity createUserIdentity(long userId, org.zendesk.client.v2.model.Identity identity)","org.zendesk.client.v2.model.Identity createUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)"]},"createUserSegment":{"description":"Create User Segment","signatures":["org.zendesk.client.v2.model.hc.UserSegment createUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment)"]},"createUsers":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus createUsers(java.util.List users)","org.zendesk.client.v2.model.JobStatus createUsers(org.zendesk.client.v2.model.User[] users)"]},"createUsersAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture createUsersAsync(java.util.List users)"]},"deleteArticle":{"description":"","signatures":["void deleteArticle(org.zendesk.client.v2.model.hc.Article article)"]},"deleteArticleAttachment":{"description":"Delete attachment from article","signatures":["void deleteArticleAttachment(long id)","void deleteArticleAttachment(org.zendesk.client.v2.model.hc.ArticleAttachments attachment)"]},"deleteAttachment":{"description":"","signatures":["void deleteAttachment(long id)","void deleteAttachment(org.zendesk.client.v2.model.Attachment attachment)"]},"deleteAutomation":{"description":"","signatures":["void deleteAutomation(long automationId)"]},"deleteCategory":{"description":"","signatures":["void deleteCategory(org.zendesk.client.v2.model.hc.Category category)"]},"deleteContentTag":{"description":"","signatures":["void deleteContentTag(org.zendesk.client.v2.model.hc.ContentTag contentTag)"]},"deleteDynamicContentItem":{"description":"","signatures":["void deleteDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item)"]},"deleteDynamicContentItemVariant":{"description":"","signatures":["void deleteDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant)"]},"deleteForum":{"description":"","signatures":["void deleteForum(org.zendesk.client.v2.model.Forum forum)"]},"deleteGroup":{"description":"","signatures":["void deleteGroup(long id)","void deleteGroup(org.zendesk.client.v2.model.Group group)"]},"deleteGroupMembership":{"description":"","signatures":["void deleteGroupMembership(long id)","void deleteGroupMembership(long user_id, long group_membership_id)","void deleteGroupMembership(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership)","void deleteGroupMembership(org.zendesk.client.v2.model.GroupMembership groupMembership)"]},"deleteOrganization":{"description":"","signatures":["void deleteOrganization(long id)","void deleteOrganization(org.zendesk.client.v2.model.Organization organization)"]},"deleteOrganizationMembership":{"description":"","signatures":["void deleteOrganizationMembership(long id)","void deleteOrganizationMembership(long user_id, long organization_membership_id)","void deleteOrganizationMembership(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership)"]},"deleteOrganizationMemberships":{"description":"","signatures":["void deleteOrganizationMemberships(long id, long[] ids)"]},"deleteOrganizations":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus deleteOrganizations(long[] ids)"]},"deletePermissionGroup":{"description":"Delete permission group","signatures":["void deletePermissionGroup(long id)","void deletePermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup)"]},"deleteSection":{"description":"","signatures":["void deleteSection(org.zendesk.client.v2.model.hc.Section section)"]},"deleteSuspendedTicket":{"description":"","signatures":["void deleteSuspendedTicket(long id)","void deleteSuspendedTicket(org.zendesk.client.v2.model.SuspendedTicket ticket)"]},"deleteTarget":{"description":"","signatures":["void deleteTarget(long targetId)"]},"deleteTicket":{"description":"","signatures":["void deleteTicket(long id)","void deleteTicket(org.zendesk.client.v2.model.Ticket ticket)"]},"deleteTicketField":{"description":"","signatures":["void deleteTicketField(long id)","void deleteTicketField(org.zendesk.client.v2.model.Field field)"]},"deleteTicketForm":{"description":"","signatures":["void deleteTicketForm(long id)","void deleteTicketForm(org.zendesk.client.v2.model.TicketForm ticketForm)"]},"deleteTickets":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus deleteTickets(long id, long[] ids)"]},"deleteTopic":{"description":"","signatures":["void deleteTopic(org.zendesk.client.v2.model.Topic topic)"]},"deleteTranslation":{"description":"Delete translation","signatures":["void deleteTranslation(Long translationId)","void deleteTranslation(org.zendesk.client.v2.model.hc.Translation translation)"]},"deleteTrigger":{"description":"","signatures":["void deleteTrigger(long triggerId)"]},"deleteUpload":{"description":"","signatures":["void deleteUpload(String token)","void deleteUpload(org.zendesk.client.v2.model.Attachment$Upload upload)"]},"deleteUser":{"description":"","signatures":["void deleteUser(long id)","void deleteUser(org.zendesk.client.v2.model.User user)"]},"deleteUserIdentity":{"description":"","signatures":["void deleteUserIdentity(long userId, long identityId)","void deleteUserIdentity(org.zendesk.client.v2.model.User user, long identityId)","void deleteUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)"]},"deleteUserSegment":{"description":"Delete User Segment","signatures":["void deleteUserSegment(long id)","void deleteUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment)"]},"deleteUsers":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus deleteUsers(long[] ids)"]},"getArticle":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Article getArticle(long id)"]},"getArticleFromSearch":{"description":"","signatures":["Iterable getArticleFromSearch(String searchTerm)","Iterable getArticleFromSearch(String searchTerm, Long sectionId)"]},"getArticleSubscriptions":{"description":"","signatures":["Iterable getArticleSubscriptions(Long articleId)","Iterable getArticleSubscriptions(Long articleId, String locale)"]},"getArticleTranslations":{"description":"","signatures":["Iterable getArticleTranslations(Long articleId)"]},"getArticles":{"description":"Get all articles from help center","signatures":["Iterable getArticles()","Iterable getArticles(String locale)","Iterable getArticles(org.zendesk.client.v2.model.hc.Category category)","Iterable getArticles(org.zendesk.client.v2.model.hc.Category category, String locale)","Iterable getArticles(org.zendesk.client.v2.model.hc.Section section)","Iterable getArticles(org.zendesk.client.v2.model.hc.Section section, String locale)"]},"getArticlesFromAllLabels":{"description":"","signatures":["Iterable getArticlesFromAllLabels(java.util.List labels)"]},"getArticlesFromAnyLabels":{"description":"","signatures":["Iterable getArticlesFromAnyLabels(java.util.List labels)"]},"getArticlesFromPage":{"description":"","signatures":["java.util.List getArticlesFromPage(int page)"]},"getArticlesIncrementally":{"description":"","signatures":["Iterable getArticlesIncrementally(java.util.Date startTime)"]},"getAssignableGroupMemberships":{"description":"","signatures":["Iterable getAssignableGroupMemberships()","Iterable getAssignableGroupMemberships(long group_id)"]},"getAssignedTicketsCountForUser":{"description":"","signatures":["org.zendesk.client.v2.model.TicketCount getAssignedTicketsCountForUser(long id)"]},"getAttachment":{"description":"","signatures":["org.zendesk.client.v2.model.Attachment getAttachment(long id)","org.zendesk.client.v2.model.Attachment getAttachment(org.zendesk.client.v2.model.Attachment attachment)"]},"getAttachmentsFromArticle":{"description":"","signatures":["java.util.List getAttachmentsFromArticle(Long articleID)"]},"getAutoCompleteOrganizations":{"description":"","signatures":["Iterable getAutoCompleteOrganizations(String name)"]},"getAutomation":{"description":"","signatures":["org.zendesk.client.v2.model.Automation getAutomation(long id)"]},"getCategory":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Category getCategory(long id)"]},"getCategoryTranslations":{"description":"","signatures":["Iterable getCategoryTranslations(Long categoryId)"]},"getCcdTicketsCountForUser":{"description":"","signatures":["org.zendesk.client.v2.model.TicketCount getCcdTicketsCountForUser(long id)"]},"getComplianceDeletionStatuses":{"description":"","signatures":["Iterable getComplianceDeletionStatuses(long userId)"]},"getContentTag":{"description":"","signatures":["org.zendesk.client.v2.model.hc.ContentTag getContentTag(String contentTagId)"]},"getContentTags":{"description":"","signatures":["Iterable getContentTags()","Iterable getContentTags(int pageSize)","Iterable getContentTags(int pageSize, String namePrefix)"]},"getDeletedTickets":{"description":"","signatures":["Iterable getDeletedTickets()","Iterable getDeletedTickets(String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder)"]},"getDynamicContentItem":{"description":"","signatures":["org.zendesk.client.v2.model.dynamic.DynamicContentItem getDynamicContentItem(long id)"]},"getDynamicContentItemVariant":{"description":"","signatures":["org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant getDynamicContentItemVariant(Long itemId, long id)"]},"getDynamicContentItemVariants":{"description":"","signatures":["Iterable getDynamicContentItemVariants(org.zendesk.client.v2.model.dynamic.DynamicContentItem item)"]},"getForum":{"description":"","signatures":["org.zendesk.client.v2.model.Forum getForum(long id)"]},"getForums":{"description":"","signatures":["Iterable getForums()","java.util.List getForums(long category_id)"]},"getGroup":{"description":"","signatures":["org.zendesk.client.v2.model.Group getGroup(long id)"]},"getGroupMembership":{"description":"","signatures":["org.zendesk.client.v2.model.GroupMembership getGroupMembership(long id)","org.zendesk.client.v2.model.GroupMembership getGroupMembership(long user_id, long group_membership_id)"]},"getGroupMembershipByUser":{"description":"","signatures":["Iterable getGroupMembershipByUser(long user_id)"]},"getGroupMemberships":{"description":"","signatures":["Iterable getGroupMemberships()","Iterable getGroupMemberships(long group_id)"]},"getGroupOrganization":{"description":"","signatures":["org.zendesk.client.v2.model.OrganizationMembership getGroupOrganization(long user_id, long organization_membership_id)"]},"getGroupUsers":{"description":"","signatures":["Iterable getGroupUsers(long id)"]},"getHolidaysForSchedule":{"description":"","signatures":["Iterable getHolidaysForSchedule(Long scheduleId)","Iterable getHolidaysForSchedule(org.zendesk.client.v2.model.schedules.Schedule schedule)"]},"getIncrementalTicketsResult":{"description":"","signatures":["java.util.Map getIncrementalTicketsResult(long unixEpochTime)"]},"getJobStatus":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus getJobStatus(org.zendesk.client.v2.model.JobStatus status)"]},"getJobStatusAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture getJobStatusAsync(org.zendesk.client.v2.model.JobStatus status)"]},"getJobStatuses":{"description":"","signatures":["java.util.List getJobStatuses(java.util.List statuses)"]},"getJobStatusesAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture> getJobStatusesAsync(java.util.List statuses)"]},"getMacro":{"description":"","signatures":["org.zendesk.client.v2.model.Macro getMacro(long macroId)"]},"getOrganization":{"description":"","signatures":["org.zendesk.client.v2.model.Organization getOrganization(long id)"]},"getOrganizationMembership":{"description":"","signatures":["org.zendesk.client.v2.model.OrganizationMembership getOrganizationMembership(long id)"]},"getOrganizationMembershipByUser":{"description":"","signatures":["Iterable getOrganizationMembershipByUser(long user_id)"]},"getOrganizationMembershipForUser":{"description":"","signatures":["org.zendesk.client.v2.model.OrganizationMembership getOrganizationMembershipForUser(long user_id, long id)"]},"getOrganizationMembershipsForOrg":{"description":"","signatures":["Iterable getOrganizationMembershipsForOrg(long organization_id)"]},"getOrganizationMembershipsForUser":{"description":"","signatures":["Iterable getOrganizationMembershipsForUser(long user_id)"]},"getOrganizationRequests":{"description":"","signatures":["Iterable getOrganizationRequests(long organizationId)"]},"getOrganizationTickets":{"description":"","signatures":["Iterable getOrganizationTickets(long organizationId)"]},"getOrganizationUsers":{"description":"","signatures":["Iterable getOrganizationUsers(long id)"]},"getOrganizations":{"description":"","signatures":["Iterable getOrganizations()","java.util.List getOrganizations(long id, long[] ids)"]},"getOrganizationsIncrementally":{"description":"","signatures":["Iterable getOrganizationsIncrementally(java.util.Date startTime)"]},"getPermissionGroup":{"description":"Get permission group by id","signatures":["org.zendesk.client.v2.model.hc.PermissionGroup getPermissionGroup(long id)"]},"getRequest":{"description":"","signatures":["org.zendesk.client.v2.model.Request getRequest(long id)"]},"getRequestComment":{"description":"","signatures":["org.zendesk.client.v2.model.Comment getRequestComment(long requestId, long commentId)","org.zendesk.client.v2.model.Comment getRequestComment(org.zendesk.client.v2.model.Request request, long commentId)","org.zendesk.client.v2.model.Comment getRequestComment(org.zendesk.client.v2.model.Request request, org.zendesk.client.v2.model.Comment comment)"]},"getRequestComments":{"description":"","signatures":["Iterable getRequestComments(long id)","Iterable getRequestComments(org.zendesk.client.v2.model.Request request)"]},"getSatisfactionRating":{"description":"","signatures":["org.zendesk.client.v2.model.SatisfactionRating getSatisfactionRating(long id)"]},"getSchedule":{"description":"","signatures":["org.zendesk.client.v2.model.schedules.Schedule getSchedule(Long scheduleId)","org.zendesk.client.v2.model.schedules.Schedule getSchedule(org.zendesk.client.v2.model.schedules.Schedule schedule)"]},"getSearchTicketResults":{"description":"Ticket Search API implementation with pagination support","signatures":["java.util.Optional getSearchTicketResults(String query, java.util.Map queryParams, String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder)"]},"getSection":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Section getSection(long id)"]},"getSectionSubscriptions":{"description":"","signatures":["Iterable getSectionSubscriptions(Long sectionId)","Iterable getSectionSubscriptions(Long sectionId, String locale)"]},"getSectionTranslations":{"description":"","signatures":["Iterable getSectionTranslations(Long sectionId)"]},"getSections":{"description":"List Sections using a User Segment","signatures":["Iterable getSections()","Iterable getSections(org.zendesk.client.v2.model.hc.Category category)","Iterable getSections(org.zendesk.client.v2.model.hc.UserSegment userSegment)"]},"getTarget":{"description":"","signatures":["org.zendesk.client.v2.model.targets.Target getTarget(long id)"]},"getTicket":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket getTicket(long id)"]},"getTicketAudit":{"description":"","signatures":["org.zendesk.client.v2.model.Audit getTicketAudit(long ticketId, long auditId)","org.zendesk.client.v2.model.Audit getTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id)","org.zendesk.client.v2.model.Audit getTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit)"]},"getTicketAudits":{"description":"","signatures":["Iterable getTicketAudits(Long id)","Iterable getTicketAudits(org.zendesk.client.v2.model.Ticket ticket)"]},"getTicketCollaborators":{"description":"","signatures":["java.util.List getTicketCollaborators(long id)"]},"getTicketComments":{"description":"","signatures":["Iterable getTicketComments(long id)","Iterable getTicketComments(long id, org.zendesk.client.v2.model.SortOrder order)"]},"getTicketField":{"description":"","signatures":["org.zendesk.client.v2.model.Field getTicketField(long id)"]},"getTicketForm":{"description":"","signatures":["org.zendesk.client.v2.model.TicketForm getTicketForm(long id)"]},"getTicketIncidents":{"description":"","signatures":["Iterable getTicketIncidents(long id)"]},"getTicketMetric":{"description":"","signatures":["org.zendesk.client.v2.model.Metric getTicketMetric(long id)"]},"getTicketMetricByTicket":{"description":"","signatures":["org.zendesk.client.v2.model.Metric getTicketMetricByTicket(long id)"]},"getTickets":{"description":"","signatures":["Iterable getTickets()","java.util.List getTickets(long id, long[] ids)"]},"getTicketsByExternalId":{"description":"","signatures":["Iterable getTicketsByExternalId(String externalId)","Iterable getTicketsByExternalId(String externalId, boolean includeArchived)"]},"getTicketsCountForOrganization":{"description":"","signatures":["org.zendesk.client.v2.model.TicketCount getTicketsCountForOrganization(long id)"]},"getTicketsFromSearch":{"description":"","signatures":["Iterable getTicketsFromSearch(String searchTerm)"]},"getTicketsIncrementally":{"description":"","signatures":["Iterable getTicketsIncrementally(java.util.Date startTime)","Iterable getTicketsIncrementally(java.util.Date startTime, java.util.Date endTime)"]},"getTopic":{"description":"","signatures":["org.zendesk.client.v2.model.Topic getTopic(long id)"]},"getTopics":{"description":"List Topics using a User Segment","signatures":["Iterable getTopics()","Iterable getTopics(org.zendesk.client.v2.model.hc.UserSegment userSegment)","java.util.List getTopics(long forum_id)","java.util.List getTopics(long id, long[] ids)"]},"getTopicsByUser":{"description":"","signatures":["java.util.List getTopicsByUser(long user_id)"]},"getTrigger":{"description":"","signatures":["org.zendesk.client.v2.model.Trigger getTrigger(long id)"]},"getTriggers":{"description":"","signatures":["Iterable getTriggers()","Iterable getTriggers(String categoryId, boolean active, String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder)"]},"getUser":{"description":"","signatures":["org.zendesk.client.v2.model.User getUser(long id)"]},"getUserCCDTickets":{"description":"","signatures":["Iterable getUserCCDTickets(long userId)"]},"getUserIdentities":{"description":"","signatures":["java.util.List getUserIdentities(long userId)","java.util.List getUserIdentities(org.zendesk.client.v2.model.User user)"]},"getUserIdentity":{"description":"","signatures":["org.zendesk.client.v2.model.Identity getUserIdentity(long userId, long identityId)","org.zendesk.client.v2.model.Identity getUserIdentity(org.zendesk.client.v2.model.User user, long identityId)","org.zendesk.client.v2.model.Identity getUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)"]},"getUserRelatedInfo":{"description":"","signatures":["org.zendesk.client.v2.model.UserRelatedInfo getUserRelatedInfo(long userId)"]},"getUserRequestedTickets":{"description":"","signatures":["Iterable getUserRequestedTickets(long userId)"]},"getUserRequests":{"description":"","signatures":["Iterable getUserRequests(long id)","Iterable getUserRequests(org.zendesk.client.v2.model.User user)"]},"getUserSegment":{"description":"Get user segment by id","signatures":["org.zendesk.client.v2.model.hc.UserSegment getUserSegment(long id)"]},"getUserSegments":{"description":"Returns the list of user segments that a particular user belongs to","signatures":["Iterable getUserSegments()","Iterable getUserSegments(long id)"]},"getUserSubscriptions":{"description":"","signatures":["Iterable getUserSubscriptions(Long userId)","Iterable getUserSubscriptions(org.zendesk.client.v2.model.User user)"]},"getUsers":{"description":"","signatures":["Iterable getUsers()","java.util.List getUsers(long id, long[] ids)"]},"getUsersByExternalIds":{"description":"","signatures":["java.util.List getUsersByExternalIds(String externalId, String[] externalIds)","java.util.List getUsersByExternalIds(long externalId, long[] externalIds)"]},"getUsersByRole":{"description":"","signatures":["Iterable getUsersByRole(String role, String[] roles)"]},"getUsersIncrementally":{"description":"","signatures":["Iterable getUsersIncrementally(java.util.Date startTime)"]},"getView":{"description":"","signatures":["Iterable getView(long id)"]},"importTicket":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket importTicket(org.zendesk.client.v2.model.TicketImport ticketImport)"]},"importTopic":{"description":"","signatures":["org.zendesk.client.v2.model.Topic importTopic(org.zendesk.client.v2.model.Topic topic)"]},"lookupOrganizationsByExternalId":{"description":"","signatures":["Iterable lookupOrganizationsByExternalId(String externalId)"]},"lookupUserByEmail":{"description":"","signatures":["Iterable lookupUserByEmail(String email)"]},"lookupUserByExternalId":{"description":"","signatures":["Iterable lookupUserByExternalId(String externalId)"]},"macrosShowChangesToTicket":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket macrosShowChangesToTicket(long macroId)"]},"macrosShowTicketAfterChanges":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket macrosShowTicketAfterChanges(long ticketId, long macroId)"]},"makePrivateTicketAudit":{"description":"","signatures":["void makePrivateTicketAudit(long ticketId, long auditId)","void makePrivateTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id)","void makePrivateTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit)"]},"markTicketAsSpam":{"description":"","signatures":["void markTicketAsSpam(long id)","void markTicketAsSpam(org.zendesk.client.v2.model.Ticket ticket)"]},"mergeUsers":{"description":"","signatures":["org.zendesk.client.v2.model.User mergeUsers(long userIdThatWillRemain, long userIdThatWillBeMerged)"]},"notifyApp":{"description":"","signatures":["void notifyApp(String json)"]},"permanentlyDeleteTicket":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus permanentlyDeleteTicket(long id)","org.zendesk.client.v2.model.JobStatus permanentlyDeleteTicket(org.zendesk.client.v2.model.Ticket ticket)"]},"permanentlyDeleteTickets":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus permanentlyDeleteTickets(long id, long[] ids)"]},"permanentlyDeleteUser":{"description":"","signatures":["org.zendesk.client.v2.model.User permanentlyDeleteUser(long id)","org.zendesk.client.v2.model.User permanentlyDeleteUser(org.zendesk.client.v2.model.User user)"]},"queueCreateTicketAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture queueCreateTicketAsync(org.zendesk.client.v2.model.Ticket ticket)"]},"removeTagFromOrganisations":{"description":"","signatures":["java.util.List removeTagFromOrganisations(long id, String[] tags)"]},"removeTagFromTicket":{"description":"","signatures":["java.util.List removeTagFromTicket(long id, String[] tags)"]},"removeTagFromTopics":{"description":"","signatures":["java.util.List removeTagFromTopics(long id, String[] tags)"]},"requestVerifyUserIdentity":{"description":"","signatures":["org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(long userId, long identityId)","org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(org.zendesk.client.v2.model.User user, long identityId)","org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)"]},"resetUserPassword":{"description":"","signatures":["void resetUserPassword(long id, String password)","void resetUserPassword(org.zendesk.client.v2.model.User user, String password)"]},"searchTriggers":{"description":"","signatures":["Iterable searchTriggers(String query)","Iterable searchTriggers(String query, boolean active, String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder)"]},"setGroupMembershipAsDefault":{"description":"","signatures":["java.util.List setGroupMembershipAsDefault(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership)"]},"setOrganizationMembershipAsDefault":{"description":"","signatures":["java.util.List setOrganizationMembershipAsDefault(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership)"]},"setTagOnOrganisations":{"description":"","signatures":["java.util.List setTagOnOrganisations(long id, String[] tags)"]},"setTagOnTicket":{"description":"","signatures":["java.util.List setTagOnTicket(long id, String[] tags)"]},"setTagOnTopics":{"description":"","signatures":["java.util.List setTagOnTopics(long id, String[] tags)"]},"setUserPrimaryIdentity":{"description":"","signatures":["java.util.List setUserPrimaryIdentity(long userId, long identityId)","java.util.List setUserPrimaryIdentity(org.zendesk.client.v2.model.User user, long identityId)","java.util.List setUserPrimaryIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)"]},"showArticleTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation showArticleTranslation(long articleId, String locale)"]},"showCategoryTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation showCategoryTranslation(long categoryId, String locale)"]},"showSectionTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation showSectionTranslation(long sectionId, String locale)"]},"suspendUser":{"description":"","signatures":["org.zendesk.client.v2.model.User suspendUser(long id)"]},"trustTicketAudit":{"description":"","signatures":["void trustTicketAudit(long ticketId, long auditId)","void trustTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id)","void trustTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit)"]},"unsuspendUser":{"description":"","signatures":["org.zendesk.client.v2.model.User unsuspendUser(long id)"]},"updateArticle":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Article updateArticle(org.zendesk.client.v2.model.hc.Article article)"]},"updateArticleTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation updateArticleTranslation(Long articleId, String locale, org.zendesk.client.v2.model.hc.Translation translation)"]},"updateAutomation":{"description":"","signatures":["org.zendesk.client.v2.model.Automation updateAutomation(Long automationId, org.zendesk.client.v2.model.Automation automation)"]},"updateCategory":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Category updateCategory(org.zendesk.client.v2.model.hc.Category category)"]},"updateCategoryTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation updateCategoryTranslation(Long categoryId, String locale, org.zendesk.client.v2.model.hc.Translation translation)"]},"updateContentTag":{"description":"","signatures":["org.zendesk.client.v2.model.hc.ContentTag updateContentTag(org.zendesk.client.v2.model.hc.ContentTag contentTag)"]},"updateDynamicContentItem":{"description":"","signatures":["org.zendesk.client.v2.model.dynamic.DynamicContentItem updateDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item)"]},"updateDynamicContentItemVariant":{"description":"","signatures":["org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant updateDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant)"]},"updateForum":{"description":"","signatures":["org.zendesk.client.v2.model.Forum updateForum(org.zendesk.client.v2.model.Forum forum)"]},"updateGroup":{"description":"","signatures":["org.zendesk.client.v2.model.Group updateGroup(org.zendesk.client.v2.model.Group group)"]},"updateInstallation":{"description":"","signatures":["void updateInstallation(int id, String json)"]},"updateMacro":{"description":"","signatures":["org.zendesk.client.v2.model.Macro updateMacro(Long macroId, org.zendesk.client.v2.model.Macro macro)"]},"updateOrganization":{"description":"","signatures":["org.zendesk.client.v2.model.Organization updateOrganization(org.zendesk.client.v2.model.Organization organization)"]},"updateOrganizations":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus updateOrganizations(java.util.List organizations)","org.zendesk.client.v2.model.JobStatus updateOrganizations(org.zendesk.client.v2.model.Organization[] organizations)"]},"updateOrganizationsAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture updateOrganizationsAsync(java.util.List organizations)"]},"updatePermissionGroup":{"description":"Update permission group","signatures":["org.zendesk.client.v2.model.hc.PermissionGroup updatePermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup)"]},"updateRequest":{"description":"","signatures":["org.zendesk.client.v2.model.Request updateRequest(org.zendesk.client.v2.model.Request request)"]},"updateSection":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Section updateSection(org.zendesk.client.v2.model.hc.Section section)"]},"updateSectionTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation updateSectionTranslation(Long sectionId, String locale, org.zendesk.client.v2.model.hc.Translation translation)"]},"updateTicket":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket updateTicket(org.zendesk.client.v2.model.Ticket ticket)"]},"updateTicketField":{"description":"","signatures":["org.zendesk.client.v2.model.Field updateTicketField(org.zendesk.client.v2.model.Field field)"]},"updateTicketForm":{"description":"","signatures":["org.zendesk.client.v2.model.TicketForm updateTicketForm(org.zendesk.client.v2.model.TicketForm ticketForm)"]},"updateTickets":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus updateTickets(java.util.List tickets)","org.zendesk.client.v2.model.JobStatus updateTickets(org.zendesk.client.v2.model.Ticket[] tickets)"]},"updateTicketsAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture updateTicketsAsync(java.util.List tickets)"]},"updateTopic":{"description":"","signatures":["org.zendesk.client.v2.model.Topic updateTopic(org.zendesk.client.v2.model.Topic topic)"]},"updateTrigger":{"description":"","signatures":["org.zendesk.client.v2.model.Trigger updateTrigger(Long triggerId, org.zendesk.client.v2.model.Trigger trigger)"]},"updateUser":{"description":"","signatures":["org.zendesk.client.v2.model.User updateUser(org.zendesk.client.v2.model.User user)"]},"updateUserIdentity":{"description":"","signatures":["org.zendesk.client.v2.model.Identity updateUserIdentity(long userId, org.zendesk.client.v2.model.Identity identity)","org.zendesk.client.v2.model.Identity updateUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)"]},"updateUserSegment":{"description":"Update User Segment","signatures":["org.zendesk.client.v2.model.hc.UserSegment updateUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment)"]},"updateUsers":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus updateUsers(java.util.List users)","org.zendesk.client.v2.model.JobStatus updateUsers(org.zendesk.client.v2.model.User[] users)"]},"updateUsersAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture updateUsersAsync(java.util.List users)"]},"verifyUserIdentity":{"description":"","signatures":["org.zendesk.client.v2.model.Identity verifyUserIdentity(long userId, long identityId)","org.zendesk.client.v2.model.Identity verifyUserIdentity(org.zendesk.client.v2.model.User user, long identityId)","org.zendesk.client.v2.model.Identity verifyUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)"]}}}},"apiProperties":{"DEFAULT":{"methods":{"addTagToOrganisations":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"addTagToTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"addTagToTopics":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"associateAttachmentsToArticle":{"properties":{"attachments":{"index":0,"kind":"parameter","displayName":"Attachments","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"idArticle":{"index":1,"kind":"parameter","displayName":"Id Article","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"changeUserPassword":{"properties":{"newPassword":{"index":0,"kind":"parameter","displayName":"New Password","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"oldPassword":{"index":1,"kind":"parameter","displayName":"Old Password","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createArticle":{"properties":{"article":{"index":0,"kind":"parameter","displayName":"Article","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Article","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"notifySubscribers":{"index":1,"kind":"parameter","displayName":"Notify Subscribers","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createArticleTranslation":{"properties":{"articleId":{"index":0,"kind":"parameter","displayName":"Article Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"translation":{"index":1,"kind":"parameter","displayName":"Translation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Translation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createAutomation":{"properties":{"automation":{"index":0,"kind":"parameter","displayName":"Automation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Automation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createCategory":{"properties":{"category":{"index":0,"kind":"parameter","displayName":"Category","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Category","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createCategoryTranslation":{"properties":{"categoryId":{"index":0,"kind":"parameter","displayName":"Category Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"translation":{"index":1,"kind":"parameter","displayName":"Translation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Translation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createComment":{"properties":{"comment":{"index":0,"kind":"parameter","displayName":"Comment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Comment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketId":{"index":1,"kind":"parameter","displayName":"Ticket Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createContentTag":{"properties":{"contentTag":{"index":0,"kind":"parameter","displayName":"Content Tag","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.ContentTag","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createDynamicContentItem":{"properties":{"item":{"index":0,"kind":"parameter","displayName":"Item","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.dynamic.DynamicContentItem","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createDynamicContentItemVariant":{"properties":{"itemId":{"index":0,"kind":"parameter","displayName":"Item Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"variant":{"index":1,"kind":"parameter","displayName":"Variant","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createForum":{"properties":{"forum":{"index":0,"kind":"parameter","displayName":"Forum","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Forum","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createGroup":{"properties":{"group":{"index":0,"kind":"parameter","displayName":"Group","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Group","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createGroupMembership":{"properties":{"groupMembership":{"index":0,"kind":"parameter","displayName":"Group Membership","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.GroupMembership","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":1,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createMacro":{"properties":{"macro":{"index":0,"kind":"parameter","displayName":"Macro","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Macro","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrUpdateOrganization":{"properties":{"organization":{"index":0,"kind":"parameter","displayName":"Organization","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Organization","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrUpdateUser":{"properties":{"user":{"index":0,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrUpdateUsers":{"properties":{"users":{"index":0,"kind":"parameter","displayName":"Users","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"usersList":{"index":1,"kind":"parameter","displayName":"Users List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrUpdateUsersAsync":{"properties":{"usersList":{"index":0,"kind":"parameter","displayName":"Users List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrganization":{"properties":{"organization":{"index":0,"kind":"parameter","displayName":"Organization","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Organization","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrganizationMembership":{"properties":{"organizationMembership":{"index":0,"kind":"parameter","displayName":"Organization Membership","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.OrganizationMembership","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":1,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrganizationMemberships":{"properties":{"organizationMembershipList":{"index":0,"kind":"parameter","displayName":"Organization Membership List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"organizationMemberships":{"index":1,"kind":"parameter","displayName":"Organization Memberships","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.OrganizationMembership[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrganizationMembershipsAsync":{"properties":{"organizationMembershipList":{"index":0,"kind":"parameter","displayName":"Organization Membership List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrganizations":{"properties":{"organizationList":{"index":0,"kind":"parameter","displayName":"Organization List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"organizations":{"index":1,"kind":"parameter","displayName":"Organizations","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Organization[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrganizationsAsync":{"properties":{"organizationList":{"index":0,"kind":"parameter","displayName":"Organization List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createPermissionGroup":{"properties":{"permissionGroup":{"index":0,"kind":"parameter","displayName":"Permission Group","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.PermissionGroup","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createRequest":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Request","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createSatisfactionRating":{"properties":{"satisfactionRating":{"index":0,"kind":"parameter","displayName":"Satisfaction Rating","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.SatisfactionRating","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticket":{"index":1,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketId":{"index":2,"kind":"parameter","displayName":"Ticket Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createSection":{"properties":{"section":{"index":0,"kind":"parameter","displayName":"Section","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Section","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createSectionTranslation":{"properties":{"sectionId":{"index":0,"kind":"parameter","displayName":"Section Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"translation":{"index":1,"kind":"parameter","displayName":"Translation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Translation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTarget":{"properties":{"target":{"index":0,"kind":"parameter","displayName":"Target","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.targets.Target","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTicket":{"properties":{"ticket":{"index":0,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTicketAsync":{"properties":{"ticket":{"index":0,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTicketField":{"properties":{"field":{"index":0,"kind":"parameter","displayName":"Field","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Field","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTicketForm":{"properties":{"ticketForm":{"index":0,"kind":"parameter","displayName":"Ticket Form","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.TicketForm","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTicketFromTweet":{"properties":{"monitorId":{"index":0,"kind":"parameter","displayName":"Monitor Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tweetId":{"index":1,"kind":"parameter","displayName":"Tweet Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTickets":{"properties":{"ticketList":{"index":0,"kind":"parameter","displayName":"Ticket List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tickets":{"index":1,"kind":"parameter","displayName":"Tickets","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTicketsAsync":{"properties":{"ticketList":{"index":0,"kind":"parameter","displayName":"Ticket List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTopic":{"properties":{"topic":{"index":0,"kind":"parameter","displayName":"Topic","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Topic","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTrigger":{"properties":{"trigger":{"index":0,"kind":"parameter","displayName":"Trigger","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Trigger","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createUpload":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"string","javaType":"byte[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"contentType":{"index":1,"kind":"parameter","displayName":"Content Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"fileName":{"index":2,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"token":{"index":3,"kind":"parameter","displayName":"Token","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createUploadArticle":{"properties":{"articleId0":{"index":0,"kind":"parameter","displayName":"Article Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"file":{"index":1,"kind":"parameter","displayName":"File","group":"common","label":"","required":false,"type":"string","javaType":"java.io.File","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"inline":{"index":2,"kind":"parameter","displayName":"Inline","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createUser":{"properties":{"user":{"index":0,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createUserIdentity":{"properties":{"identity":{"index":0,"kind":"parameter","displayName":"Identity","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Identity","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":1,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createUserSegment":{"properties":{"userSegment":{"index":0,"kind":"parameter","displayName":"User Segment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.UserSegment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createUsers":{"properties":{"userList":{"index":0,"kind":"parameter","displayName":"User List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"users":{"index":1,"kind":"parameter","displayName":"Users","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createUsersAsync":{"properties":{"userList":{"index":0,"kind":"parameter","displayName":"User List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteArticle":{"properties":{"article":{"index":0,"kind":"parameter","displayName":"Article","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Article","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteArticleAttachment":{"properties":{"articleAttachments":{"index":0,"kind":"parameter","displayName":"Article Attachments","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.ArticleAttachments","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Attachment identifier","optional":false}}},"deleteAttachment":{"properties":{"attachment":{"index":0,"kind":"parameter","displayName":"Attachment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Attachment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteAutomation":{"properties":{"automationId0":{"index":0,"kind":"parameter","displayName":"Automation Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteCategory":{"properties":{"category":{"index":0,"kind":"parameter","displayName":"Category","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Category","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteContentTag":{"properties":{"contentTag":{"index":0,"kind":"parameter","displayName":"Content Tag","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.ContentTag","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteDynamicContentItem":{"properties":{"item":{"index":0,"kind":"parameter","displayName":"Item","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.dynamic.DynamicContentItem","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteDynamicContentItemVariant":{"properties":{"itemId":{"index":0,"kind":"parameter","displayName":"Item Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"variant":{"index":1,"kind":"parameter","displayName":"Variant","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteForum":{"properties":{"forum":{"index":0,"kind":"parameter","displayName":"Forum","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Forum","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteGroup":{"properties":{"group":{"index":0,"kind":"parameter","displayName":"Group","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Group","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteGroupMembership":{"properties":{"groupMembership":{"index":0,"kind":"parameter","displayName":"Group Membership","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.GroupMembership","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"group_membership_id":{"index":1,"kind":"parameter","displayName":"Group_membership_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":2,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":3,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteOrganization":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"organization":{"index":1,"kind":"parameter","displayName":"Organization","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Organization","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteOrganizationMembership":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"organizationMembership":{"index":1,"kind":"parameter","displayName":"Organization Membership","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.OrganizationMembership","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"organization_membership_id":{"index":2,"kind":"parameter","displayName":"Organization_membership_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":3,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteOrganizationMemberships":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ids":{"index":1,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteOrganizations":{"properties":{"ids":{"index":0,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deletePermissionGroup":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"permissionGroup":{"index":1,"kind":"parameter","displayName":"Permission Group","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.PermissionGroup","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteSection":{"properties":{"section":{"index":0,"kind":"parameter","displayName":"Section","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Section","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteSuspendedTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"suspendedTicket":{"index":1,"kind":"parameter","displayName":"Suspended Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.SuspendedTicket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTarget":{"properties":{"targetId":{"index":0,"kind":"parameter","displayName":"Target Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticket":{"index":1,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTicketField":{"properties":{"field":{"index":0,"kind":"parameter","displayName":"Field","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Field","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTicketForm":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketForm":{"index":1,"kind":"parameter","displayName":"Ticket Form","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.TicketForm","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTickets":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ids":{"index":1,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTopic":{"properties":{"topic":{"index":0,"kind":"parameter","displayName":"Topic","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Topic","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTranslation":{"properties":{"translation":{"index":0,"kind":"parameter","displayName":"Translation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Translation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"translationId":{"index":1,"kind":"parameter","displayName":"Translation Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTrigger":{"properties":{"triggerId":{"index":0,"kind":"parameter","displayName":"Trigger Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteUpload":{"properties":{"token":{"index":0,"kind":"parameter","displayName":"Token","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"upload":{"index":1,"kind":"parameter","displayName":"Upload","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Attachment.Upload","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":1,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteUserIdentity":{"properties":{"identity":{"index":0,"kind":"parameter","displayName":"Identity","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Identity","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"identityId":{"index":1,"kind":"parameter","displayName":"Identity Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":3,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteUserSegment":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userSegment":{"index":1,"kind":"parameter","displayName":"User Segment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.UserSegment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteUsers":{"properties":{"ids":{"index":0,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticle":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticleFromSearch":{"properties":{"searchTerm":{"index":0,"kind":"parameter","displayName":"Search Term","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sectionId":{"index":1,"kind":"parameter","displayName":"Section Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticleSubscriptions":{"properties":{"articleId":{"index":0,"kind":"parameter","displayName":"Article Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"locale":{"index":1,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticleTranslations":{"properties":{"articleId":{"index":0,"kind":"parameter","displayName":"Article Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticles":{"properties":{"category":{"index":0,"kind":"parameter","displayName":"Category","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Category","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"locale":{"index":1,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"section":{"index":2,"kind":"parameter","displayName":"Section","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Section","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticlesFromAllLabels":{"properties":{"labels":{"index":0,"kind":"parameter","displayName":"Labels","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticlesFromAnyLabels":{"properties":{"labels":{"index":0,"kind":"parameter","displayName":"Labels","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticlesFromPage":{"properties":{"page":{"index":0,"kind":"parameter","displayName":"Page","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticlesIncrementally":{"properties":{"startTime":{"index":0,"kind":"parameter","displayName":"Start Time","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getAssignableGroupMemberships":{"properties":{"group_id":{"index":0,"kind":"parameter","displayName":"Group_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getAssignedTicketsCountForUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getAttachment":{"properties":{"attachment":{"index":0,"kind":"parameter","displayName":"Attachment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Attachment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getAttachmentsFromArticle":{"properties":{"articleId":{"index":0,"kind":"parameter","displayName":"Article Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getAutoCompleteOrganizations":{"properties":{"name":{"index":0,"kind":"parameter","displayName":"Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getAutomation":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getCategory":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getCategoryTranslations":{"properties":{"categoryId":{"index":0,"kind":"parameter","displayName":"Category Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getCcdTicketsCountForUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getComplianceDeletionStatuses":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getContentTag":{"properties":{"contentTagId":{"index":0,"kind":"parameter","displayName":"Content Tag Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getContentTags":{"properties":{"namePrefix":{"index":0,"kind":"parameter","displayName":"Name Prefix","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pageSize":{"index":1,"kind":"parameter","displayName":"Page Size","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getDeletedTickets":{"properties":{"sortBy":{"index":0,"kind":"parameter","displayName":"Sort By","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sortOrder":{"index":1,"kind":"parameter","displayName":"Sort Order","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.SortOrder","enum":["ASCENDING","DESCENDING"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getDynamicContentItem":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getDynamicContentItemVariant":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"itemId":{"index":1,"kind":"parameter","displayName":"Item Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getDynamicContentItemVariants":{"properties":{"item":{"index":0,"kind":"parameter","displayName":"Item","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.dynamic.DynamicContentItem","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getForum":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getForums":{"properties":{"category_id":{"index":0,"kind":"parameter","displayName":"Category_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getGroup":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getGroupMembership":{"properties":{"group_membership_id":{"index":0,"kind":"parameter","displayName":"Group_membership_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":2,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getGroupMembershipByUser":{"properties":{"user_id":{"index":0,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getGroupMemberships":{"properties":{"group_id":{"index":0,"kind":"parameter","displayName":"Group_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getGroupOrganization":{"properties":{"organization_membership_id":{"index":0,"kind":"parameter","displayName":"Organization_membership_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":1,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getGroupUsers":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getHolidaysForSchedule":{"properties":{"schedule":{"index":0,"kind":"parameter","displayName":"Schedule","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.schedules.Schedule","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"scheduleId":{"index":1,"kind":"parameter","displayName":"Schedule Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getIncrementalTicketsResult":{"properties":{"unixEpochTime":{"index":0,"kind":"parameter","displayName":"Unix Epoch Time","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getJobStatus":{"properties":{"status":{"index":0,"kind":"parameter","displayName":"Status","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.JobStatus","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getJobStatusAsync":{"properties":{"status":{"index":0,"kind":"parameter","displayName":"Status","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.JobStatus","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getJobStatuses":{"properties":{"statuses":{"index":0,"kind":"parameter","displayName":"Statuses","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getJobStatusesAsync":{"properties":{"statuses":{"index":0,"kind":"parameter","displayName":"Statuses","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getMacro":{"properties":{"macroId":{"index":0,"kind":"parameter","displayName":"Macro Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganization":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationMembership":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationMembershipByUser":{"properties":{"user_id":{"index":0,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationMembershipForUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":1,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationMembershipsForOrg":{"properties":{"organization_id":{"index":0,"kind":"parameter","displayName":"Organization_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationMembershipsForUser":{"properties":{"user_id":{"index":0,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationRequests":{"properties":{"organizationId":{"index":0,"kind":"parameter","displayName":"Organization Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationTickets":{"properties":{"organizationId":{"index":0,"kind":"parameter","displayName":"Organization Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationUsers":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizations":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ids":{"index":1,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationsIncrementally":{"properties":{"startTime":{"index":0,"kind":"parameter","displayName":"Start Time","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getPermissionGroup":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getRequest":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getRequestComment":{"properties":{"comment":{"index":0,"kind":"parameter","displayName":"Comment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Comment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"commentId":{"index":1,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"request":{"index":2,"kind":"parameter","displayName":"Request","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Request","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"requestId":{"index":3,"kind":"parameter","displayName":"Request Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getRequestComments":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Request","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getSatisfactionRating":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getSchedule":{"properties":{"schedule":{"index":0,"kind":"parameter","displayName":"Schedule","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.schedules.Schedule","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"scheduleId":{"index":1,"kind":"parameter","displayName":"Schedule Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getSearchTicketResults":{"properties":{"query":{"index":0,"kind":"parameter","displayName":"Query","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"String used filter a type given by searchType","optional":false},"queryParams":{"index":1,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"Additional parameters other than filter string like per_page, page etc","optional":false},"sortBy":{"index":2,"kind":"parameter","displayName":"Sort By","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Name of any field of the searchType","optional":false},"sortOrder":{"index":3,"kind":"parameter","displayName":"Sort Order","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.SortOrder","enum":["ASCENDING","DESCENDING"],"deprecated":false,"autowired":false,"secret":false,"description":"Sort order","optional":false}}},"getSection":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getSectionSubscriptions":{"properties":{"locale":{"index":0,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sectionId":{"index":1,"kind":"parameter","displayName":"Section Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getSectionTranslations":{"properties":{"sectionId":{"index":0,"kind":"parameter","displayName":"Section Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getSections":{"properties":{"category":{"index":0,"kind":"parameter","displayName":"Category","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Category","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userSegment":{"index":1,"kind":"parameter","displayName":"User Segment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.UserSegment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTarget":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketAudit":{"properties":{"audit":{"index":0,"kind":"parameter","displayName":"Audit","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Audit","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"auditId":{"index":1,"kind":"parameter","displayName":"Audit Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":2,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticket":{"index":3,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketId":{"index":4,"kind":"parameter","displayName":"Ticket Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketAudits":{"properties":{"ticket":{"index":0,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketId0":{"index":1,"kind":"parameter","displayName":"Ticket Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketCollaborators":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketComments":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"order":{"index":1,"kind":"parameter","displayName":"Order","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.SortOrder","enum":["ASCENDING","DESCENDING"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketField":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketForm":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketIncidents":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketMetric":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketMetricByTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTickets":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ids":{"index":1,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketsByExternalId":{"properties":{"externalId":{"index":0,"kind":"parameter","displayName":"External Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"includeArchived":{"index":1,"kind":"parameter","displayName":"Include Archived","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketsCountForOrganization":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketsFromSearch":{"properties":{"searchTerm":{"index":0,"kind":"parameter","displayName":"Search Term","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketsIncrementally":{"properties":{"endTime":{"index":0,"kind":"parameter","displayName":"End Time","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"startTime":{"index":1,"kind":"parameter","displayName":"Start Time","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTopic":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTopics":{"properties":{"forum_id":{"index":0,"kind":"parameter","displayName":"Forum_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ids":{"index":2,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userSegment":{"index":3,"kind":"parameter","displayName":"User Segment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.UserSegment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTopicsByUser":{"properties":{"user_id":{"index":0,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTrigger":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTriggers":{"properties":{"active":{"index":0,"kind":"parameter","displayName":"Active","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"categoryId0":{"index":1,"kind":"parameter","displayName":"Category Id0","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sortBy":{"index":2,"kind":"parameter","displayName":"Sort By","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sortOrder":{"index":3,"kind":"parameter","displayName":"Sort Order","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.SortOrder","enum":["ASCENDING","DESCENDING"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserCCDTickets":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserIdentities":{"properties":{"user":{"index":0,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserIdentity":{"properties":{"identity":{"index":0,"kind":"parameter","displayName":"Identity","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Identity","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"identityId":{"index":1,"kind":"parameter","displayName":"Identity Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":3,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserRelatedInfo":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserRequestedTickets":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserRequests":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":1,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserSegment":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserSegments":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserSubscriptions":{"properties":{"user":{"index":0,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId0":{"index":1,"kind":"parameter","displayName":"User Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUsers":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ids":{"index":1,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUsersByExternalIds":{"properties":{"externalId":{"index":0,"kind":"parameter","displayName":"External Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"externalId0":{"index":1,"kind":"parameter","displayName":"External Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"externalId0s":{"index":2,"kind":"parameter","displayName":"External Id0s","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"externalIds":{"index":3,"kind":"parameter","displayName":"External Ids","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUsersByRole":{"properties":{"role":{"index":0,"kind":"parameter","displayName":"Role","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"roles":{"index":1,"kind":"parameter","displayName":"Roles","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUsersIncrementally":{"properties":{"startTime":{"index":0,"kind":"parameter","displayName":"Start Time","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getView":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"importTicket":{"properties":{"ticketImport":{"index":0,"kind":"parameter","displayName":"Ticket Import","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.TicketImport","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"importTopic":{"properties":{"topic":{"index":0,"kind":"parameter","displayName":"Topic","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Topic","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"lookupOrganizationsByExternalId":{"properties":{"externalId":{"index":0,"kind":"parameter","displayName":"External Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"lookupUserByEmail":{"properties":{"email":{"index":0,"kind":"parameter","displayName":"Email","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"lookupUserByExternalId":{"properties":{"externalId":{"index":0,"kind":"parameter","displayName":"External Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"macrosShowChangesToTicket":{"properties":{"macroId":{"index":0,"kind":"parameter","displayName":"Macro Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"macrosShowTicketAfterChanges":{"properties":{"macroId":{"index":0,"kind":"parameter","displayName":"Macro Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketId":{"index":1,"kind":"parameter","displayName":"Ticket Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"makePrivateTicketAudit":{"properties":{"audit":{"index":0,"kind":"parameter","displayName":"Audit","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Audit","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"auditId":{"index":1,"kind":"parameter","displayName":"Audit Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":2,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticket":{"index":3,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketId":{"index":4,"kind":"parameter","displayName":"Ticket Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"markTicketAsSpam":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticket":{"index":1,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"mergeUsers":{"properties":{"userIdThatWillBeMerged":{"index":0,"kind":"parameter","displayName":"User Id That Will Be Merged","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userIdThatWillRemain":{"index":1,"kind":"parameter","displayName":"User Id That Will Remain","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"notifyApp":{"properties":{"json":{"index":0,"kind":"parameter","displayName":"Json","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"permanentlyDeleteTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticket":{"index":1,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"permanentlyDeleteTickets":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ids":{"index":1,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"permanentlyDeleteUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":1,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"queueCreateTicketAsync":{"properties":{"ticket":{"index":0,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"removeTagFromOrganisations":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"removeTagFromTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"removeTagFromTopics":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"requestVerifyUserIdentity":{"properties":{"identity":{"index":0,"kind":"parameter","displayName":"Identity","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Identity","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"identityId":{"index":1,"kind":"parameter","displayName":"Identity Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":3,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"resetUserPassword":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"password":{"index":1,"kind":"parameter","displayName":"Password","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"searchTriggers":{"properties":{"active":{"index":0,"kind":"parameter","displayName":"Active","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"query":{"index":1,"kind":"parameter","displayName":"Query","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sortBy":{"index":2,"kind":"parameter","displayName":"Sort By","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sortOrder":{"index":3,"kind":"parameter","displayName":"Sort Order","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.SortOrder","enum":["ASCENDING","DESCENDING"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"setGroupMembershipAsDefault":{"properties":{"groupMembership":{"index":0,"kind":"parameter","displayName":"Group Membership","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.GroupMembership","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":1,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"setOrganizationMembershipAsDefault":{"properties":{"organizationMembership":{"index":0,"kind":"parameter","displayName":"Organization Membership","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.OrganizationMembership","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":1,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"setTagOnOrganisations":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"setTagOnTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"setTagOnTopics":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"setUserPrimaryIdentity":{"properties":{"identity":{"index":0,"kind":"parameter","displayName":"Identity","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Identity","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"identityId":{"index":1,"kind":"parameter","displayName":"Identity Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":3,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"showArticleTranslation":{"properties":{"articleId0":{"index":0,"kind":"parameter","displayName":"Article Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"locale":{"index":1,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"showCategoryTranslation":{"properties":{"categoryId1":{"index":0,"kind":"parameter","displayName":"Category Id1","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"locale":{"index":1,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"showSectionTranslation":{"properties":{"locale":{"index":0,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sectionId0":{"index":1,"kind":"parameter","displayName":"Section Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"suspendUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"trustTicketAudit":{"properties":{"audit":{"index":0,"kind":"parameter","displayName":"Audit","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Audit","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"auditId":{"index":1,"kind":"parameter","displayName":"Audit Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":2,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticket":{"index":3,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketId":{"index":4,"kind":"parameter","displayName":"Ticket Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"unsuspendUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateArticle":{"properties":{"article":{"index":0,"kind":"parameter","displayName":"Article","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Article","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateArticleTranslation":{"properties":{"articleId":{"index":0,"kind":"parameter","displayName":"Article Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"locale":{"index":1,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"translation":{"index":2,"kind":"parameter","displayName":"Translation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Translation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateAutomation":{"properties":{"automation":{"index":0,"kind":"parameter","displayName":"Automation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Automation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"automationId":{"index":1,"kind":"parameter","displayName":"Automation Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateCategory":{"properties":{"category":{"index":0,"kind":"parameter","displayName":"Category","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Category","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateCategoryTranslation":{"properties":{"categoryId":{"index":0,"kind":"parameter","displayName":"Category Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"locale":{"index":1,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"translation":{"index":2,"kind":"parameter","displayName":"Translation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Translation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateContentTag":{"properties":{"contentTag":{"index":0,"kind":"parameter","displayName":"Content Tag","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.ContentTag","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateDynamicContentItem":{"properties":{"item":{"index":0,"kind":"parameter","displayName":"Item","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.dynamic.DynamicContentItem","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateDynamicContentItemVariant":{"properties":{"itemId":{"index":0,"kind":"parameter","displayName":"Item Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"variant":{"index":1,"kind":"parameter","displayName":"Variant","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateForum":{"properties":{"forum":{"index":0,"kind":"parameter","displayName":"Forum","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Forum","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateGroup":{"properties":{"group":{"index":0,"kind":"parameter","displayName":"Group","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Group","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateInstallation":{"properties":{"installationId":{"index":0,"kind":"parameter","displayName":"Installation Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"json":{"index":1,"kind":"parameter","displayName":"Json","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateMacro":{"properties":{"macro":{"index":0,"kind":"parameter","displayName":"Macro","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Macro","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"macroId0":{"index":1,"kind":"parameter","displayName":"Macro Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateOrganization":{"properties":{"organization":{"index":0,"kind":"parameter","displayName":"Organization","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Organization","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateOrganizations":{"properties":{"organizationList":{"index":0,"kind":"parameter","displayName":"Organization List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"organizations":{"index":1,"kind":"parameter","displayName":"Organizations","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Organization[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateOrganizationsAsync":{"properties":{"organizationList":{"index":0,"kind":"parameter","displayName":"Organization List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updatePermissionGroup":{"properties":{"permissionGroup":{"index":0,"kind":"parameter","displayName":"Permission Group","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.PermissionGroup","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateRequest":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Request","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateSection":{"properties":{"section":{"index":0,"kind":"parameter","displayName":"Section","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Section","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateSectionTranslation":{"properties":{"locale":{"index":0,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sectionId":{"index":1,"kind":"parameter","displayName":"Section Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"translation":{"index":2,"kind":"parameter","displayName":"Translation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Translation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateTicket":{"properties":{"ticket":{"index":0,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateTicketField":{"properties":{"field":{"index":0,"kind":"parameter","displayName":"Field","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Field","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateTicketForm":{"properties":{"ticketForm":{"index":0,"kind":"parameter","displayName":"Ticket Form","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.TicketForm","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateTickets":{"properties":{"ticketList":{"index":0,"kind":"parameter","displayName":"Ticket List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tickets":{"index":1,"kind":"parameter","displayName":"Tickets","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateTicketsAsync":{"properties":{"ticketList":{"index":0,"kind":"parameter","displayName":"Ticket List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateTopic":{"properties":{"topic":{"index":0,"kind":"parameter","displayName":"Topic","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Topic","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateTrigger":{"properties":{"trigger":{"index":0,"kind":"parameter","displayName":"Trigger","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Trigger","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"triggerId0":{"index":1,"kind":"parameter","displayName":"Trigger Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateUser":{"properties":{"user":{"index":0,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateUserIdentity":{"properties":{"identity":{"index":0,"kind":"parameter","displayName":"Identity","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Identity","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":1,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateUserSegment":{"properties":{"userSegment":{"index":0,"kind":"parameter","displayName":"User Segment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.UserSegment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateUsers":{"properties":{"users":{"index":0,"kind":"parameter","displayName":"Users","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"usersList":{"index":1,"kind":"parameter","displayName":"Users List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateUsersAsync":{"properties":{"usersList":{"index":0,"kind":"parameter","displayName":"Users List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"verifyUserIdentity":{"properties":{"identity":{"index":0,"kind":"parameter","displayName":"Identity","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Identity","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"identityId":{"index":1,"kind":"parameter","displayName":"Identity Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":3,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}}}} +{"component":{"kind":"component","name":"zendesk","title":"Zendesk","description":"Manage Zendesk tickets, users, organizations, etc.","deprecated":false,"firstVersion":"2.19.0","label":"cloud,api,saas","javaType":"org.apache.camel.component.zendesk.ZendeskComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-zendesk","version":"4.8.2","scheme":"zendesk","extendsScheme":"","syntax":"zendesk:methodName","async":false,"api":true,"apiSyntax":"methodName","consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"properties":{"methodName":{"index":0,"kind":"path","displayName":"Method Name","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.zendesk.internal.ZendeskApiMethod","enum":["ADD_TAG_TO_ORGANISATIONS","ADD_TAG_TO_TICKET","ADD_TAG_TO_TOPICS","ASSOCIATE_ATTACHMENTS_TO_ARTICLE","CHANGE_USER_PASSWORD","CREATE_ARTICLE","CREATE_ARTICLE_1","CREATE_ARTICLE_TRANSLATION","CREATE_AUTOMATION","CREATE_CATEGORY","CREATE_CATEGORY_TRANSLATION","CREATE_COMMENT","CREATE_CONTENT_TAG","CREATE_DYNAMIC_CONTENT_ITEM","CREATE_DYNAMIC_CONTENT_ITEM_VARIANT","CREATE_FORUM","CREATE_GROUP","CREATE_GROUP_MEMBERSHIP","CREATE_GROUP_MEMBERSHIP_1","CREATE_MACRO","CREATE_OR_UPDATE_ORGANIZATION","CREATE_OR_UPDATE_USER","CREATE_OR_UPDATE_USERS","CREATE_OR_UPDATE_USERS_1","CREATE_OR_UPDATE_USERS_ASYNC","CREATE_ORGANIZATION","CREATE_ORGANIZATION_MEMBERSHIP","CREATE_ORGANIZATION_MEMBERSHIP_1","CREATE_ORGANIZATION_MEMBERSHIPS","CREATE_ORGANIZATION_MEMBERSHIPS_1","CREATE_ORGANIZATION_MEMBERSHIPS_ASYNC","CREATE_ORGANIZATIONS","CREATE_ORGANIZATIONS_1","CREATE_ORGANIZATIONS_ASYNC","CREATE_PERMISSION_GROUP","CREATE_REQUEST","CREATE_SATISFACTION_RATING","CREATE_SATISFACTION_RATING_1","CREATE_SECTION","CREATE_SECTION_TRANSLATION","CREATE_TARGET","CREATE_TICKET","CREATE_TICKET_ASYNC","CREATE_TICKET_FIELD","CREATE_TICKET_FORM","CREATE_TICKET_FROM_TWEET","CREATE_TICKETS","CREATE_TICKETS_1","CREATE_TICKETS_ASYNC","CREATE_TOPIC","CREATE_TRIGGER","CREATE_UPLOAD","CREATE_UPLOAD_1","CREATE_UPLOAD_2","CREATE_UPLOAD_ARTICLE","CREATE_UPLOAD_ARTICLE_1","CREATE_USER","CREATE_USER_IDENTITY","CREATE_USER_IDENTITY_1","CREATE_USER_SEGMENT","CREATE_USERS","CREATE_USERS_1","CREATE_USERS_ASYNC","DELETE_ARTICLE","DELETE_ARTICLE_ATTACHMENT","DELETE_ARTICLE_ATTACHMENT_1","DELETE_ATTACHMENT","DELETE_ATTACHMENT_1","DELETE_AUTOMATION","DELETE_CATEGORY","DELETE_CONTENT_TAG","DELETE_DYNAMIC_CONTENT_ITEM","DELETE_DYNAMIC_CONTENT_ITEM_VARIANT","DELETE_FORUM","DELETE_GROUP","DELETE_GROUP_1","DELETE_GROUP_MEMBERSHIP","DELETE_GROUP_MEMBERSHIP_1","DELETE_GROUP_MEMBERSHIP_2","DELETE_GROUP_MEMBERSHIP_3","DELETE_ORGANIZATION","DELETE_ORGANIZATION_1","DELETE_ORGANIZATION_MEMBERSHIP","DELETE_ORGANIZATION_MEMBERSHIP_1","DELETE_ORGANIZATION_MEMBERSHIP_2","DELETE_ORGANIZATION_MEMBERSHIPS","DELETE_ORGANIZATIONS","DELETE_PERMISSION_GROUP","DELETE_PERMISSION_GROUP_1","DELETE_SECTION","DELETE_SUSPENDED_TICKET","DELETE_SUSPENDED_TICKET_1","DELETE_TARGET","DELETE_TICKET","DELETE_TICKET_1","DELETE_TICKET_FIELD","DELETE_TICKET_FIELD_1","DELETE_TICKET_FORM","DELETE_TICKET_FORM_1","DELETE_TICKETS","DELETE_TOPIC","DELETE_TRANSLATION","DELETE_TRANSLATION_1","DELETE_TRIGGER","DELETE_UPLOAD","DELETE_UPLOAD_1","DELETE_USER","DELETE_USER_1","DELETE_USER_IDENTITY","DELETE_USER_IDENTITY_1","DELETE_USER_IDENTITY_2","DELETE_USER_SEGMENT","DELETE_USER_SEGMENT_1","DELETE_USERS","GET_ACTIVE_TRIGGERS","GET_ARTICLE","GET_ARTICLE_FROM_SEARCH","GET_ARTICLE_FROM_SEARCH_1","GET_ARTICLE_SUBSCRIPTIONS","GET_ARTICLE_SUBSCRIPTIONS_1","GET_ARTICLE_TRANSLATIONS","GET_ARTICLES","GET_ARTICLES_1","GET_ARTICLES_2","GET_ARTICLES_3","GET_ARTICLES_4","GET_ARTICLES_5","GET_ARTICLES_FROM_ALL_LABELS","GET_ARTICLES_FROM_ANY_LABELS","GET_ARTICLES_FROM_PAGE","GET_ARTICLES_INCREMENTALLY","GET_ASSIGNABLE_GROUP_MEMBERSHIPS","GET_ASSIGNABLE_GROUP_MEMBERSHIPS_1","GET_ASSIGNABLE_GROUPS","GET_ASSIGNED_TICKETS_COUNT_FOR_USER","GET_ATTACHMENT","GET_ATTACHMENT_1","GET_ATTACHMENTS_FROM_ARTICLE","GET_AUTHENTICATED_USER","GET_AUTO_COMPLETE_ORGANIZATIONS","GET_AUTOMATION","GET_AUTOMATIONS","GET_BRANDS","GET_CC_REQUESTS","GET_CATEGORIES","GET_CATEGORY","GET_CATEGORY_TRANSLATIONS","GET_CCD_TICKETS_COUNT_FOR_USER","GET_COMPLIANCE_DELETION_STATUSES","GET_CONTENT_TAG","GET_CONTENT_TAGS","GET_CONTENT_TAGS_1","GET_CONTENT_TAGS_2","GET_CURRENT_USER","GET_CUSTOM_AGENT_ROLES","GET_CUSTOM_TICKET_STATUSES","GET_DELETED_TICKETS","GET_DELETED_TICKETS_1","GET_DYNAMIC_CONTENT_ITEM","GET_DYNAMIC_CONTENT_ITEM_VARIANT","GET_DYNAMIC_CONTENT_ITEM_VARIANTS","GET_DYNAMIC_CONTENT_ITEMS","GET_FORUM","GET_FORUMS","GET_FORUMS_1","GET_GROUP","GET_GROUP_MEMBERSHIP","GET_GROUP_MEMBERSHIP_1","GET_GROUP_MEMBERSHIP_BY_USER","GET_GROUP_MEMBERSHIPS","GET_GROUP_MEMBERSHIPS_1","GET_GROUP_ORGANIZATION","GET_GROUP_USERS","GET_GROUPS","GET_HELP_CENTER_LOCALES","GET_HOLIDAYS_FOR_SCHEDULE","GET_HOLIDAYS_FOR_SCHEDULE_1","GET_INCREMENTAL_TICKETS_RESULT","GET_JIRA_LINKS","GET_JOB_STATUS","GET_JOB_STATUS_ASYNC","GET_JOB_STATUSES","GET_JOB_STATUSES_ASYNC","GET_LOCALES","GET_MACRO","GET_MACROS","GET_OPEN_REQUESTS","GET_ORGANIZATION","GET_ORGANIZATION_FIELDS","GET_ORGANIZATION_MEMBERSHIP","GET_ORGANIZATION_MEMBERSHIP_BY_USER","GET_ORGANIZATION_MEMBERSHIP_FOR_USER","GET_ORGANIZATION_MEMBERSHIPS","GET_ORGANIZATION_MEMBERSHIPS_FOR_ORG","GET_ORGANIZATION_MEMBERSHIPS_FOR_USER","GET_ORGANIZATION_REQUESTS","GET_ORGANIZATION_TICKETS","GET_ORGANIZATION_USERS","GET_ORGANIZATIONS","GET_ORGANIZATIONS_1","GET_ORGANIZATIONS_INCREMENTALLY","GET_PERMISSION_GROUP","GET_PERMISSION_GROUPS","GET_RECENT_TICKETS","GET_REQUEST","GET_REQUEST_COMMENT","GET_REQUEST_COMMENT_1","GET_REQUEST_COMMENT_2","GET_REQUEST_COMMENTS","GET_REQUEST_COMMENTS_1","GET_REQUESTS","GET_SATISFACTION_RATING","GET_SATISFACTION_RATINGS","GET_SCHEDULE","GET_SCHEDULE_1","GET_SCHEDULES","GET_SEARCH_TICKET_RESULTS","GET_SECTION","GET_SECTION_SUBSCRIPTIONS","GET_SECTION_SUBSCRIPTIONS_1","GET_SECTION_TRANSLATIONS","GET_SECTIONS","GET_SECTIONS_1","GET_SECTIONS_2","GET_SOLVED_REQUESTS","GET_SUSPENDED_TICKETS","GET_TARGET","GET_TARGETS","GET_TICKET","GET_TICKET_AUDIT","GET_TICKET_AUDIT_1","GET_TICKET_AUDIT_2","GET_TICKET_AUDITS","GET_TICKET_AUDITS_1","GET_TICKET_COLLABORATORS","GET_TICKET_COMMENTS","GET_TICKET_COMMENTS_1","GET_TICKET_FIELD","GET_TICKET_FIELDS","GET_TICKET_FORM","GET_TICKET_FORMS","GET_TICKET_INCIDENTS","GET_TICKET_METRIC","GET_TICKET_METRIC_BY_TICKET","GET_TICKET_METRICS","GET_TICKETS","GET_TICKETS_1","GET_TICKETS_BY_EXTERNAL_ID","GET_TICKETS_BY_EXTERNAL_ID_1","GET_TICKETS_COUNT","GET_TICKETS_COUNT_FOR_ORGANIZATION","GET_TICKETS_FROM_SEARCH","GET_TICKETS_INCREMENTALLY","GET_TICKETS_INCREMENTALLY_1","GET_TIME_ZONES","GET_TOPIC","GET_TOPICS","GET_TOPICS_1","GET_TOPICS_2","GET_TOPICS_3","GET_TOPICS_BY_USER","GET_TRIGGER","GET_TRIGGERS","GET_TRIGGERS_1","GET_TWITTER_MONITORS","GET_USER","GET_USER_CCD_TICKETS","GET_USER_FIELDS","GET_USER_IDENTITIES","GET_USER_IDENTITIES_1","GET_USER_IDENTITY","GET_USER_IDENTITY_1","GET_USER_IDENTITY_2","GET_USER_RELATED_INFO","GET_USER_REQUESTED_TICKETS","GET_USER_REQUESTS","GET_USER_REQUESTS_1","GET_USER_SEGMENT","GET_USER_SEGMENTS","GET_USER_SEGMENTS_1","GET_USER_SEGMENTS_APPLICABLE","GET_USER_SUBSCRIPTIONS","GET_USER_SUBSCRIPTIONS_1","GET_USERS","GET_USERS_1","GET_USERS_BY_EXTERNAL_IDS","GET_USERS_BY_EXTERNAL_IDS_1","GET_USERS_BY_ROLE","GET_USERS_INCREMENTALLY","GET_VIEW","GET_VIEWS","IMPORT_TICKET","IMPORT_TOPIC","LIST_HELP_CENTER_LOCALES","LOOKUP_ORGANIZATIONS_BY_EXTERNAL_ID","LOOKUP_USER_BY_EMAIL","LOOKUP_USER_BY_EXTERNAL_ID","MACROS_SHOW_CHANGES_TO_TICKET","MACROS_SHOW_TICKET_AFTER_CHANGES","MAKE_PRIVATE_TICKET_AUDIT","MAKE_PRIVATE_TICKET_AUDIT_1","MAKE_PRIVATE_TICKET_AUDIT_2","MARK_TICKET_AS_SPAM","MARK_TICKET_AS_SPAM_1","MERGE_USERS","NOTIFY_APP","PERMANENTLY_DELETE_TICKET","PERMANENTLY_DELETE_TICKET_1","PERMANENTLY_DELETE_TICKETS","PERMANENTLY_DELETE_USER","PERMANENTLY_DELETE_USER_1","QUEUE_CREATE_TICKET_ASYNC","REMOVE_TAG_FROM_ORGANISATIONS","REMOVE_TAG_FROM_TICKET","REMOVE_TAG_FROM_TOPICS","REQUEST_VERIFY_USER_IDENTITY","REQUEST_VERIFY_USER_IDENTITY_1","REQUEST_VERIFY_USER_IDENTITY_2","RESET_USER_PASSWORD","RESET_USER_PASSWORD_1","SEARCH_TRIGGERS","SEARCH_TRIGGERS_1","SET_GROUP_MEMBERSHIP_AS_DEFAULT","SET_ORGANIZATION_MEMBERSHIP_AS_DEFAULT","SET_TAG_ON_ORGANISATIONS","SET_TAG_ON_TICKET","SET_TAG_ON_TOPICS","SET_USER_PRIMARY_IDENTITY","SET_USER_PRIMARY_IDENTITY_1","SET_USER_PRIMARY_IDENTITY_2","SHOW_ARTICLE_TRANSLATION","SHOW_CATEGORY_TRANSLATION","SHOW_SECTION_TRANSLATION","SUSPEND_USER","TRUST_TICKET_AUDIT","TRUST_TICKET_AUDIT_1","TRUST_TICKET_AUDIT_2","UNSUSPEND_USER","UPDATE_ARTICLE","UPDATE_ARTICLE_TRANSLATION","UPDATE_AUTOMATION","UPDATE_CATEGORY","UPDATE_CATEGORY_TRANSLATION","UPDATE_CONTENT_TAG","UPDATE_DYNAMIC_CONTENT_ITEM","UPDATE_DYNAMIC_CONTENT_ITEM_VARIANT","UPDATE_FORUM","UPDATE_GROUP","UPDATE_INSTALLATION","UPDATE_MACRO","UPDATE_ORGANIZATION","UPDATE_ORGANIZATIONS","UPDATE_ORGANIZATIONS_1","UPDATE_ORGANIZATIONS_ASYNC","UPDATE_PERMISSION_GROUP","UPDATE_REQUEST","UPDATE_SECTION","UPDATE_SECTION_TRANSLATION","UPDATE_TICKET","UPDATE_TICKET_FIELD","UPDATE_TICKET_FORM","UPDATE_TICKETS","UPDATE_TICKETS_1","UPDATE_TICKETS_ASYNC","UPDATE_TOPIC","UPDATE_TRIGGER","UPDATE_USER","UPDATE_USER_IDENTITY","UPDATE_USER_IDENTITY_1","UPDATE_USER_SEGMENT","UPDATE_USERS","UPDATE_USERS_1","UPDATE_USERS_ASYNC","VERIFY_USER_IDENTITY","VERIFY_USER_IDENTITY_1","VERIFY_USER_IDENTITY_2"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.zendesk.ZendeskConfiguration","configurationField":"configuration","description":"What operation to use"},"inBody":{"index":1,"kind":"parameter","displayName":"In Body","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Sets the name of a parameter to be passed in the exchange In Body"},"serverUrl":{"index":2,"kind":"parameter","displayName":"Server Url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.zendesk.ZendeskConfiguration","configurationField":"configuration","description":"The server URL to connect."},"sendEmptyMessageWhenIdle":{"index":3,"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"bridgeErrorHandler":{"index":4,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":5,"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":{"index":6,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"index":7,"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"lazyStartProducer":{"index":8,"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."},"backoffErrorThreshold":{"index":9,"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"index":10,"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"index":11,"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"index":12,"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"index":13,"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"index":14,"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"index":15,"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"index":16,"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"index":17,"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"index":18,"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"index":19,"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"index":20,"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"index":21,"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"index":22,"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"oauthToken":{"index":23,"kind":"parameter","displayName":"Oauth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.zendesk.ZendeskConfiguration","configurationField":"configuration","description":"The OAuth token."},"password":{"index":24,"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.zendesk.ZendeskConfiguration","configurationField":"configuration","description":"The password."},"token":{"index":25,"kind":"parameter","displayName":"Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.zendesk.ZendeskConfiguration","configurationField":"configuration","description":"The security token."},"username":{"index":26,"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.zendesk.ZendeskConfiguration","configurationField":"configuration","description":"The user name."}},"apis":{"DEFAULT":{"consumerOnly":false,"producerOnly":false,"description":"","methods":{"addTagToOrganisations":{"description":"","signatures":["java.util.List addTagToOrganisations(long id, String[] tags)"]},"addTagToTicket":{"description":"","signatures":["java.util.List addTagToTicket(long id, String[] tags)"]},"addTagToTopics":{"description":"","signatures":["java.util.List addTagToTopics(long id, String[] tags)"]},"associateAttachmentsToArticle":{"description":"","signatures":["void associateAttachmentsToArticle(String idArticle, java.util.List attachments)"]},"changeUserPassword":{"description":"","signatures":["void changeUserPassword(org.zendesk.client.v2.model.User user, String oldPassword, String newPassword)"]},"createArticle":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Article createArticle(org.zendesk.client.v2.model.hc.Article article)","org.zendesk.client.v2.model.hc.Article createArticle(org.zendesk.client.v2.model.hc.Article article, boolean notifySubscribers)"]},"createArticleTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation createArticleTranslation(Long articleId, org.zendesk.client.v2.model.hc.Translation translation)"]},"createAutomation":{"description":"","signatures":["org.zendesk.client.v2.model.Automation createAutomation(org.zendesk.client.v2.model.Automation automation)"]},"createCategory":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Category createCategory(org.zendesk.client.v2.model.hc.Category category)"]},"createCategoryTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation createCategoryTranslation(Long categoryId, org.zendesk.client.v2.model.hc.Translation translation)"]},"createComment":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket createComment(long ticketId, org.zendesk.client.v2.model.Comment comment)"]},"createContentTag":{"description":"","signatures":["org.zendesk.client.v2.model.hc.ContentTag createContentTag(org.zendesk.client.v2.model.hc.ContentTag contentTag)"]},"createDynamicContentItem":{"description":"","signatures":["org.zendesk.client.v2.model.dynamic.DynamicContentItem createDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item)"]},"createDynamicContentItemVariant":{"description":"","signatures":["org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant createDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant)"]},"createForum":{"description":"","signatures":["org.zendesk.client.v2.model.Forum createForum(org.zendesk.client.v2.model.Forum forum)"]},"createGroup":{"description":"","signatures":["org.zendesk.client.v2.model.Group createGroup(org.zendesk.client.v2.model.Group group)"]},"createGroupMembership":{"description":"","signatures":["org.zendesk.client.v2.model.GroupMembership createGroupMembership(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership)","org.zendesk.client.v2.model.GroupMembership createGroupMembership(org.zendesk.client.v2.model.GroupMembership groupMembership)"]},"createMacro":{"description":"","signatures":["org.zendesk.client.v2.model.Macro createMacro(org.zendesk.client.v2.model.Macro macro)"]},"createOrUpdateOrganization":{"description":"","signatures":["org.zendesk.client.v2.model.Organization createOrUpdateOrganization(org.zendesk.client.v2.model.Organization organization)"]},"createOrUpdateUser":{"description":"","signatures":["org.zendesk.client.v2.model.User createOrUpdateUser(org.zendesk.client.v2.model.User user)"]},"createOrUpdateUsers":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus createOrUpdateUsers(java.util.List users)","org.zendesk.client.v2.model.JobStatus createOrUpdateUsers(org.zendesk.client.v2.model.User[] users)"]},"createOrUpdateUsersAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture createOrUpdateUsersAsync(java.util.List users)"]},"createOrganization":{"description":"","signatures":["org.zendesk.client.v2.model.Organization createOrganization(org.zendesk.client.v2.model.Organization organization)"]},"createOrganizationMembership":{"description":"","signatures":["org.zendesk.client.v2.model.OrganizationMembership createOrganizationMembership(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership)","org.zendesk.client.v2.model.OrganizationMembership createOrganizationMembership(org.zendesk.client.v2.model.OrganizationMembership organizationMembership)"]},"createOrganizationMemberships":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus createOrganizationMemberships(java.util.List organizationMemberships)","org.zendesk.client.v2.model.JobStatus createOrganizationMemberships(org.zendesk.client.v2.model.OrganizationMembership[] organizationMemberships)"]},"createOrganizationMembershipsAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture createOrganizationMembershipsAsync(java.util.List organizationMemberships)"]},"createOrganizations":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus createOrganizations(java.util.List organizations)","org.zendesk.client.v2.model.JobStatus createOrganizations(org.zendesk.client.v2.model.Organization[] organizations)"]},"createOrganizationsAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture createOrganizationsAsync(java.util.List organizations)"]},"createPermissionGroup":{"description":"Create permission group","signatures":["org.zendesk.client.v2.model.hc.PermissionGroup createPermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup)"]},"createRequest":{"description":"","signatures":["org.zendesk.client.v2.model.Request createRequest(org.zendesk.client.v2.model.Request request)"]},"createSatisfactionRating":{"description":"","signatures":["org.zendesk.client.v2.model.SatisfactionRating createSatisfactionRating(long ticketId, org.zendesk.client.v2.model.SatisfactionRating satisfactionRating)","org.zendesk.client.v2.model.SatisfactionRating createSatisfactionRating(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.SatisfactionRating satisfactionRating)"]},"createSection":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Section createSection(org.zendesk.client.v2.model.hc.Section section)"]},"createSectionTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation createSectionTranslation(Long sectionId, org.zendesk.client.v2.model.hc.Translation translation)"]},"createTarget":{"description":"","signatures":["org.zendesk.client.v2.model.targets.Target createTarget(org.zendesk.client.v2.model.targets.Target target)"]},"createTicket":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket createTicket(org.zendesk.client.v2.model.Ticket ticket)"]},"createTicketAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture createTicketAsync(org.zendesk.client.v2.model.Ticket ticket)"]},"createTicketField":{"description":"","signatures":["org.zendesk.client.v2.model.Field createTicketField(org.zendesk.client.v2.model.Field field)"]},"createTicketForm":{"description":"","signatures":["org.zendesk.client.v2.model.TicketForm createTicketForm(org.zendesk.client.v2.model.TicketForm ticketForm)"]},"createTicketFromTweet":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket createTicketFromTweet(long tweetId, long monitorId)"]},"createTickets":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus createTickets(java.util.List tickets)","org.zendesk.client.v2.model.JobStatus createTickets(org.zendesk.client.v2.model.Ticket[] tickets)"]},"createTicketsAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture createTicketsAsync(java.util.List tickets)"]},"createTopic":{"description":"","signatures":["org.zendesk.client.v2.model.Topic createTopic(org.zendesk.client.v2.model.Topic topic)"]},"createTrigger":{"description":"","signatures":["org.zendesk.client.v2.model.Trigger createTrigger(org.zendesk.client.v2.model.Trigger trigger)"]},"createUpload":{"description":"","signatures":["org.zendesk.client.v2.model.Attachment$Upload createUpload(String fileName, String contentType, byte[] content)","org.zendesk.client.v2.model.Attachment$Upload createUpload(String fileName, byte[] content)","org.zendesk.client.v2.model.Attachment$Upload createUpload(String token, String fileName, String contentType, byte[] content)"]},"createUploadArticle":{"description":"","signatures":["org.zendesk.client.v2.model.hc.ArticleAttachments createUploadArticle(long articleId, java.io.File file)","org.zendesk.client.v2.model.hc.ArticleAttachments createUploadArticle(long articleId, java.io.File file, boolean inline)"]},"createUser":{"description":"","signatures":["org.zendesk.client.v2.model.User createUser(org.zendesk.client.v2.model.User user)"]},"createUserIdentity":{"description":"","signatures":["org.zendesk.client.v2.model.Identity createUserIdentity(long userId, org.zendesk.client.v2.model.Identity identity)","org.zendesk.client.v2.model.Identity createUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)"]},"createUserSegment":{"description":"Create User Segment","signatures":["org.zendesk.client.v2.model.hc.UserSegment createUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment)"]},"createUsers":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus createUsers(java.util.List users)","org.zendesk.client.v2.model.JobStatus createUsers(org.zendesk.client.v2.model.User[] users)"]},"createUsersAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture createUsersAsync(java.util.List users)"]},"deleteArticle":{"description":"","signatures":["void deleteArticle(org.zendesk.client.v2.model.hc.Article article)"]},"deleteArticleAttachment":{"description":"Delete attachment from article","signatures":["void deleteArticleAttachment(long id)","void deleteArticleAttachment(org.zendesk.client.v2.model.hc.ArticleAttachments attachment)"]},"deleteAttachment":{"description":"","signatures":["void deleteAttachment(long id)","void deleteAttachment(org.zendesk.client.v2.model.Attachment attachment)"]},"deleteAutomation":{"description":"","signatures":["void deleteAutomation(long automationId)"]},"deleteCategory":{"description":"","signatures":["void deleteCategory(org.zendesk.client.v2.model.hc.Category category)"]},"deleteContentTag":{"description":"","signatures":["void deleteContentTag(org.zendesk.client.v2.model.hc.ContentTag contentTag)"]},"deleteDynamicContentItem":{"description":"","signatures":["void deleteDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item)"]},"deleteDynamicContentItemVariant":{"description":"","signatures":["void deleteDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant)"]},"deleteForum":{"description":"","signatures":["void deleteForum(org.zendesk.client.v2.model.Forum forum)"]},"deleteGroup":{"description":"","signatures":["void deleteGroup(long id)","void deleteGroup(org.zendesk.client.v2.model.Group group)"]},"deleteGroupMembership":{"description":"","signatures":["void deleteGroupMembership(long id)","void deleteGroupMembership(long user_id, long group_membership_id)","void deleteGroupMembership(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership)","void deleteGroupMembership(org.zendesk.client.v2.model.GroupMembership groupMembership)"]},"deleteOrganization":{"description":"","signatures":["void deleteOrganization(long id)","void deleteOrganization(org.zendesk.client.v2.model.Organization organization)"]},"deleteOrganizationMembership":{"description":"","signatures":["void deleteOrganizationMembership(long id)","void deleteOrganizationMembership(long user_id, long organization_membership_id)","void deleteOrganizationMembership(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership)"]},"deleteOrganizationMemberships":{"description":"","signatures":["void deleteOrganizationMemberships(long id, long[] ids)"]},"deleteOrganizations":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus deleteOrganizations(long[] ids)"]},"deletePermissionGroup":{"description":"Delete permission group","signatures":["void deletePermissionGroup(long id)","void deletePermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup)"]},"deleteSection":{"description":"","signatures":["void deleteSection(org.zendesk.client.v2.model.hc.Section section)"]},"deleteSuspendedTicket":{"description":"","signatures":["void deleteSuspendedTicket(long id)","void deleteSuspendedTicket(org.zendesk.client.v2.model.SuspendedTicket ticket)"]},"deleteTarget":{"description":"","signatures":["void deleteTarget(long targetId)"]},"deleteTicket":{"description":"","signatures":["void deleteTicket(long id)","void deleteTicket(org.zendesk.client.v2.model.Ticket ticket)"]},"deleteTicketField":{"description":"","signatures":["void deleteTicketField(long id)","void deleteTicketField(org.zendesk.client.v2.model.Field field)"]},"deleteTicketForm":{"description":"","signatures":["void deleteTicketForm(long id)","void deleteTicketForm(org.zendesk.client.v2.model.TicketForm ticketForm)"]},"deleteTickets":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus deleteTickets(long id, long[] ids)"]},"deleteTopic":{"description":"","signatures":["void deleteTopic(org.zendesk.client.v2.model.Topic topic)"]},"deleteTranslation":{"description":"Delete translation","signatures":["void deleteTranslation(Long translationId)","void deleteTranslation(org.zendesk.client.v2.model.hc.Translation translation)"]},"deleteTrigger":{"description":"","signatures":["void deleteTrigger(long triggerId)"]},"deleteUpload":{"description":"","signatures":["void deleteUpload(String token)","void deleteUpload(org.zendesk.client.v2.model.Attachment$Upload upload)"]},"deleteUser":{"description":"","signatures":["void deleteUser(long id)","void deleteUser(org.zendesk.client.v2.model.User user)"]},"deleteUserIdentity":{"description":"","signatures":["void deleteUserIdentity(long userId, long identityId)","void deleteUserIdentity(org.zendesk.client.v2.model.User user, long identityId)","void deleteUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)"]},"deleteUserSegment":{"description":"Delete User Segment","signatures":["void deleteUserSegment(long id)","void deleteUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment)"]},"deleteUsers":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus deleteUsers(long[] ids)"]},"getArticle":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Article getArticle(long id)"]},"getArticleFromSearch":{"description":"","signatures":["Iterable getArticleFromSearch(String searchTerm)","Iterable getArticleFromSearch(String searchTerm, Long sectionId)"]},"getArticleSubscriptions":{"description":"","signatures":["Iterable getArticleSubscriptions(Long articleId)","Iterable getArticleSubscriptions(Long articleId, String locale)"]},"getArticleTranslations":{"description":"","signatures":["Iterable getArticleTranslations(Long articleId)"]},"getArticles":{"description":"Get all articles from help center","signatures":["Iterable getArticles()","Iterable getArticles(String locale)","Iterable getArticles(org.zendesk.client.v2.model.hc.Category category)","Iterable getArticles(org.zendesk.client.v2.model.hc.Category category, String locale)","Iterable getArticles(org.zendesk.client.v2.model.hc.Section section)","Iterable getArticles(org.zendesk.client.v2.model.hc.Section section, String locale)"]},"getArticlesFromAllLabels":{"description":"","signatures":["Iterable getArticlesFromAllLabels(java.util.List labels)"]},"getArticlesFromAnyLabels":{"description":"","signatures":["Iterable getArticlesFromAnyLabels(java.util.List labels)"]},"getArticlesFromPage":{"description":"","signatures":["java.util.List getArticlesFromPage(int page)"]},"getArticlesIncrementally":{"description":"","signatures":["Iterable getArticlesIncrementally(java.util.Date startTime)"]},"getAssignableGroupMemberships":{"description":"","signatures":["Iterable getAssignableGroupMemberships()","Iterable getAssignableGroupMemberships(long group_id)"]},"getAssignedTicketsCountForUser":{"description":"","signatures":["org.zendesk.client.v2.model.TicketCount getAssignedTicketsCountForUser(long id)"]},"getAttachment":{"description":"","signatures":["org.zendesk.client.v2.model.Attachment getAttachment(long id)","org.zendesk.client.v2.model.Attachment getAttachment(org.zendesk.client.v2.model.Attachment attachment)"]},"getAttachmentsFromArticle":{"description":"","signatures":["java.util.List getAttachmentsFromArticle(Long articleID)"]},"getAutoCompleteOrganizations":{"description":"","signatures":["Iterable getAutoCompleteOrganizations(String name)"]},"getAutomation":{"description":"","signatures":["org.zendesk.client.v2.model.Automation getAutomation(long id)"]},"getCategory":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Category getCategory(long id)"]},"getCategoryTranslations":{"description":"","signatures":["Iterable getCategoryTranslations(Long categoryId)"]},"getCcdTicketsCountForUser":{"description":"","signatures":["org.zendesk.client.v2.model.TicketCount getCcdTicketsCountForUser(long id)"]},"getComplianceDeletionStatuses":{"description":"","signatures":["Iterable getComplianceDeletionStatuses(long userId)"]},"getContentTag":{"description":"","signatures":["org.zendesk.client.v2.model.hc.ContentTag getContentTag(String contentTagId)"]},"getContentTags":{"description":"","signatures":["Iterable getContentTags()","Iterable getContentTags(int pageSize)","Iterable getContentTags(int pageSize, String namePrefix)"]},"getDeletedTickets":{"description":"","signatures":["Iterable getDeletedTickets()","Iterable getDeletedTickets(String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder)"]},"getDynamicContentItem":{"description":"","signatures":["org.zendesk.client.v2.model.dynamic.DynamicContentItem getDynamicContentItem(long id)"]},"getDynamicContentItemVariant":{"description":"","signatures":["org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant getDynamicContentItemVariant(Long itemId, long id)"]},"getDynamicContentItemVariants":{"description":"","signatures":["Iterable getDynamicContentItemVariants(org.zendesk.client.v2.model.dynamic.DynamicContentItem item)"]},"getForum":{"description":"","signatures":["org.zendesk.client.v2.model.Forum getForum(long id)"]},"getForums":{"description":"","signatures":["Iterable getForums()","java.util.List getForums(long category_id)"]},"getGroup":{"description":"","signatures":["org.zendesk.client.v2.model.Group getGroup(long id)"]},"getGroupMembership":{"description":"","signatures":["org.zendesk.client.v2.model.GroupMembership getGroupMembership(long id)","org.zendesk.client.v2.model.GroupMembership getGroupMembership(long user_id, long group_membership_id)"]},"getGroupMembershipByUser":{"description":"","signatures":["Iterable getGroupMembershipByUser(long user_id)"]},"getGroupMemberships":{"description":"","signatures":["Iterable getGroupMemberships()","Iterable getGroupMemberships(long group_id)"]},"getGroupOrganization":{"description":"","signatures":["org.zendesk.client.v2.model.OrganizationMembership getGroupOrganization(long user_id, long organization_membership_id)"]},"getGroupUsers":{"description":"","signatures":["Iterable getGroupUsers(long id)"]},"getHolidaysForSchedule":{"description":"","signatures":["Iterable getHolidaysForSchedule(Long scheduleId)","Iterable getHolidaysForSchedule(org.zendesk.client.v2.model.schedules.Schedule schedule)"]},"getIncrementalTicketsResult":{"description":"","signatures":["java.util.Map getIncrementalTicketsResult(long unixEpochTime)"]},"getJobStatus":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus getJobStatus(org.zendesk.client.v2.model.JobStatus status)"]},"getJobStatusAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture getJobStatusAsync(org.zendesk.client.v2.model.JobStatus status)"]},"getJobStatuses":{"description":"","signatures":["java.util.List getJobStatuses(java.util.List statuses)"]},"getJobStatusesAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture> getJobStatusesAsync(java.util.List statuses)"]},"getMacro":{"description":"","signatures":["org.zendesk.client.v2.model.Macro getMacro(long macroId)"]},"getOrganization":{"description":"","signatures":["org.zendesk.client.v2.model.Organization getOrganization(long id)"]},"getOrganizationMembership":{"description":"","signatures":["org.zendesk.client.v2.model.OrganizationMembership getOrganizationMembership(long id)"]},"getOrganizationMembershipByUser":{"description":"","signatures":["Iterable getOrganizationMembershipByUser(long user_id)"]},"getOrganizationMembershipForUser":{"description":"","signatures":["org.zendesk.client.v2.model.OrganizationMembership getOrganizationMembershipForUser(long user_id, long id)"]},"getOrganizationMembershipsForOrg":{"description":"","signatures":["Iterable getOrganizationMembershipsForOrg(long organization_id)"]},"getOrganizationMembershipsForUser":{"description":"","signatures":["Iterable getOrganizationMembershipsForUser(long user_id)"]},"getOrganizationRequests":{"description":"","signatures":["Iterable getOrganizationRequests(long organizationId)"]},"getOrganizationTickets":{"description":"","signatures":["Iterable getOrganizationTickets(long organizationId)"]},"getOrganizationUsers":{"description":"","signatures":["Iterable getOrganizationUsers(long id)"]},"getOrganizations":{"description":"","signatures":["Iterable getOrganizations()","java.util.List getOrganizations(long id, long[] ids)"]},"getOrganizationsIncrementally":{"description":"","signatures":["Iterable getOrganizationsIncrementally(java.util.Date startTime)"]},"getPermissionGroup":{"description":"Get permission group by id","signatures":["org.zendesk.client.v2.model.hc.PermissionGroup getPermissionGroup(long id)"]},"getRequest":{"description":"","signatures":["org.zendesk.client.v2.model.Request getRequest(long id)"]},"getRequestComment":{"description":"","signatures":["org.zendesk.client.v2.model.Comment getRequestComment(long requestId, long commentId)","org.zendesk.client.v2.model.Comment getRequestComment(org.zendesk.client.v2.model.Request request, long commentId)","org.zendesk.client.v2.model.Comment getRequestComment(org.zendesk.client.v2.model.Request request, org.zendesk.client.v2.model.Comment comment)"]},"getRequestComments":{"description":"","signatures":["Iterable getRequestComments(long id)","Iterable getRequestComments(org.zendesk.client.v2.model.Request request)"]},"getSatisfactionRating":{"description":"","signatures":["org.zendesk.client.v2.model.SatisfactionRating getSatisfactionRating(long id)"]},"getSchedule":{"description":"","signatures":["org.zendesk.client.v2.model.schedules.Schedule getSchedule(Long scheduleId)","org.zendesk.client.v2.model.schedules.Schedule getSchedule(org.zendesk.client.v2.model.schedules.Schedule schedule)"]},"getSearchTicketResults":{"description":"Ticket Search API implementation with pagination support","signatures":["java.util.Optional getSearchTicketResults(String query, java.util.Map queryParams, String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder)"]},"getSection":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Section getSection(long id)"]},"getSectionSubscriptions":{"description":"","signatures":["Iterable getSectionSubscriptions(Long sectionId)","Iterable getSectionSubscriptions(Long sectionId, String locale)"]},"getSectionTranslations":{"description":"","signatures":["Iterable getSectionTranslations(Long sectionId)"]},"getSections":{"description":"List Sections using a User Segment","signatures":["Iterable getSections()","Iterable getSections(org.zendesk.client.v2.model.hc.Category category)","Iterable getSections(org.zendesk.client.v2.model.hc.UserSegment userSegment)"]},"getTarget":{"description":"","signatures":["org.zendesk.client.v2.model.targets.Target getTarget(long id)"]},"getTicket":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket getTicket(long id)"]},"getTicketAudit":{"description":"","signatures":["org.zendesk.client.v2.model.Audit getTicketAudit(long ticketId, long auditId)","org.zendesk.client.v2.model.Audit getTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id)","org.zendesk.client.v2.model.Audit getTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit)"]},"getTicketAudits":{"description":"","signatures":["Iterable getTicketAudits(Long id)","Iterable getTicketAudits(org.zendesk.client.v2.model.Ticket ticket)"]},"getTicketCollaborators":{"description":"","signatures":["java.util.List getTicketCollaborators(long id)"]},"getTicketComments":{"description":"","signatures":["Iterable getTicketComments(long id)","Iterable getTicketComments(long id, org.zendesk.client.v2.model.SortOrder order)"]},"getTicketField":{"description":"","signatures":["org.zendesk.client.v2.model.Field getTicketField(long id)"]},"getTicketForm":{"description":"","signatures":["org.zendesk.client.v2.model.TicketForm getTicketForm(long id)"]},"getTicketIncidents":{"description":"","signatures":["Iterable getTicketIncidents(long id)"]},"getTicketMetric":{"description":"","signatures":["org.zendesk.client.v2.model.Metric getTicketMetric(long id)"]},"getTicketMetricByTicket":{"description":"","signatures":["org.zendesk.client.v2.model.Metric getTicketMetricByTicket(long id)"]},"getTickets":{"description":"","signatures":["Iterable getTickets()","java.util.List getTickets(long id, long[] ids)"]},"getTicketsByExternalId":{"description":"","signatures":["Iterable getTicketsByExternalId(String externalId)","Iterable getTicketsByExternalId(String externalId, boolean includeArchived)"]},"getTicketsCountForOrganization":{"description":"","signatures":["org.zendesk.client.v2.model.TicketCount getTicketsCountForOrganization(long id)"]},"getTicketsFromSearch":{"description":"","signatures":["Iterable getTicketsFromSearch(String searchTerm)"]},"getTicketsIncrementally":{"description":"","signatures":["Iterable getTicketsIncrementally(java.util.Date startTime)","Iterable getTicketsIncrementally(java.util.Date startTime, java.util.Date endTime)"]},"getTopic":{"description":"","signatures":["org.zendesk.client.v2.model.Topic getTopic(long id)"]},"getTopics":{"description":"List Topics using a User Segment","signatures":["Iterable getTopics()","Iterable getTopics(org.zendesk.client.v2.model.hc.UserSegment userSegment)","java.util.List getTopics(long forum_id)","java.util.List getTopics(long id, long[] ids)"]},"getTopicsByUser":{"description":"","signatures":["java.util.List getTopicsByUser(long user_id)"]},"getTrigger":{"description":"","signatures":["org.zendesk.client.v2.model.Trigger getTrigger(long id)"]},"getTriggers":{"description":"","signatures":["Iterable getTriggers()","Iterable getTriggers(String categoryId, boolean active, String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder)"]},"getUser":{"description":"","signatures":["org.zendesk.client.v2.model.User getUser(long id)"]},"getUserCCDTickets":{"description":"","signatures":["Iterable getUserCCDTickets(long userId)"]},"getUserIdentities":{"description":"","signatures":["java.util.List getUserIdentities(long userId)","java.util.List getUserIdentities(org.zendesk.client.v2.model.User user)"]},"getUserIdentity":{"description":"","signatures":["org.zendesk.client.v2.model.Identity getUserIdentity(long userId, long identityId)","org.zendesk.client.v2.model.Identity getUserIdentity(org.zendesk.client.v2.model.User user, long identityId)","org.zendesk.client.v2.model.Identity getUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)"]},"getUserRelatedInfo":{"description":"","signatures":["org.zendesk.client.v2.model.UserRelatedInfo getUserRelatedInfo(long userId)"]},"getUserRequestedTickets":{"description":"","signatures":["Iterable getUserRequestedTickets(long userId)"]},"getUserRequests":{"description":"","signatures":["Iterable getUserRequests(long id)","Iterable getUserRequests(org.zendesk.client.v2.model.User user)"]},"getUserSegment":{"description":"Get user segment by id","signatures":["org.zendesk.client.v2.model.hc.UserSegment getUserSegment(long id)"]},"getUserSegments":{"description":"Returns the list of user segments that a particular user belongs to","signatures":["Iterable getUserSegments()","Iterable getUserSegments(long id)"]},"getUserSubscriptions":{"description":"","signatures":["Iterable getUserSubscriptions(Long userId)","Iterable getUserSubscriptions(org.zendesk.client.v2.model.User user)"]},"getUsers":{"description":"","signatures":["Iterable getUsers()","java.util.List getUsers(long id, long[] ids)"]},"getUsersByExternalIds":{"description":"","signatures":["java.util.List getUsersByExternalIds(String externalId, String[] externalIds)","java.util.List getUsersByExternalIds(long externalId, long[] externalIds)"]},"getUsersByRole":{"description":"","signatures":["Iterable getUsersByRole(String role, String[] roles)"]},"getUsersIncrementally":{"description":"","signatures":["Iterable getUsersIncrementally(java.util.Date startTime)"]},"getView":{"description":"","signatures":["Iterable getView(long id)"]},"importTicket":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket importTicket(org.zendesk.client.v2.model.TicketImport ticketImport)"]},"importTopic":{"description":"","signatures":["org.zendesk.client.v2.model.Topic importTopic(org.zendesk.client.v2.model.Topic topic)"]},"lookupOrganizationsByExternalId":{"description":"","signatures":["Iterable lookupOrganizationsByExternalId(String externalId)"]},"lookupUserByEmail":{"description":"","signatures":["Iterable lookupUserByEmail(String email)"]},"lookupUserByExternalId":{"description":"","signatures":["Iterable lookupUserByExternalId(String externalId)"]},"macrosShowChangesToTicket":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket macrosShowChangesToTicket(long macroId)"]},"macrosShowTicketAfterChanges":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket macrosShowTicketAfterChanges(long ticketId, long macroId)"]},"makePrivateTicketAudit":{"description":"","signatures":["void makePrivateTicketAudit(long ticketId, long auditId)","void makePrivateTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id)","void makePrivateTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit)"]},"markTicketAsSpam":{"description":"","signatures":["void markTicketAsSpam(long id)","void markTicketAsSpam(org.zendesk.client.v2.model.Ticket ticket)"]},"mergeUsers":{"description":"","signatures":["org.zendesk.client.v2.model.User mergeUsers(long userIdThatWillRemain, long userIdThatWillBeMerged)"]},"notifyApp":{"description":"","signatures":["void notifyApp(String json)"]},"permanentlyDeleteTicket":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus permanentlyDeleteTicket(long id)","org.zendesk.client.v2.model.JobStatus permanentlyDeleteTicket(org.zendesk.client.v2.model.Ticket ticket)"]},"permanentlyDeleteTickets":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus permanentlyDeleteTickets(long id, long[] ids)"]},"permanentlyDeleteUser":{"description":"","signatures":["org.zendesk.client.v2.model.User permanentlyDeleteUser(long id)","org.zendesk.client.v2.model.User permanentlyDeleteUser(org.zendesk.client.v2.model.User user)"]},"queueCreateTicketAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture queueCreateTicketAsync(org.zendesk.client.v2.model.Ticket ticket)"]},"removeTagFromOrganisations":{"description":"","signatures":["java.util.List removeTagFromOrganisations(long id, String[] tags)"]},"removeTagFromTicket":{"description":"","signatures":["java.util.List removeTagFromTicket(long id, String[] tags)"]},"removeTagFromTopics":{"description":"","signatures":["java.util.List removeTagFromTopics(long id, String[] tags)"]},"requestVerifyUserIdentity":{"description":"","signatures":["org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(long userId, long identityId)","org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(org.zendesk.client.v2.model.User user, long identityId)","org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)"]},"resetUserPassword":{"description":"","signatures":["void resetUserPassword(long id, String password)","void resetUserPassword(org.zendesk.client.v2.model.User user, String password)"]},"searchTriggers":{"description":"","signatures":["Iterable searchTriggers(String query)","Iterable searchTriggers(String query, boolean active, String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder)"]},"setGroupMembershipAsDefault":{"description":"","signatures":["java.util.List setGroupMembershipAsDefault(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership)"]},"setOrganizationMembershipAsDefault":{"description":"","signatures":["java.util.List setOrganizationMembershipAsDefault(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership)"]},"setTagOnOrganisations":{"description":"","signatures":["java.util.List setTagOnOrganisations(long id, String[] tags)"]},"setTagOnTicket":{"description":"","signatures":["java.util.List setTagOnTicket(long id, String[] tags)"]},"setTagOnTopics":{"description":"","signatures":["java.util.List setTagOnTopics(long id, String[] tags)"]},"setUserPrimaryIdentity":{"description":"","signatures":["java.util.List setUserPrimaryIdentity(long userId, long identityId)","java.util.List setUserPrimaryIdentity(org.zendesk.client.v2.model.User user, long identityId)","java.util.List setUserPrimaryIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)"]},"showArticleTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation showArticleTranslation(long articleId, String locale)"]},"showCategoryTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation showCategoryTranslation(long categoryId, String locale)"]},"showSectionTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation showSectionTranslation(long sectionId, String locale)"]},"suspendUser":{"description":"","signatures":["org.zendesk.client.v2.model.User suspendUser(long id)"]},"trustTicketAudit":{"description":"","signatures":["void trustTicketAudit(long ticketId, long auditId)","void trustTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id)","void trustTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit)"]},"unsuspendUser":{"description":"","signatures":["org.zendesk.client.v2.model.User unsuspendUser(long id)"]},"updateArticle":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Article updateArticle(org.zendesk.client.v2.model.hc.Article article)"]},"updateArticleTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation updateArticleTranslation(Long articleId, String locale, org.zendesk.client.v2.model.hc.Translation translation)"]},"updateAutomation":{"description":"","signatures":["org.zendesk.client.v2.model.Automation updateAutomation(Long automationId, org.zendesk.client.v2.model.Automation automation)"]},"updateCategory":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Category updateCategory(org.zendesk.client.v2.model.hc.Category category)"]},"updateCategoryTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation updateCategoryTranslation(Long categoryId, String locale, org.zendesk.client.v2.model.hc.Translation translation)"]},"updateContentTag":{"description":"","signatures":["org.zendesk.client.v2.model.hc.ContentTag updateContentTag(org.zendesk.client.v2.model.hc.ContentTag contentTag)"]},"updateDynamicContentItem":{"description":"","signatures":["org.zendesk.client.v2.model.dynamic.DynamicContentItem updateDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item)"]},"updateDynamicContentItemVariant":{"description":"","signatures":["org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant updateDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant)"]},"updateForum":{"description":"","signatures":["org.zendesk.client.v2.model.Forum updateForum(org.zendesk.client.v2.model.Forum forum)"]},"updateGroup":{"description":"","signatures":["org.zendesk.client.v2.model.Group updateGroup(org.zendesk.client.v2.model.Group group)"]},"updateInstallation":{"description":"","signatures":["void updateInstallation(int id, String json)"]},"updateMacro":{"description":"","signatures":["org.zendesk.client.v2.model.Macro updateMacro(Long macroId, org.zendesk.client.v2.model.Macro macro)"]},"updateOrganization":{"description":"","signatures":["org.zendesk.client.v2.model.Organization updateOrganization(org.zendesk.client.v2.model.Organization organization)"]},"updateOrganizations":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus updateOrganizations(java.util.List organizations)","org.zendesk.client.v2.model.JobStatus updateOrganizations(org.zendesk.client.v2.model.Organization[] organizations)"]},"updateOrganizationsAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture updateOrganizationsAsync(java.util.List organizations)"]},"updatePermissionGroup":{"description":"Update permission group","signatures":["org.zendesk.client.v2.model.hc.PermissionGroup updatePermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup)"]},"updateRequest":{"description":"","signatures":["org.zendesk.client.v2.model.Request updateRequest(org.zendesk.client.v2.model.Request request)"]},"updateSection":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Section updateSection(org.zendesk.client.v2.model.hc.Section section)"]},"updateSectionTranslation":{"description":"","signatures":["org.zendesk.client.v2.model.hc.Translation updateSectionTranslation(Long sectionId, String locale, org.zendesk.client.v2.model.hc.Translation translation)"]},"updateTicket":{"description":"","signatures":["org.zendesk.client.v2.model.Ticket updateTicket(org.zendesk.client.v2.model.Ticket ticket)"]},"updateTicketField":{"description":"","signatures":["org.zendesk.client.v2.model.Field updateTicketField(org.zendesk.client.v2.model.Field field)"]},"updateTicketForm":{"description":"","signatures":["org.zendesk.client.v2.model.TicketForm updateTicketForm(org.zendesk.client.v2.model.TicketForm ticketForm)"]},"updateTickets":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus updateTickets(java.util.List tickets)","org.zendesk.client.v2.model.JobStatus updateTickets(org.zendesk.client.v2.model.Ticket[] tickets)"]},"updateTicketsAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture updateTicketsAsync(java.util.List tickets)"]},"updateTopic":{"description":"","signatures":["org.zendesk.client.v2.model.Topic updateTopic(org.zendesk.client.v2.model.Topic topic)"]},"updateTrigger":{"description":"","signatures":["org.zendesk.client.v2.model.Trigger updateTrigger(Long triggerId, org.zendesk.client.v2.model.Trigger trigger)"]},"updateUser":{"description":"","signatures":["org.zendesk.client.v2.model.User updateUser(org.zendesk.client.v2.model.User user)"]},"updateUserIdentity":{"description":"","signatures":["org.zendesk.client.v2.model.Identity updateUserIdentity(long userId, org.zendesk.client.v2.model.Identity identity)","org.zendesk.client.v2.model.Identity updateUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)"]},"updateUserSegment":{"description":"Update User Segment","signatures":["org.zendesk.client.v2.model.hc.UserSegment updateUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment)"]},"updateUsers":{"description":"","signatures":["org.zendesk.client.v2.model.JobStatus updateUsers(java.util.List users)","org.zendesk.client.v2.model.JobStatus updateUsers(org.zendesk.client.v2.model.User[] users)"]},"updateUsersAsync":{"description":"","signatures":["org.asynchttpclient.ListenableFuture updateUsersAsync(java.util.List users)"]},"verifyUserIdentity":{"description":"","signatures":["org.zendesk.client.v2.model.Identity verifyUserIdentity(long userId, long identityId)","org.zendesk.client.v2.model.Identity verifyUserIdentity(org.zendesk.client.v2.model.User user, long identityId)","org.zendesk.client.v2.model.Identity verifyUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)"]}}}},"apiProperties":{"DEFAULT":{"methods":{"addTagToOrganisations":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"addTagToTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"addTagToTopics":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"associateAttachmentsToArticle":{"properties":{"attachments":{"index":0,"kind":"parameter","displayName":"Attachments","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"idArticle":{"index":1,"kind":"parameter","displayName":"Id Article","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"changeUserPassword":{"properties":{"newPassword":{"index":0,"kind":"parameter","displayName":"New Password","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"oldPassword":{"index":1,"kind":"parameter","displayName":"Old Password","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createArticle":{"properties":{"article":{"index":0,"kind":"parameter","displayName":"Article","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Article","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"notifySubscribers":{"index":1,"kind":"parameter","displayName":"Notify Subscribers","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createArticleTranslation":{"properties":{"articleId":{"index":0,"kind":"parameter","displayName":"Article Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"translation":{"index":1,"kind":"parameter","displayName":"Translation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Translation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createAutomation":{"properties":{"automation":{"index":0,"kind":"parameter","displayName":"Automation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Automation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createCategory":{"properties":{"category":{"index":0,"kind":"parameter","displayName":"Category","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Category","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createCategoryTranslation":{"properties":{"categoryId":{"index":0,"kind":"parameter","displayName":"Category Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"translation":{"index":1,"kind":"parameter","displayName":"Translation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Translation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createComment":{"properties":{"comment":{"index":0,"kind":"parameter","displayName":"Comment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Comment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketId":{"index":1,"kind":"parameter","displayName":"Ticket Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createContentTag":{"properties":{"contentTag":{"index":0,"kind":"parameter","displayName":"Content Tag","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.ContentTag","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createDynamicContentItem":{"properties":{"item":{"index":0,"kind":"parameter","displayName":"Item","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.dynamic.DynamicContentItem","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createDynamicContentItemVariant":{"properties":{"itemId":{"index":0,"kind":"parameter","displayName":"Item Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"variant":{"index":1,"kind":"parameter","displayName":"Variant","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createForum":{"properties":{"forum":{"index":0,"kind":"parameter","displayName":"Forum","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Forum","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createGroup":{"properties":{"group":{"index":0,"kind":"parameter","displayName":"Group","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Group","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createGroupMembership":{"properties":{"groupMembership":{"index":0,"kind":"parameter","displayName":"Group Membership","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.GroupMembership","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":1,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createMacro":{"properties":{"macro":{"index":0,"kind":"parameter","displayName":"Macro","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Macro","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrUpdateOrganization":{"properties":{"organization":{"index":0,"kind":"parameter","displayName":"Organization","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Organization","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrUpdateUser":{"properties":{"user":{"index":0,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrUpdateUsers":{"properties":{"users":{"index":0,"kind":"parameter","displayName":"Users","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"usersList":{"index":1,"kind":"parameter","displayName":"Users List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrUpdateUsersAsync":{"properties":{"usersList":{"index":0,"kind":"parameter","displayName":"Users List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrganization":{"properties":{"organization":{"index":0,"kind":"parameter","displayName":"Organization","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Organization","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrganizationMembership":{"properties":{"organizationMembership":{"index":0,"kind":"parameter","displayName":"Organization Membership","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.OrganizationMembership","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":1,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrganizationMemberships":{"properties":{"organizationMembershipList":{"index":0,"kind":"parameter","displayName":"Organization Membership List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"organizationMemberships":{"index":1,"kind":"parameter","displayName":"Organization Memberships","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.OrganizationMembership[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrganizationMembershipsAsync":{"properties":{"organizationMembershipList":{"index":0,"kind":"parameter","displayName":"Organization Membership List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrganizations":{"properties":{"organizationList":{"index":0,"kind":"parameter","displayName":"Organization List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"organizations":{"index":1,"kind":"parameter","displayName":"Organizations","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Organization[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createOrganizationsAsync":{"properties":{"organizationList":{"index":0,"kind":"parameter","displayName":"Organization List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createPermissionGroup":{"properties":{"permissionGroup":{"index":0,"kind":"parameter","displayName":"Permission Group","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.PermissionGroup","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createRequest":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Request","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createSatisfactionRating":{"properties":{"satisfactionRating":{"index":0,"kind":"parameter","displayName":"Satisfaction Rating","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.SatisfactionRating","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticket":{"index":1,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketId":{"index":2,"kind":"parameter","displayName":"Ticket Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createSection":{"properties":{"section":{"index":0,"kind":"parameter","displayName":"Section","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Section","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createSectionTranslation":{"properties":{"sectionId":{"index":0,"kind":"parameter","displayName":"Section Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"translation":{"index":1,"kind":"parameter","displayName":"Translation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Translation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTarget":{"properties":{"target":{"index":0,"kind":"parameter","displayName":"Target","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.targets.Target","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTicket":{"properties":{"ticket":{"index":0,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTicketAsync":{"properties":{"ticket":{"index":0,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTicketField":{"properties":{"field":{"index":0,"kind":"parameter","displayName":"Field","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Field","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTicketForm":{"properties":{"ticketForm":{"index":0,"kind":"parameter","displayName":"Ticket Form","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.TicketForm","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTicketFromTweet":{"properties":{"monitorId":{"index":0,"kind":"parameter","displayName":"Monitor Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tweetId":{"index":1,"kind":"parameter","displayName":"Tweet Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTickets":{"properties":{"ticketList":{"index":0,"kind":"parameter","displayName":"Ticket List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tickets":{"index":1,"kind":"parameter","displayName":"Tickets","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTicketsAsync":{"properties":{"ticketList":{"index":0,"kind":"parameter","displayName":"Ticket List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTopic":{"properties":{"topic":{"index":0,"kind":"parameter","displayName":"Topic","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Topic","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createTrigger":{"properties":{"trigger":{"index":0,"kind":"parameter","displayName":"Trigger","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Trigger","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createUpload":{"properties":{"content":{"index":0,"kind":"parameter","displayName":"Content","group":"common","label":"","required":false,"type":"string","javaType":"byte[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"contentType":{"index":1,"kind":"parameter","displayName":"Content Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"fileName":{"index":2,"kind":"parameter","displayName":"File Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"token":{"index":3,"kind":"parameter","displayName":"Token","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createUploadArticle":{"properties":{"articleId0":{"index":0,"kind":"parameter","displayName":"Article Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"file":{"index":1,"kind":"parameter","displayName":"File","group":"common","label":"","required":false,"type":"string","javaType":"java.io.File","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"inline":{"index":2,"kind":"parameter","displayName":"Inline","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createUser":{"properties":{"user":{"index":0,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createUserIdentity":{"properties":{"identity":{"index":0,"kind":"parameter","displayName":"Identity","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Identity","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":1,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createUserSegment":{"properties":{"userSegment":{"index":0,"kind":"parameter","displayName":"User Segment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.UserSegment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createUsers":{"properties":{"userList":{"index":0,"kind":"parameter","displayName":"User List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"users":{"index":1,"kind":"parameter","displayName":"Users","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"createUsersAsync":{"properties":{"userList":{"index":0,"kind":"parameter","displayName":"User List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteArticle":{"properties":{"article":{"index":0,"kind":"parameter","displayName":"Article","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Article","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteArticleAttachment":{"properties":{"articleAttachments":{"index":0,"kind":"parameter","displayName":"Article Attachments","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.ArticleAttachments","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Attachment identifier","optional":false}}},"deleteAttachment":{"properties":{"attachment":{"index":0,"kind":"parameter","displayName":"Attachment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Attachment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteAutomation":{"properties":{"automationId0":{"index":0,"kind":"parameter","displayName":"Automation Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteCategory":{"properties":{"category":{"index":0,"kind":"parameter","displayName":"Category","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Category","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteContentTag":{"properties":{"contentTag":{"index":0,"kind":"parameter","displayName":"Content Tag","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.ContentTag","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteDynamicContentItem":{"properties":{"item":{"index":0,"kind":"parameter","displayName":"Item","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.dynamic.DynamicContentItem","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteDynamicContentItemVariant":{"properties":{"itemId":{"index":0,"kind":"parameter","displayName":"Item Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"variant":{"index":1,"kind":"parameter","displayName":"Variant","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteForum":{"properties":{"forum":{"index":0,"kind":"parameter","displayName":"Forum","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Forum","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteGroup":{"properties":{"group":{"index":0,"kind":"parameter","displayName":"Group","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Group","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteGroupMembership":{"properties":{"groupMembership":{"index":0,"kind":"parameter","displayName":"Group Membership","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.GroupMembership","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"group_membership_id":{"index":1,"kind":"parameter","displayName":"Group_membership_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":2,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":3,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteOrganization":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"organization":{"index":1,"kind":"parameter","displayName":"Organization","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Organization","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteOrganizationMembership":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"organizationMembership":{"index":1,"kind":"parameter","displayName":"Organization Membership","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.OrganizationMembership","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"organization_membership_id":{"index":2,"kind":"parameter","displayName":"Organization_membership_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":3,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteOrganizationMemberships":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ids":{"index":1,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteOrganizations":{"properties":{"ids":{"index":0,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deletePermissionGroup":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"permissionGroup":{"index":1,"kind":"parameter","displayName":"Permission Group","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.PermissionGroup","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteSection":{"properties":{"section":{"index":0,"kind":"parameter","displayName":"Section","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Section","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteSuspendedTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"suspendedTicket":{"index":1,"kind":"parameter","displayName":"Suspended Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.SuspendedTicket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTarget":{"properties":{"targetId":{"index":0,"kind":"parameter","displayName":"Target Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticket":{"index":1,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTicketField":{"properties":{"field":{"index":0,"kind":"parameter","displayName":"Field","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Field","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTicketForm":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketForm":{"index":1,"kind":"parameter","displayName":"Ticket Form","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.TicketForm","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTickets":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ids":{"index":1,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTopic":{"properties":{"topic":{"index":0,"kind":"parameter","displayName":"Topic","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Topic","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTranslation":{"properties":{"translation":{"index":0,"kind":"parameter","displayName":"Translation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Translation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"translationId":{"index":1,"kind":"parameter","displayName":"Translation Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteTrigger":{"properties":{"triggerId":{"index":0,"kind":"parameter","displayName":"Trigger Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteUpload":{"properties":{"token":{"index":0,"kind":"parameter","displayName":"Token","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"upload":{"index":1,"kind":"parameter","displayName":"Upload","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Attachment.Upload","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":1,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteUserIdentity":{"properties":{"identity":{"index":0,"kind":"parameter","displayName":"Identity","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Identity","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"identityId":{"index":1,"kind":"parameter","displayName":"Identity Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":3,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteUserSegment":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userSegment":{"index":1,"kind":"parameter","displayName":"User Segment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.UserSegment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"deleteUsers":{"properties":{"ids":{"index":0,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticle":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticleFromSearch":{"properties":{"searchTerm":{"index":0,"kind":"parameter","displayName":"Search Term","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sectionId":{"index":1,"kind":"parameter","displayName":"Section Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticleSubscriptions":{"properties":{"articleId":{"index":0,"kind":"parameter","displayName":"Article Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"locale":{"index":1,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticleTranslations":{"properties":{"articleId":{"index":0,"kind":"parameter","displayName":"Article Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticles":{"properties":{"category":{"index":0,"kind":"parameter","displayName":"Category","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Category","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"locale":{"index":1,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"section":{"index":2,"kind":"parameter","displayName":"Section","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Section","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticlesFromAllLabels":{"properties":{"labels":{"index":0,"kind":"parameter","displayName":"Labels","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticlesFromAnyLabels":{"properties":{"labels":{"index":0,"kind":"parameter","displayName":"Labels","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticlesFromPage":{"properties":{"page":{"index":0,"kind":"parameter","displayName":"Page","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getArticlesIncrementally":{"properties":{"startTime":{"index":0,"kind":"parameter","displayName":"Start Time","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getAssignableGroupMemberships":{"properties":{"group_id":{"index":0,"kind":"parameter","displayName":"Group_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getAssignedTicketsCountForUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getAttachment":{"properties":{"attachment":{"index":0,"kind":"parameter","displayName":"Attachment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Attachment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getAttachmentsFromArticle":{"properties":{"articleId":{"index":0,"kind":"parameter","displayName":"Article Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getAutoCompleteOrganizations":{"properties":{"name":{"index":0,"kind":"parameter","displayName":"Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getAutomation":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getCategory":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getCategoryTranslations":{"properties":{"categoryId":{"index":0,"kind":"parameter","displayName":"Category Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getCcdTicketsCountForUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getComplianceDeletionStatuses":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getContentTag":{"properties":{"contentTagId":{"index":0,"kind":"parameter","displayName":"Content Tag Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getContentTags":{"properties":{"namePrefix":{"index":0,"kind":"parameter","displayName":"Name Prefix","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"pageSize":{"index":1,"kind":"parameter","displayName":"Page Size","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getDeletedTickets":{"properties":{"sortBy":{"index":0,"kind":"parameter","displayName":"Sort By","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sortOrder":{"index":1,"kind":"parameter","displayName":"Sort Order","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.SortOrder","enum":["ASCENDING","DESCENDING"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getDynamicContentItem":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getDynamicContentItemVariant":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"itemId":{"index":1,"kind":"parameter","displayName":"Item Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getDynamicContentItemVariants":{"properties":{"item":{"index":0,"kind":"parameter","displayName":"Item","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.dynamic.DynamicContentItem","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getForum":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getForums":{"properties":{"category_id":{"index":0,"kind":"parameter","displayName":"Category_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getGroup":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getGroupMembership":{"properties":{"group_membership_id":{"index":0,"kind":"parameter","displayName":"Group_membership_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":2,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getGroupMembershipByUser":{"properties":{"user_id":{"index":0,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getGroupMemberships":{"properties":{"group_id":{"index":0,"kind":"parameter","displayName":"Group_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getGroupOrganization":{"properties":{"organization_membership_id":{"index":0,"kind":"parameter","displayName":"Organization_membership_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":1,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getGroupUsers":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getHolidaysForSchedule":{"properties":{"schedule":{"index":0,"kind":"parameter","displayName":"Schedule","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.schedules.Schedule","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"scheduleId":{"index":1,"kind":"parameter","displayName":"Schedule Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getIncrementalTicketsResult":{"properties":{"unixEpochTime":{"index":0,"kind":"parameter","displayName":"Unix Epoch Time","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getJobStatus":{"properties":{"status":{"index":0,"kind":"parameter","displayName":"Status","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.JobStatus","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getJobStatusAsync":{"properties":{"status":{"index":0,"kind":"parameter","displayName":"Status","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.JobStatus","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getJobStatuses":{"properties":{"statuses":{"index":0,"kind":"parameter","displayName":"Statuses","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getJobStatusesAsync":{"properties":{"statuses":{"index":0,"kind":"parameter","displayName":"Statuses","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getMacro":{"properties":{"macroId":{"index":0,"kind":"parameter","displayName":"Macro Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganization":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationMembership":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationMembershipByUser":{"properties":{"user_id":{"index":0,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationMembershipForUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":1,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationMembershipsForOrg":{"properties":{"organization_id":{"index":0,"kind":"parameter","displayName":"Organization_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationMembershipsForUser":{"properties":{"user_id":{"index":0,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationRequests":{"properties":{"organizationId":{"index":0,"kind":"parameter","displayName":"Organization Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationTickets":{"properties":{"organizationId":{"index":0,"kind":"parameter","displayName":"Organization Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationUsers":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizations":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ids":{"index":1,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getOrganizationsIncrementally":{"properties":{"startTime":{"index":0,"kind":"parameter","displayName":"Start Time","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getPermissionGroup":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getRequest":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getRequestComment":{"properties":{"comment":{"index":0,"kind":"parameter","displayName":"Comment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Comment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"commentId":{"index":1,"kind":"parameter","displayName":"Comment Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"request":{"index":2,"kind":"parameter","displayName":"Request","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Request","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"requestId":{"index":3,"kind":"parameter","displayName":"Request Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getRequestComments":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"request":{"index":1,"kind":"parameter","displayName":"Request","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Request","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getSatisfactionRating":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getSchedule":{"properties":{"schedule":{"index":0,"kind":"parameter","displayName":"Schedule","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.schedules.Schedule","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"scheduleId":{"index":1,"kind":"parameter","displayName":"Schedule Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getSearchTicketResults":{"properties":{"query":{"index":0,"kind":"parameter","displayName":"Query","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"String used filter a type given by searchType","optional":false},"queryParams":{"index":1,"kind":"parameter","displayName":"Query Params","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map","deprecated":false,"autowired":false,"secret":false,"description":"Additional parameters other than filter string like per_page, page etc","optional":false},"sortBy":{"index":2,"kind":"parameter","displayName":"Sort By","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Name of any field of the searchType","optional":false},"sortOrder":{"index":3,"kind":"parameter","displayName":"Sort Order","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.SortOrder","enum":["ASCENDING","DESCENDING"],"deprecated":false,"autowired":false,"secret":false,"description":"Sort order","optional":false}}},"getSection":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getSectionSubscriptions":{"properties":{"locale":{"index":0,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sectionId":{"index":1,"kind":"parameter","displayName":"Section Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getSectionTranslations":{"properties":{"sectionId":{"index":0,"kind":"parameter","displayName":"Section Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getSections":{"properties":{"category":{"index":0,"kind":"parameter","displayName":"Category","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Category","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userSegment":{"index":1,"kind":"parameter","displayName":"User Segment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.UserSegment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTarget":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketAudit":{"properties":{"audit":{"index":0,"kind":"parameter","displayName":"Audit","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Audit","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"auditId":{"index":1,"kind":"parameter","displayName":"Audit Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":2,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticket":{"index":3,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketId":{"index":4,"kind":"parameter","displayName":"Ticket Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketAudits":{"properties":{"ticket":{"index":0,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketId0":{"index":1,"kind":"parameter","displayName":"Ticket Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketCollaborators":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketComments":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"order":{"index":1,"kind":"parameter","displayName":"Order","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.SortOrder","enum":["ASCENDING","DESCENDING"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketField":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketForm":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketIncidents":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketMetric":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketMetricByTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTickets":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ids":{"index":1,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketsByExternalId":{"properties":{"externalId":{"index":0,"kind":"parameter","displayName":"External Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"includeArchived":{"index":1,"kind":"parameter","displayName":"Include Archived","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketsCountForOrganization":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketsFromSearch":{"properties":{"searchTerm":{"index":0,"kind":"parameter","displayName":"Search Term","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTicketsIncrementally":{"properties":{"endTime":{"index":0,"kind":"parameter","displayName":"End Time","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"startTime":{"index":1,"kind":"parameter","displayName":"Start Time","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTopic":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTopics":{"properties":{"forum_id":{"index":0,"kind":"parameter","displayName":"Forum_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":1,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ids":{"index":2,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userSegment":{"index":3,"kind":"parameter","displayName":"User Segment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.UserSegment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTopicsByUser":{"properties":{"user_id":{"index":0,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTrigger":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getTriggers":{"properties":{"active":{"index":0,"kind":"parameter","displayName":"Active","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"categoryId0":{"index":1,"kind":"parameter","displayName":"Category Id0","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sortBy":{"index":2,"kind":"parameter","displayName":"Sort By","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sortOrder":{"index":3,"kind":"parameter","displayName":"Sort Order","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.SortOrder","enum":["ASCENDING","DESCENDING"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserCCDTickets":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserIdentities":{"properties":{"user":{"index":0,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":1,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserIdentity":{"properties":{"identity":{"index":0,"kind":"parameter","displayName":"Identity","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Identity","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"identityId":{"index":1,"kind":"parameter","displayName":"Identity Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":3,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserRelatedInfo":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserRequestedTickets":{"properties":{"userId":{"index":0,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserRequests":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":1,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserSegment":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserSegments":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUserSubscriptions":{"properties":{"user":{"index":0,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId0":{"index":1,"kind":"parameter","displayName":"User Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUsers":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ids":{"index":1,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUsersByExternalIds":{"properties":{"externalId":{"index":0,"kind":"parameter","displayName":"External Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"externalId0":{"index":1,"kind":"parameter","displayName":"External Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"externalId0s":{"index":2,"kind":"parameter","displayName":"External Id0s","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"externalIds":{"index":3,"kind":"parameter","displayName":"External Ids","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUsersByRole":{"properties":{"role":{"index":0,"kind":"parameter","displayName":"Role","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"roles":{"index":1,"kind":"parameter","displayName":"Roles","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getUsersIncrementally":{"properties":{"startTime":{"index":0,"kind":"parameter","displayName":"Start Time","group":"common","label":"","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"getView":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"importTicket":{"properties":{"ticketImport":{"index":0,"kind":"parameter","displayName":"Ticket Import","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.TicketImport","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"importTopic":{"properties":{"topic":{"index":0,"kind":"parameter","displayName":"Topic","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Topic","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"lookupOrganizationsByExternalId":{"properties":{"externalId":{"index":0,"kind":"parameter","displayName":"External Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"lookupUserByEmail":{"properties":{"email":{"index":0,"kind":"parameter","displayName":"Email","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"lookupUserByExternalId":{"properties":{"externalId":{"index":0,"kind":"parameter","displayName":"External Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"macrosShowChangesToTicket":{"properties":{"macroId":{"index":0,"kind":"parameter","displayName":"Macro Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"macrosShowTicketAfterChanges":{"properties":{"macroId":{"index":0,"kind":"parameter","displayName":"Macro Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketId":{"index":1,"kind":"parameter","displayName":"Ticket Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"makePrivateTicketAudit":{"properties":{"audit":{"index":0,"kind":"parameter","displayName":"Audit","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Audit","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"auditId":{"index":1,"kind":"parameter","displayName":"Audit Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":2,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticket":{"index":3,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketId":{"index":4,"kind":"parameter","displayName":"Ticket Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"markTicketAsSpam":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticket":{"index":1,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"mergeUsers":{"properties":{"userIdThatWillBeMerged":{"index":0,"kind":"parameter","displayName":"User Id That Will Be Merged","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userIdThatWillRemain":{"index":1,"kind":"parameter","displayName":"User Id That Will Remain","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"notifyApp":{"properties":{"json":{"index":0,"kind":"parameter","displayName":"Json","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"permanentlyDeleteTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticket":{"index":1,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"permanentlyDeleteTickets":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ids":{"index":1,"kind":"parameter","displayName":"Ids","group":"common","label":"","required":false,"type":"object","javaType":"long[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"permanentlyDeleteUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":1,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"queueCreateTicketAsync":{"properties":{"ticket":{"index":0,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"removeTagFromOrganisations":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"removeTagFromTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"removeTagFromTopics":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"requestVerifyUserIdentity":{"properties":{"identity":{"index":0,"kind":"parameter","displayName":"Identity","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Identity","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"identityId":{"index":1,"kind":"parameter","displayName":"Identity Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":3,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"resetUserPassword":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"password":{"index":1,"kind":"parameter","displayName":"Password","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"searchTriggers":{"properties":{"active":{"index":0,"kind":"parameter","displayName":"Active","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"query":{"index":1,"kind":"parameter","displayName":"Query","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sortBy":{"index":2,"kind":"parameter","displayName":"Sort By","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sortOrder":{"index":3,"kind":"parameter","displayName":"Sort Order","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.SortOrder","enum":["ASCENDING","DESCENDING"],"deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"setGroupMembershipAsDefault":{"properties":{"groupMembership":{"index":0,"kind":"parameter","displayName":"Group Membership","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.GroupMembership","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":1,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"setOrganizationMembershipAsDefault":{"properties":{"organizationMembership":{"index":0,"kind":"parameter","displayName":"Organization Membership","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.OrganizationMembership","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user_id":{"index":1,"kind":"parameter","displayName":"User_id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"setTagOnOrganisations":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"setTagOnTicket":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"setTagOnTopics":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tags":{"index":1,"kind":"parameter","displayName":"Tags","group":"common","label":"","required":false,"type":"array","javaType":"java.lang.String[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"setUserPrimaryIdentity":{"properties":{"identity":{"index":0,"kind":"parameter","displayName":"Identity","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Identity","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"identityId":{"index":1,"kind":"parameter","displayName":"Identity Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":3,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"showArticleTranslation":{"properties":{"articleId0":{"index":0,"kind":"parameter","displayName":"Article Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"locale":{"index":1,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"showCategoryTranslation":{"properties":{"categoryId1":{"index":0,"kind":"parameter","displayName":"Category Id1","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"locale":{"index":1,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"showSectionTranslation":{"properties":{"locale":{"index":0,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sectionId0":{"index":1,"kind":"parameter","displayName":"Section Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"suspendUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"trustTicketAudit":{"properties":{"audit":{"index":0,"kind":"parameter","displayName":"Audit","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Audit","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"auditId":{"index":1,"kind":"parameter","displayName":"Audit Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"id":{"index":2,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticket":{"index":3,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"ticketId":{"index":4,"kind":"parameter","displayName":"Ticket Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"unsuspendUser":{"properties":{"id":{"index":0,"kind":"parameter","displayName":"Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateArticle":{"properties":{"article":{"index":0,"kind":"parameter","displayName":"Article","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Article","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateArticleTranslation":{"properties":{"articleId":{"index":0,"kind":"parameter","displayName":"Article Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"locale":{"index":1,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"translation":{"index":2,"kind":"parameter","displayName":"Translation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Translation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateAutomation":{"properties":{"automation":{"index":0,"kind":"parameter","displayName":"Automation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Automation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"automationId":{"index":1,"kind":"parameter","displayName":"Automation Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateCategory":{"properties":{"category":{"index":0,"kind":"parameter","displayName":"Category","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Category","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateCategoryTranslation":{"properties":{"categoryId":{"index":0,"kind":"parameter","displayName":"Category Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"locale":{"index":1,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"translation":{"index":2,"kind":"parameter","displayName":"Translation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Translation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateContentTag":{"properties":{"contentTag":{"index":0,"kind":"parameter","displayName":"Content Tag","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.ContentTag","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateDynamicContentItem":{"properties":{"item":{"index":0,"kind":"parameter","displayName":"Item","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.dynamic.DynamicContentItem","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateDynamicContentItemVariant":{"properties":{"itemId":{"index":0,"kind":"parameter","displayName":"Item Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"variant":{"index":1,"kind":"parameter","displayName":"Variant","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateForum":{"properties":{"forum":{"index":0,"kind":"parameter","displayName":"Forum","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Forum","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateGroup":{"properties":{"group":{"index":0,"kind":"parameter","displayName":"Group","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Group","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateInstallation":{"properties":{"installationId":{"index":0,"kind":"parameter","displayName":"Installation Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"json":{"index":1,"kind":"parameter","displayName":"Json","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateMacro":{"properties":{"macro":{"index":0,"kind":"parameter","displayName":"Macro","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Macro","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"macroId0":{"index":1,"kind":"parameter","displayName":"Macro Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateOrganization":{"properties":{"organization":{"index":0,"kind":"parameter","displayName":"Organization","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Organization","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateOrganizations":{"properties":{"organizationList":{"index":0,"kind":"parameter","displayName":"Organization List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"organizations":{"index":1,"kind":"parameter","displayName":"Organizations","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Organization[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateOrganizationsAsync":{"properties":{"organizationList":{"index":0,"kind":"parameter","displayName":"Organization List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updatePermissionGroup":{"properties":{"permissionGroup":{"index":0,"kind":"parameter","displayName":"Permission Group","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.PermissionGroup","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateRequest":{"properties":{"request":{"index":0,"kind":"parameter","displayName":"Request","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Request","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateSection":{"properties":{"section":{"index":0,"kind":"parameter","displayName":"Section","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Section","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateSectionTranslation":{"properties":{"locale":{"index":0,"kind":"parameter","displayName":"Locale","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"sectionId":{"index":1,"kind":"parameter","displayName":"Section Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"translation":{"index":2,"kind":"parameter","displayName":"Translation","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.Translation","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateTicket":{"properties":{"ticket":{"index":0,"kind":"parameter","displayName":"Ticket","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateTicketField":{"properties":{"field":{"index":0,"kind":"parameter","displayName":"Field","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Field","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateTicketForm":{"properties":{"ticketForm":{"index":0,"kind":"parameter","displayName":"Ticket Form","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.TicketForm","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateTickets":{"properties":{"ticketList":{"index":0,"kind":"parameter","displayName":"Ticket List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"tickets":{"index":1,"kind":"parameter","displayName":"Tickets","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Ticket[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateTicketsAsync":{"properties":{"ticketList":{"index":0,"kind":"parameter","displayName":"Ticket List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateTopic":{"properties":{"topic":{"index":0,"kind":"parameter","displayName":"Topic","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Topic","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateTrigger":{"properties":{"trigger":{"index":0,"kind":"parameter","displayName":"Trigger","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Trigger","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"triggerId0":{"index":1,"kind":"parameter","displayName":"Trigger Id0","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateUser":{"properties":{"user":{"index":0,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateUserIdentity":{"properties":{"identity":{"index":0,"kind":"parameter","displayName":"Identity","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Identity","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":1,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":2,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateUserSegment":{"properties":{"userSegment":{"index":0,"kind":"parameter","displayName":"User Segment","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.hc.UserSegment","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateUsers":{"properties":{"users":{"index":0,"kind":"parameter","displayName":"Users","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User[]","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"usersList":{"index":1,"kind":"parameter","displayName":"Users List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"updateUsersAsync":{"properties":{"usersList":{"index":0,"kind":"parameter","displayName":"Users List","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}},"verifyUserIdentity":{"properties":{"identity":{"index":0,"kind":"parameter","displayName":"Identity","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.Identity","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"identityId":{"index":1,"kind":"parameter","displayName":"Identity Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"user":{"index":2,"kind":"parameter","displayName":"User","group":"common","label":"","required":false,"type":"object","javaType":"org.zendesk.client.v2.model.User","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false},"userId":{"index":3,"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"","optional":false}}}}}}} , -{"component":{"kind":"component","name":"zookeeper","title":"ZooKeeper","description":"Manage ZooKeeper clusters.","deprecated":false,"firstVersion":"2.9.0","label":"clustering,management,bigdata","javaType":"org.apache.camel.component.zookeeper.ZooKeeperComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-zookeeper","version":"4.8.1","scheme":"zookeeper","extendsScheme":"","syntax":"zookeeper:serverUrls/path","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelZooKeeperNode":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The node","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_NODE"},"CamelZooKeeperVersion":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"-1","description":"The node version","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_NODE_VERSION"},"CamelZookeeperAcl":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"Ids.OPEN_ACL_UNSAFE","description":"The ACL","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_ACL"},"CamelZookeeperCreateMode":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.zookeeper.CreateMode or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The create mode","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_CREATE_MODE"},"CamelZookeeperStatistics":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.zookeeper.data.Stat","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The statistics","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_STATISTICS"},"CamelZookeeperEventType":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.zookeeper.Watcher.Event.EventType","enum":["None","NodeCreated","NodeDeleted","NodeDataChanged","NodeChildrenChanged","DataWatchRemoved","ChildWatchRemoved","PersistentWatchRemoved"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event type","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_EVENT_TYPE"},"CamelZookeeperOperation":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_OPERATION"}},"properties":{"serverUrls":{"index":0,"kind":"path","displayName":"Server Urls","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The zookeeper server hosts (multiple servers can be separated by comma)"},"path":{"index":1,"kind":"path","displayName":"Path","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The node in the ZooKeeper server (aka znode)"},"listChildren":{"index":2,"kind":"parameter","displayName":"List Children","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"Whether the children of the node should be listed"},"timeout":{"index":3,"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The time interval to wait on connection before timing out."},"backoff":{"index":4,"kind":"parameter","displayName":"Backoff","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The time interval to backoff for after an error before retrying."},"repeat":{"index":5,"kind":"parameter","displayName":"Repeat","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"Should changes to the znode be 'watched' and repeatedly processed."},"sendEmptyMessageOnDelete":{"index":6,"kind":"parameter","displayName":"Send Empty Message On Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"Upon the delete of a znode, should an empty message be send to the consumer"},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"create":{"index":10,"kind":"parameter","displayName":"Create","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"Should the endpoint create the node if it does not currently exist."},"createMode":{"index":11,"kind":"parameter","displayName":"Create Mode","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["PERSISTENT","PERSISTENT_SEQUENTIAL","EPHEMERAL","EPHEMERAL_SEQUENTIAL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"EPHEMERAL","configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The create mode that should be used for the newly created node"},"lazyStartProducer":{"index":12,"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."}}} +{"component":{"kind":"component","name":"zookeeper","title":"ZooKeeper","description":"Manage ZooKeeper clusters.","deprecated":false,"firstVersion":"2.9.0","label":"clustering,management,bigdata","javaType":"org.apache.camel.component.zookeeper.ZooKeeperComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-zookeeper","version":"4.8.2","scheme":"zookeeper","extendsScheme":"","syntax":"zookeeper:serverUrls/path","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelZooKeeperNode":{"index":0,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The node","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_NODE"},"CamelZooKeeperVersion":{"index":1,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"-1","description":"The node version","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_NODE_VERSION"},"CamelZookeeperAcl":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"Ids.OPEN_ACL_UNSAFE","description":"The ACL","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_ACL"},"CamelZookeeperCreateMode":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.zookeeper.CreateMode or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The create mode","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_CREATE_MODE"},"CamelZookeeperStatistics":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.zookeeper.data.Stat","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The statistics","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_STATISTICS"},"CamelZookeeperEventType":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.zookeeper.Watcher.Event.EventType","enum":["None","NodeCreated","NodeDeleted","NodeDataChanged","NodeChildrenChanged","DataWatchRemoved","ChildWatchRemoved","PersistentWatchRemoved"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event type","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_EVENT_TYPE"},"CamelZookeeperOperation":{"index":6,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_OPERATION"}},"properties":{"serverUrls":{"index":0,"kind":"path","displayName":"Server Urls","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The zookeeper server hosts (multiple servers can be separated by comma)"},"path":{"index":1,"kind":"path","displayName":"Path","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The node in the ZooKeeper server (aka znode)"},"listChildren":{"index":2,"kind":"parameter","displayName":"List Children","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"Whether the children of the node should be listed"},"timeout":{"index":3,"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The time interval to wait on connection before timing out."},"backoff":{"index":4,"kind":"parameter","displayName":"Backoff","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The time interval to backoff for after an error before retrying."},"repeat":{"index":5,"kind":"parameter","displayName":"Repeat","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"Should changes to the znode be 'watched' and repeatedly processed."},"sendEmptyMessageOnDelete":{"index":6,"kind":"parameter","displayName":"Send Empty Message On Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"Upon the delete of a znode, should an empty message be send to the consumer"},"bridgeErrorHandler":{"index":7,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":8,"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":{"index":9,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"create":{"index":10,"kind":"parameter","displayName":"Create","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"Should the endpoint create the node if it does not currently exist."},"createMode":{"index":11,"kind":"parameter","displayName":"Create Mode","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["PERSISTENT","PERSISTENT_SEQUENTIAL","EPHEMERAL","EPHEMERAL_SEQUENTIAL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"EPHEMERAL","configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The create mode that should be used for the newly created node"},"lazyStartProducer":{"index":12,"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."}}} , -{"component":{"kind":"component","name":"zookeeper-master","title":"ZooKeeper Master","description":"Have only a single consumer in a cluster consuming from a given endpoint; with automatic failover if the JVM dies.","deprecated":false,"firstVersion":"2.19.0","label":"clustering,management,bigdata","javaType":"org.apache.camel.component.zookeepermaster.MasterComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-zookeeper-master","version":"4.8.1","scheme":"zookeeper-master","extendsScheme":"","syntax":"zookeeper-master:groupName:consumerEndpointUri","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":true},"properties":{"groupName":{"index":0,"kind":"path","displayName":"Group Name","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cluster group to use"},"consumerEndpointUri":{"index":1,"kind":"path","displayName":"Consumer Endpoint Uri","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The consumer endpoint to use in master/slave mode"},"bridgeErrorHandler":{"index":2,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":3,"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":{"index":4,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} +{"component":{"kind":"component","name":"zookeeper-master","title":"ZooKeeper Master","description":"Have only a single consumer in a cluster consuming from a given endpoint; with automatic failover if the JVM dies.","deprecated":false,"firstVersion":"2.19.0","label":"clustering,management,bigdata","javaType":"org.apache.camel.component.zookeepermaster.MasterComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-zookeeper-master","version":"4.8.2","scheme":"zookeeper-master","extendsScheme":"","syntax":"zookeeper-master:groupName:consumerEndpointUri","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":true,"remote":true},"properties":{"groupName":{"index":0,"kind":"path","displayName":"Group Name","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cluster group to use"},"consumerEndpointUri":{"index":1,"kind":"path","displayName":"Consumer Endpoint Uri","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The consumer endpoint to use in master/slave mode"},"bridgeErrorHandler":{"index":2,"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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":{"index":3,"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":{"index":4,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} ] \ No newline at end of file diff --git a/karavan-space/public/metadata/spiBeans.json b/karavan-space/public/metadata/spiBeans.json index 952d96c45d0..b65d3719b84 100644 --- a/karavan-space/public/metadata/spiBeans.json +++ b/karavan-space/public/metadata/spiBeans.json @@ -10,7 +10,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-caffeine", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "useRecovery" : { "index" : 0, @@ -91,7 +91,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-caffeine", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "cacheName" : { "index" : 0, @@ -121,7 +121,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-cassandraql", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "sessionHolder" : { "index" : 0, @@ -315,7 +315,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-cassandraql", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "session" : { "index" : 0, @@ -420,7 +420,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-quartz", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "routeStartTime" : { "index" : 0, @@ -512,7 +512,7 @@ "deprecated" : true, "groupId" : "org.apache.camel", "artifactId" : "camel-support", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "inFilter" : { "index" : 0, @@ -609,7 +609,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-base-engine", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "maxSeconds" : { "index" : 0, @@ -664,7 +664,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-base-engine", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "fromRouteId" : { "index" : 0, @@ -731,7 +731,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-ehcache", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "cacheName" : { "index" : 0, @@ -824,7 +824,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-ehcache", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "cacheName" : { "index" : 0, @@ -854,7 +854,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-elasticsearch", - "version" : "4.8.1" + "version" : "4.8.2" } } , @@ -869,7 +869,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-etcd3", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "endpoint" : { "index" : 0, @@ -999,7 +999,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-support", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "cacheSize" : { "index" : 0, @@ -1067,7 +1067,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-core-processor", - "version" : "4.8.1" + "version" : "4.8.2" } } , @@ -1082,7 +1082,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-core-processor", - "version" : "4.8.1" + "version" : "4.8.2" } } , @@ -1097,7 +1097,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-core-processor", - "version" : "4.8.1" + "version" : "4.8.2" } } , @@ -1112,7 +1112,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-hazelcast", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "mapName" : { "index" : 0, @@ -1242,7 +1242,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-hazelcast", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "repositoryName" : { "index" : 0, @@ -1284,7 +1284,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-infinispan-embedded", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "cacheName" : { "index" : 0, @@ -1389,7 +1389,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-infinispan-embedded", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "cacheName" : { "index" : 0, @@ -1430,7 +1430,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-infinispan", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "cacheName" : { "index" : 0, @@ -1535,7 +1535,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-infinispan", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "cacheName" : { "index" : 0, @@ -1576,7 +1576,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-jcache", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "configuration" : { "index" : 0, @@ -1630,7 +1630,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-jcache", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "configuration" : { "index" : 0, @@ -1659,7 +1659,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-sql", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "dataSource" : { "index" : 0, @@ -1839,7 +1839,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-sql", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "tableName" : { "index" : 0, @@ -1996,7 +1996,7 @@ "deprecated" : true, "groupId" : "org.apache.camel", "artifactId" : "camel-kafka", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "topic" : { "index" : 0, @@ -2087,7 +2087,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-leveldb", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "persistentFileName" : { "index" : 0, @@ -2229,7 +2229,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-core-processor", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "optimisticLocking" : { "index" : 0, @@ -2258,7 +2258,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-support", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "cacheSize" : { "index" : 0, @@ -2288,7 +2288,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-mongodb", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "mongoClient" : { "index" : 0, @@ -2341,7 +2341,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-opensearch", - "version" : "4.8.1" + "version" : "4.8.2" } } , @@ -2356,7 +2356,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-quartz", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "routeStartRepeatCount" : { "index" : 0, @@ -2486,7 +2486,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-spring-redis", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "repositoryName" : { "index" : 0, @@ -2540,7 +2540,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-core-processor", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "delimiter" : { "index" : 0, @@ -2569,7 +2569,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-tarfile", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "filePrefix" : { "index" : 0, @@ -2650,7 +2650,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-support", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "failureThreshold" : { "index" : 0, @@ -2756,7 +2756,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-support", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "scope" : { "index" : 0, @@ -2827,7 +2827,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-core-processor", - "version" : "4.8.1" + "version" : "4.8.2" } } , @@ -2842,7 +2842,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-core-processor", - "version" : "4.8.1" + "version" : "4.8.2" } } , @@ -2857,7 +2857,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-xslt", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "xslFile" : { "index" : 0, @@ -2926,7 +2926,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-xslt-saxon", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "xslFile" : { "index" : 0, @@ -2995,7 +2995,7 @@ "deprecated" : false, "groupId" : "org.apache.camel", "artifactId" : "camel-zipfile", - "version" : "4.8.1", + "version" : "4.8.2", "properties" : { "filePrefix" : { "index" : 0,